---

cl_vector.h

Go to the documentation of this file.

/*
        $Id: cl_vector.h,v 1.5 2001/03/27 19:34:37 grumbel Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------

        1999/06/19 Daniel Vogel
        
        totally replaced old CL_Vector with this code
*/


#ifndef header_cl_vector
#define header_cl_vector
#include <iostream>

class CL_Vector
//: Vector class
// This class provides basic functions and operators for working with vectors
{
public:
        float x,y,z,w;
        
        CL_Vector(float x = 0.0, float y = 0.0, float z = 0.0, float w = 1.0);
        //: Constructor that initializes a vector

        CL_Vector(const CL_Vector &other);
        //: Copy Constructor

        float norm() const;                             // not using w component
        //: Returns the (euclid) norm of the vector. It only uses the x,y,z ordinates! 

        void normalize();                               // not using w component
        //: Normalizes the vector (not taking into account the w ordinate!)
        
        float dot(const CL_Vector& v) const;
        //: Returns the dot product of the current vector and v
        
        float angle(const CL_Vector& v) const;
        //: Returns the angle between the current vector and v

        CL_Vector cross(const CL_Vector& v) const;
        //: Returns the cross product of the current vector and v
        
        CL_Vector rotate(float angle, const CL_Vector& a) const;
        //: Returns the current vector rotated around vector a and angle angle

        void round();
        //: rounds all components

        CL_Vector operator * (float s);  
        //: Scalar product (vector * scalar)

        friend CL_Vector operator *  (float s, const CL_Vector& v);
        //: Scalar product (scalar * vector)

        void operator += (const CL_Vector& v);
        //: += operator

        void operator -= (const CL_Vector& v);  
        //: -= operator

        void operator *= (float s);  
        //: *= operator (scalar multiplication)

        CL_Vector operator + (const CL_Vector& v);
        //: + operator
        
        CL_Vector operator - (const CL_Vector& v);
        //: - operator
        
        CL_Vector operator - ();
        //: unary - operator

        CL_Vector& operator = (const CL_Vector& v);
        //: assignment operator

        int operator == (const CL_Vector& v) const;
        //: Returns true if current vector equals v
        
        int operator != (const CL_Vector& v) const;
        //: Returns false if current vector equals v
        
        float& operator [] (int n);
        //: Returns reference to n-th ordinate (0. == x, 1. == y, ...)
        
        friend std::ostream& operator << (std::ostream&, CL_Vector& v);
        //: cout's the x,y,z ordinates (meant for debugging)
};

#endif

---