NCollection_Vec3< Element_t > Class Template Reference

Generic 3-components vector. To be used as RGB color pixel or XYZ 3D-point. The main target for this class - to handle raw low-level arrays (from/to graphic driver etc.). More...

#include <NCollection_Vec3.hxx>

Public Member Functions
	NCollection_Vec3 ()
	Empty constructor. Construct the zero vector.
	NCollection_Vec3 (Element_t theValue)
	Initialize ALL components of vector within specified value.
	NCollection_Vec3 (const Element_t theX, const Element_t theY, const Element_t theZ)
	Per-component constructor.
	NCollection_Vec3 (const NCollection_Vec2< Element_t > &theVec2, Element_t theZ=Element_t(0))
	Constructor from 2-components vector + optional 3rd value.
template<typename OtherElement_t >
	NCollection_Vec3 (const NCollection_Vec3< OtherElement_t > &theOtherVec3)
	Conversion constructor (explicitly converts some 3-component vector with other element type to a new 3-component vector with the element type Element_t, whose elements are static_cast'ed corresponding elements of theOtherVec3 vector)
void	SetValues (const Element_t theX, const Element_t theY, const Element_t theZ)
	Assign new values to the vector.
void	SetValues (const NCollection_Vec2< Element_t > &theVec2, Element_t theZ)
	Assign new values to the vector.
Element_t	x () const
	Alias to 1st component as X coordinate in XYZ.
Element_t	r () const
	Alias to 1st component as RED channel in RGB.
Element_t	y () const
	Alias to 2nd component as Y coordinate in XYZ.
Element_t	g () const
	Alias to 2nd component as GREEN channel in RGB.
Element_t	z () const
	Alias to 3rd component as Z coordinate in XYZ.
Element_t	b () const
	Alias to 3rd component as BLUE channel in RGB.
Element_t &	x ()
	Alias to 1st component as X coordinate in XYZ.
Element_t &	r ()
	Alias to 1st component as RED channel in RGB.
Element_t &	y ()
	Alias to 2nd component as Y coordinate in XYZ.
Element_t &	g ()
	Alias to 2nd component as GREEN channel in RGB.
Element_t &	z ()
	Alias to 3rd component as Z coordinate in XYZ.
Element_t &	b ()
	Alias to 3rd component as BLUE channel in RGB.
bool	IsEqual (const NCollection_Vec3 &theOther) const
	Check this vector with another vector for equality (without tolerance!).
bool	operator== (const NCollection_Vec3 &theOther) const
	Check this vector with another vector for equality (without tolerance!).
bool	operator!= (const NCollection_Vec3 &theOther) const
	Check this vector with another vector for non-equality (without tolerance!).
const Element_t *	GetData () const
	Raw access to the data (for OpenGL exchange).
Element_t *	ChangeData ()
	operator const Element_t * () const
	operator Element_t * ()
NCollection_Vec3 &	operator+= (const NCollection_Vec3 &theAdd)
	Compute per-component summary.
NCollection_Vec3	operator- () const
	Unary -.
NCollection_Vec3 &	operator-= (const NCollection_Vec3 &theDec)
	Compute per-component subtraction.
void	Multiply (const Element_t theFactor)
	Compute per-component multiplication by scale factor.
NCollection_Vec3 &	operator*= (const NCollection_Vec3 &theRight)
	Compute per-component multiplication.
NCollection_Vec3 &	operator*= (const Element_t theFactor)
	Compute per-component multiplication by scale factor.
NCollection_Vec3	operator* (const Element_t theFactor) const
	Compute per-component multiplication by scale factor.
NCollection_Vec3	Multiplied (const Element_t theFactor) const
	Compute per-component multiplication by scale factor.
NCollection_Vec3	cwiseMin (const NCollection_Vec3 &theVec) const
	Compute component-wise minimum of two vectors.
NCollection_Vec3	cwiseMax (const NCollection_Vec3 &theVec) const
	Compute component-wise maximum of two vectors.
NCollection_Vec3	cwiseAbs () const
	Compute component-wise modulus of the vector.
Element_t	maxComp () const
	Compute maximum component of the vector.
Element_t	minComp () const
	Compute minimum component of the vector.
NCollection_Vec3 &	operator/= (const Element_t theInvFactor)
	Compute per-component division by scale factor.
NCollection_Vec3 &	operator/= (const NCollection_Vec3 &theRight)
	Compute per-component division.
NCollection_Vec3	operator/ (const Element_t theInvFactor) const
	Compute per-component division by scale factor.
Element_t	Dot (const NCollection_Vec3 &theOther) const
	Computes the dot product.
Element_t	Modulus () const
	Computes the vector modulus (magnitude, length).
Element_t	SquareModulus () const
	Computes the square of vector modulus (magnitude, length). This method may be used for performance tricks.
void	Normalize ()
	Normalize the vector.
NCollection_Vec3	Normalized () const
	Normalize the vector.
void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
NCollection_Vec3< double > &	operator/= (const double theInvFactor)
	Optimized concretization for double type.

Static Public Member Functions
static int	Length ()
	Returns the number of components.
static NCollection_Vec3	Cross (const NCollection_Vec3 &theVec1, const NCollection_Vec3 &theVec2)
	Computes the cross product.
static NCollection_Vec3	GetLERP (const NCollection_Vec3 &theFrom, const NCollection_Vec3 &theTo, const Element_t theT)
	Compute linear interpolation between to vectors.
static NCollection_Vec3	DX ()
	Construct DX unit vector.
static NCollection_Vec3	DY ()
	Construct DY unit vector.
static NCollection_Vec3	DZ ()
	Construct DZ unit vector.

Detailed Description

template<typename Element_t>
class NCollection_Vec3< Element_t >

Generic 3-components vector. To be used as RGB color pixel or XYZ 3D-point. The main target for this class - to handle raw low-level arrays (from/to graphic driver etc.).

Constructor & Destructor Documentation

NCollection_Vec3() [1/5]

template<typename Element_t >

NCollection_Vec3< Element_t >::NCollection_Vec3 ( )

inline

Empty constructor. Construct the zero vector.

NCollection_Vec3() [2/5]

template<typename Element_t >

NCollection_Vec3< Element_t >::NCollection_Vec3 ( Element_t  theValue )

inlineexplicit

Initialize ALL components of vector within specified value.

NCollection_Vec3() [3/5]

template<typename Element_t >

NCollection_Vec3< Element_t >::NCollection_Vec3 ( const Element_t  theX, const Element_t  theY, const Element_t  theZ  )

inlineexplicit

Per-component constructor.

NCollection_Vec3() [4/5]

template<typename Element_t >

NCollection_Vec3< Element_t >::NCollection_Vec3 ( const NCollection_Vec2< Element_t > &  theVec2, Element_t  theZ = Element_t(0)  )

inlineexplicit

Constructor from 2-components vector + optional 3rd value.

NCollection_Vec3() [5/5]

template<typename Element_t >

template<typename OtherElement_t >

NCollection_Vec3< Element_t >::NCollection_Vec3 ( const NCollection_Vec3< OtherElement_t > &  theOtherVec3 )

inlineexplicit

Conversion constructor (explicitly converts some 3-component vector with other element type to a new 3-component vector with the element type Element_t, whose elements are static_cast'ed corresponding elements of theOtherVec3 vector)

Template Parameters

OtherElement_t

the element type of the other 3-component vector theOtherVec3

Parameters

theOtherVec3

the 3-component vector that needs to be converted

Member Function Documentation

b() [1/2]

template<typename Element_t >

Element_t & NCollection_Vec3< Element_t >::b ( )

inline

Alias to 3rd component as BLUE channel in RGB.

b() [2/2]

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::b ( ) const

inline

Alias to 3rd component as BLUE channel in RGB.

ChangeData()

template<typename Element_t >

Element_t * NCollection_Vec3< Element_t >::ChangeData ( )

inline

Cross()

template<typename Element_t >

static NCollection_Vec3 NCollection_Vec3< Element_t >::Cross ( const NCollection_Vec3< Element_t > &  theVec1, const NCollection_Vec3< Element_t > &  theVec2  )

inlinestatic

Computes the cross product.

cwiseAbs()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::cwiseAbs ( ) const

inline

Compute component-wise modulus of the vector.

cwiseMax()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::cwiseMax ( const NCollection_Vec3< Element_t > &  theVec ) const

inline

Compute component-wise maximum of two vectors.

cwiseMin()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::cwiseMin ( const NCollection_Vec3< Element_t > &  theVec ) const

inline

Compute component-wise minimum of two vectors.

Dot()

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::Dot ( const NCollection_Vec3< Element_t > &  theOther ) const

inline

Computes the dot product.

DumpJson()

template<typename Element_t >

void NCollection_Vec3< Element_t >::DumpJson ( Standard_OStream &  theOStream, Standard_Integer  theDepth = -1  ) const

inline

Dumps the content of me into the stream.

DX()

template<typename Element_t >

static NCollection_Vec3 NCollection_Vec3< Element_t >::DX ( )

inlinestatic

Construct DX unit vector.

DY()

template<typename Element_t >

static NCollection_Vec3 NCollection_Vec3< Element_t >::DY ( )

inlinestatic

Construct DY unit vector.

DZ()

template<typename Element_t >

static NCollection_Vec3 NCollection_Vec3< Element_t >::DZ ( )

inlinestatic

Construct DZ unit vector.

g() [1/2]

template<typename Element_t >

Element_t & NCollection_Vec3< Element_t >::g ( )

inline

Alias to 2nd component as GREEN channel in RGB.

g() [2/2]

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::g ( ) const

inline

Alias to 2nd component as GREEN channel in RGB.

GetData()

template<typename Element_t >

const Element_t * NCollection_Vec3< Element_t >::GetData ( ) const

inline

Raw access to the data (for OpenGL exchange).

GetLERP()

template<typename Element_t >

static NCollection_Vec3 NCollection_Vec3< Element_t >::GetLERP ( const NCollection_Vec3< Element_t > &  theFrom, const NCollection_Vec3< Element_t > &  theTo, const Element_t  theT  )

inlinestatic

Compute linear interpolation between to vectors.

Parameters

theT	- interpolation coefficient 0..1;

Returns

interpolation result.

IsEqual()

template<typename Element_t >

bool NCollection_Vec3< Element_t >::IsEqual ( const NCollection_Vec3< Element_t > &  theOther ) const

inline

Check this vector with another vector for equality (without tolerance!).

Length()

template<typename Element_t >

static int NCollection_Vec3< Element_t >::Length ( )

inlinestatic

Returns the number of components.

maxComp()

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::maxComp ( ) const

inline

Compute maximum component of the vector.

minComp()

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::minComp ( ) const

inline

Compute minimum component of the vector.

Modulus()

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::Modulus ( ) const

inline

Computes the vector modulus (magnitude, length).

Multiplied()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::Multiplied ( const Element_t  theFactor ) const

inline

Compute per-component multiplication by scale factor.

Multiply()

template<typename Element_t >

void NCollection_Vec3< Element_t >::Multiply ( const Element_t  theFactor )

inline

Compute per-component multiplication by scale factor.

Normalize()

template<typename Element_t >

void NCollection_Vec3< Element_t >::Normalize ( )

inline

Normalize the vector.

Normalized()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::Normalized ( ) const

inline

Normalize the vector.

operator const Element_t *()

template<typename Element_t >

NCollection_Vec3< Element_t >::operator const Element_t * ( ) const

inline

operator Element_t *()

template<typename Element_t >

NCollection_Vec3< Element_t >::operator Element_t * ( )

inline

operator!=()

template<typename Element_t >

bool NCollection_Vec3< Element_t >::operator!= ( const NCollection_Vec3< Element_t > &  theOther ) const

inline

Check this vector with another vector for non-equality (without tolerance!).

operator*()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::operator* ( const Element_t  theFactor ) const

inline

Compute per-component multiplication by scale factor.

operator*=() [1/2]

template<typename Element_t >

NCollection_Vec3 & NCollection_Vec3< Element_t >::operator*= ( const Element_t  theFactor )

inline

Compute per-component multiplication by scale factor.

operator*=() [2/2]

template<typename Element_t >

NCollection_Vec3 & NCollection_Vec3< Element_t >::operator*= ( const NCollection_Vec3< Element_t > &  theRight )

inline

Compute per-component multiplication.

operator+=()

template<typename Element_t >

NCollection_Vec3 & NCollection_Vec3< Element_t >::operator+= ( const NCollection_Vec3< Element_t > &  theAdd )

inline

Compute per-component summary.

operator-()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::operator- ( ) const

inline

Unary -.

operator-=()

template<typename Element_t >

NCollection_Vec3 & NCollection_Vec3< Element_t >::operator-= ( const NCollection_Vec3< Element_t > &  theDec )

inline

Compute per-component subtraction.

operator/()

template<typename Element_t >

NCollection_Vec3 NCollection_Vec3< Element_t >::operator/ ( const Element_t  theInvFactor ) const

inline

Compute per-component division by scale factor.

operator/=() [1/3]

NCollection_Vec3< double > & NCollection_Vec3< double >::operator/= ( const double  theInvFactor )

inline

Optimized concretization for double type.

operator/=() [2/3]

template<typename Element_t >

NCollection_Vec3 & NCollection_Vec3< Element_t >::operator/= ( const Element_t  theInvFactor )

inline

Compute per-component division by scale factor.

operator/=() [3/3]

template<typename Element_t >

NCollection_Vec3 & NCollection_Vec3< Element_t >::operator/= ( const NCollection_Vec3< Element_t > &  theRight )

inline

Compute per-component division.

operator==()

template<typename Element_t >

bool NCollection_Vec3< Element_t >::operator== ( const NCollection_Vec3< Element_t > &  theOther ) const

inline

Check this vector with another vector for equality (without tolerance!).

r() [1/2]

template<typename Element_t >

Element_t & NCollection_Vec3< Element_t >::r ( )

inline

Alias to 1st component as RED channel in RGB.

r() [2/2]

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::r ( ) const

inline

Alias to 1st component as RED channel in RGB.

SetValues() [1/2]

template<typename Element_t >

void NCollection_Vec3< Element_t >::SetValues ( const Element_t  theX, const Element_t  theY, const Element_t  theZ  )

inline

Assign new values to the vector.

SetValues() [2/2]

template<typename Element_t >

void NCollection_Vec3< Element_t >::SetValues ( const NCollection_Vec2< Element_t > &  theVec2, Element_t  theZ  )

inline

Assign new values to the vector.

SquareModulus()

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::SquareModulus ( ) const

inline

Computes the square of vector modulus (magnitude, length). This method may be used for performance tricks.

x() [1/2]

template<typename Element_t >

Element_t & NCollection_Vec3< Element_t >::x ( )

inline

Alias to 1st component as X coordinate in XYZ.

Returns

2 components by their names in specified order (in GLSL-style)

3 components by their names in specified order (in GLSL-style)

x() [2/2]

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::x ( ) const

inline

Alias to 1st component as X coordinate in XYZ.

y() [1/2]

template<typename Element_t >

Element_t & NCollection_Vec3< Element_t >::y ( )

inline

Alias to 2nd component as Y coordinate in XYZ.

y() [2/2]

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::y ( ) const

inline

Alias to 2nd component as Y coordinate in XYZ.

z() [1/2]

template<typename Element_t >

Element_t & NCollection_Vec3< Element_t >::z ( )

inline

Alias to 3rd component as Z coordinate in XYZ.

z() [2/2]

template<typename Element_t >

Element_t NCollection_Vec3< Element_t >::z ( ) const

inline

Alias to 3rd component as Z coordinate in XYZ.

---

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

• NCollection_Vec3.hxx