vec3.hpp

Go to the documentation of this file.

/*
**    TP CPE Lyon
**    Copyright (C) 2013 Damien Rohmer
**
**    This program is free software: you can redistribute it and/or modify
**    it under the terms of the GNU General Public License as published by
**    the Free Software Foundation, either version 3 of the License, or
**    (at your option) any later version.
**
**   This program is distributed in the hope that it will be useful,
**    but WITHOUT ANY WARRANTY; without even the implied warranty of
**    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**    GNU General Public License for more details.
**
**    You should have received a copy of the GNU General Public License
**    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/


#ifndef VEC3_HPP
#define VEC3_HPP

#include <string>
#include <iostream>

#include <exception_cpe.hpp>

namespace cpe
{
class vec2;

class vec3
{
public:

    // ********************************************* //
    // ********************************************* //
    //  CONSTRUCTORS
    // ********************************************* //
    // ********************************************* //

    vec3();
    vec3(float x,float y,float z);

    // ********************************************* //
    // ********************************************* //
    //  Get/set
    // ********************************************* //
    // ********************************************* //

    float x() const;
    float& x();
    float y() const;
    float& y();
    float z() const;
    float& z();

    float operator[](const size_t& k) const;
    float& operator[](const size_t& k);
    float operator()(const size_t& k) const;
    float& operator()(const size_t& k);

    void set_zero();

    const float *pointer() const;

    // ********************************************* //
    // ********************************************* //
    //  Convert to lower dimension
    // ********************************************* //
    // ********************************************* //

    vec2 to_vec2() const;


    // ********************************************* //
    // ********************************************* //
    //  Math operation
    // ********************************************* //
    // ********************************************* //

    float dot(const vec3& p) const;

    float norm() const;
    float norm2() const;
    vec3 normalized() const;

    vec3 cross(const vec3& p) const;




    // ********************************************* //
    // ********************************************* //
    //  Operator +-*/
    // ********************************************* //
    // ********************************************* //

    vec3 operator+(const vec3& p2) const;
    vec3 operator+(float s) const;

    vec3 operator-(const vec3& p2) const;
    vec3 operator-(float s) const;


    vec3 operator*(float s) const;
    vec3 operator/(float s) const;

    vec3& operator+=(const vec3& p);
    vec3& operator+=(float s);
    vec3& operator-=(const vec3& p);
    vec3& operator-=(float s);
    vec3& operator*=(float s);
    vec3& operator/=(float s);

    vec3 operator-() const;

    vec3 product_compontentwise(const vec3& p) const;
    vec3& product_compontentwise_internal(const vec3& p);
    void scale(float sx,float sy,float sz);


    // ********************************************* //
    // ********************************************* //
    //  Output
    // ********************************************* //
    // ********************************************* //

    std::string to_string() const;



private:


    // ********************************************* //
    // ********************************************* //
    //  Internal parameters
    // ********************************************* //
    // ********************************************* //

    float internal_x;
    float internal_y;
    float internal_z;


    // ********************************************* //
    // ********************************************* //
    //  Helper
    // ********************************************* //
    // ********************************************* //

    void assert_size(const size_t& k) const;

};

vec3 operator+(float s,const vec3& p);
vec3 operator-(float s,const vec3& p);
vec3 operator*(float s,const vec3& p);

// ********************************************* //
// ********************************************* //
//  Output
// ********************************************* //
// ********************************************* //

std::ostream& operator<<(std::ostream& stream,const vec3& p);

class exception_vec3 : public exception_cpe
{
public:

    exception_vec3():exception_cpe(){}
    exception_vec3(const std::string& msg_param,const std::string& file_param,const std::string& caller_param,const int& line_param):exception_cpe(msg_param,file_param,caller_param,line_param){}
};

}



#endif