SGE::CL_Vector2D< TType > Class Template Reference

The class is used to store and manipulate 2 dimensions vector. It has XML support to load/save the vectors from/to XML files. More...

#include <cl_vector2.h>

Inheritance diagram for SGE::CL_Vector2D< TType >:

Inheritance graph
[legend]
Collaboration diagram for SGE::CL_Vector2D< TType >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CL_Vector2D ()
 Default Constructor, clear the Vector to 0.
 CL_Vector2D (const CLT_Vector< TType > &_Vec)
 Constructor.
 CL_Vector2D (const CL_Vector2D< TType > &_Vec)
 Copy Constructor.
 CL_Vector2D (const TType *_Val)
 Constructor, set the vector with _Val.
 CL_Vector2D (const TType _Val)
 Constructor, set the vector will _Val.
 CL_Vector2D (const TType _x, const TType _y)
 Constructor, set the vector will _x, _y.
 ~CL_Vector2D ()
 Default destructor, do nothing yet.
void Set (const TType _x, const TType _y)
 Set the vector's value to _x, _y.
CL_Vector2D< TType > & operator= (const CL_Vector2D< TType > &_Vec2)
CL_Vector2D< TType > & operator= (const TType *_Val)
 operator = with TType *_f. All the vector dimension will be set to _f[] value.
CL_Vector2D< TType > & operator= (const TType _Val)
 operator = with TType _f. All the vector dimension will be set to _f value.

Public Attributes

TType & x
 Y axe value.
TType & y
 Z axe value.

Detailed Description

template<typename TType>
class SGE::CL_Vector2D< TType >

The class is used to store and manipulate 2 dimensions vector. It has XML support to load/save the vectors from/to XML files.

Todo:
Add support for matrix transformation
Note:
Author:
Yannouchka


Constructor & Destructor Documentation

template<typename TType>
SGE::CL_Vector2D< TType >::CL_Vector2D  )  [inline]
 

Default Constructor, clear the Vector to 0.

Returns:
Nothing

template<typename TType>
SGE::CL_Vector2D< TType >::CL_Vector2D const CLT_Vector< TType > &  _Vec  )  [inline]
 

Constructor.

Returns:
Nothing

template<typename TType>
SGE::CL_Vector2D< TType >::CL_Vector2D const CL_Vector2D< TType > &  _Vec  )  [inline]
 

Copy Constructor.

Parameters:
_Vec => Original vector to copy.
Returns:
Nothing

template<typename TType>
SGE::CL_Vector2D< TType >::CL_Vector2D const TType *  _Val  )  [inline]
 

Constructor, set the vector with _Val.

Parameters:
_Val => TType array, if not null the 2 first TType are affected to the vectors(X/Y/Z/)
Returns:
Nothing

template<typename TType>
SGE::CL_Vector2D< TType >::CL_Vector2D const TType  _Val  )  [inline]
 

Constructor, set the vector will _Val.

Parameters:
_Val => TType value, the 2 axes X/Y are set to _Val
Returns:
Nothing

template<typename TType>
SGE::CL_Vector2D< TType >::CL_Vector2D const TType  _x,
const TType  _y
[inline]
 

Constructor, set the vector will _x, _y.

Parameters:
_x => TType value for the X axe.
_y => TType value for the Y axe.
Returns:
Nothing

template<typename TType>
SGE::CL_Vector2D< TType >::~CL_Vector2D  )  [inline]
 

Default destructor, do nothing yet.

Returns:
Nothing


Member Function Documentation

template<typename TType>
CL_Vector2D<TType>& SGE::CL_Vector2D< TType >::operator= const TType *  _Val  )  [inline]
 

operator = with TType *_f. All the vector dimension will be set to _f[] value.

Note:
*_f must be an array of size >= to the vector dimension.

Reimplemented from SGE::CLT_Vector< TType >.

template<typename TType>
void SGE::CL_Vector2D< TType >::Set const TType  _x,
const TType  _y
[inline]
 

Set the vector's value to _x, _y.

Parameters:
_x => TType value for the X axe.
_y => TType value for the Y axe.
Returns:
Nothing


The documentation for this class was generated from the following file:
Generated on Mon Mar 19 23:15:16 2007 for SugoiTools by  doxygen 1.4.6-NO