ML Reference
ml::Tvec6< DT > Class Template Reference

A six dimensional vector class for floating point types. More...

#include <mlVector6.h>

Inheritance diagram for ml::Tvec6< DT >:
ml::FloatingPointVector< DT, 6 > ml::FloatingPointVectorDataContainerBase< DT, size >

List of all members.

Public Types

typedef FloatingPointVector
< DT, 6 > 
Superclass
 A typedef as a shorthand for the base class.
typedef DT ComponentType
 A typedef to "export" the type of components.

Public Member Functions

constructors
 Tvec6 (const DT value=0)
 Default and value constructor.
 Tvec6 (const Tvec6< DT > &v)
 Copy constructor from Tvec6.
 Tvec6 (const Superclass &v)
 Copy constructor from FloatingPointVector.
 Tvec6 (const DT x, const DT y, const DT z, const DT c, const DT t, const DT u)
 Build the vector from the scalars x, y, z, c, t and u to the components 0 to 5, respectively.
 Tvec6 (const Tvec2< DT > &v, const DT z, const DT c, const DT t, const DT u)
 Cast Tvec2 to Tvec6. Last components are set to z, c, t and u whose defaults are 0.
 Tvec6 (const Tvec3< DT > &v, const DT c, const DT t, const DT u)
 Cast Tvec3 to Tvec6. Last components are set to c, t and u whose defaults are 0.
 Tvec6 (const Tvec4< DT > &v, const DT t, const DT u)
 Cast Tvec4 to Tvec6. Last components are set to t and u whose defaults are 0.
Other operators and methods
void assign (const DT x, const DT y, const DT z, const DT c, const DT t, const DT u)
 Set all components to the passed values.
Tvec6< DT > & operator+= (const Tvec2< DT > &v)
 Incrementation by a Tvec2.
Tvec6< DT > & operator+= (const Tvec3< DT > &v)
 Incrementation by a Tvec3.
Tvec6< DT > & operator+= (const Tvec4< DT > &v)
 Incrementation by a Tvec4.
const Tvec3< DT > getVec3 () const
 Return a Tvec3 from components 0,1, and 2.
const Tvec4< DT > getVec4 () const
 Return a Tvec4 from components 0, 1, 2, and 3.

Detailed Description

template<class DT>
class ml::Tvec6< DT >

A six dimensional vector class for floating point types.

A six dimensional vector class.

Definition at line 53 of file mlVector6.h.


Member Typedef Documentation

template<class DT>
typedef DT ml::Tvec6< DT >::ComponentType

A typedef to "export" the type of components.

Reimplemented from ml::FloatingPointVector< DT, 6 >.

Definition at line 60 of file mlVector6.h.

template<class DT>
typedef FloatingPointVector<DT,6> ml::Tvec6< DT >::Superclass

A typedef as a shorthand for the base class.

Definition at line 57 of file mlVector6.h.


Constructor & Destructor Documentation

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const DT  value = 0) [inline, explicit]

Default and value constructor.

Set all entries to a user given value. value is the init value for all entries. 0 is the default value.

Definition at line 68 of file mlVector6.h.

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const Tvec6< DT > &  v) [inline]

Copy constructor from Tvec6.

Definition at line 74 of file mlVector6.h.

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const Superclass v) [inline]

Copy constructor from FloatingPointVector.

This allows the usage of SclarVectorTemplate objects of the same DT in operators using the Tvec6, because the FloatingPointVector objects can implicitly be cast.

Definition at line 82 of file mlVector6.h.

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const DT  x,
const DT  y,
const DT  z,
const DT  c,
const DT  t,
const DT  u 
) [inline]

Build the vector from the scalars x, y, z, c, t and u to the components 0 to 5, respectively.

Definition at line 89 of file mlVector6.h.

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const Tvec2< DT > &  v,
const DT  z,
const DT  c,
const DT  t,
const DT  u 
) [inline]

Cast Tvec2 to Tvec6. Last components are set to z, c, t and u whose defaults are 0.

Definition at line 102 of file mlVector6.h.

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const Tvec3< DT > &  v,
const DT  c,
const DT  t,
const DT  u 
) [inline]

Cast Tvec3 to Tvec6. Last components are set to c, t and u whose defaults are 0.

Definition at line 115 of file mlVector6.h.

template<class DT>
ml::Tvec6< DT >::Tvec6 ( const Tvec4< DT > &  v,
const DT  t,
const DT  u 
) [inline]

Cast Tvec4 to Tvec6. Last components are set to t and u whose defaults are 0.

Definition at line 128 of file mlVector6.h.


Member Function Documentation

template<class DT>
void ml::Tvec6< DT >::assign ( const DT  x,
const DT  y,
const DT  z,
const DT  c,
const DT  t,
const DT  u 
) [inline]

Set all components to the passed values.

Definition at line 146 of file mlVector6.h.

template<class DT>
const Tvec3<DT> ml::Tvec6< DT >::getVec3 ( ) const [inline]

Return a Tvec3 from components 0,1, and 2.

Definition at line 192 of file mlVector6.h.

template<class DT>
const Tvec4<DT> ml::Tvec6< DT >::getVec4 ( ) const [inline]

Return a Tvec4 from components 0, 1, 2, and 3.

Definition at line 202 of file mlVector6.h.

template<class DT>
Tvec6<DT>& ml::Tvec6< DT >::operator+= ( const Tvec4< DT > &  v) [inline]

Incrementation by a Tvec4.

Definition at line 180 of file mlVector6.h.

template<class DT>
Tvec6<DT>& ml::Tvec6< DT >::operator+= ( const Tvec2< DT > &  v) [inline]

Incrementation by a Tvec2.

Definition at line 159 of file mlVector6.h.

template<class DT>
Tvec6<DT>& ml::Tvec6< DT >::operator+= ( const Tvec3< DT > &  v) [inline]

Incrementation by a Tvec3.

Definition at line 169 of file mlVector6.h.


The documentation for this class was generated from the following file: