Public Member Functions
CVector3f Class Reference

Detailed Description

A 3-element vector that is represented by single floating point x,y,z coordinates. The class is used used for implementing custom ICE nodes.

See also:
CVector2f, CVector4f, CMatrix3f, CMatrix4f, CQuaternionf, CRotationf, CColor4f,

#include <xsi_vector3f.h>

List of all members.

Public Member Functions

SICPPSDK_INLINE CVector3f ()
SICPPSDK_INLINE CVector3f (float in_fX, float in_fY, float in_fZ)
SICPPSDK_INLINE CVector3f (const CVector3f &in_vector3)
SICPPSDK_INLINE ~CVector3f ()
SICPPSDK_INLINE CVector3foperator= (const CVector3f &in_vector3)
SICPPSDK_INLINE bool operator== (const CVector3f &in_vector3) const
SICPPSDK_INLINE bool operator!= (const CVector3f &in_vector3) const
SICPPSDK_INLINE CVector3foperator~ ()
SICPPSDK_INLINE CVector3foperator+= (const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3foperator-= (const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3foperator*= (const CMatrix3f &in_matrix3)
SICPPSDK_INLINE CVector3foperator*= (const CMatrix4f &in_matrix4)
SICPPSDK_INLINE CVector3foperator*= (const float in_fAlpha)
SICPPSDK_INLINE float operator[] (const short &in_sIndex) const
SICPPSDK_INLINE float & operator[] (const short &in_sIndex)
SICPPSDK_INLINE bool operator< (const CVector3f &in_vector3) const
SICPPSDK_INLINE CVector3fMulByMatrix3InPlace (const CMatrix3f &in_matrix3)
SICPPSDK_INLINE CVector3fMulByMatrix3 (const CVector3f &in_vector3, const CMatrix3f &in_matrix3)
SICPPSDK_INLINE CVector3fMulByMatrix4InPlace (const CMatrix4f &in_matrix4)
SICPPSDK_INLINE CVector3fMulByMatrix4 (const CVector3f &in_vector3, const CMatrix4f &in_matrix4)
SICPPSDK_INLINE CVector3fSetNull ()
SICPPSDK_INLINE bool IsNull (const float in_fEpsilon=MicroEPS)
SICPPSDK_INLINE short GetMaxComponentIndex () const
SICPPSDK_INLINE float GetMaxComponent () const
SICPPSDK_INLINE short GetMinComponentIndex () const
SICPPSDK_INLINE float GetMinComponent () const
SICPPSDK_INLINE float GetLength () const
SICPPSDK_INLINE void SetLength (const float in_val)
SICPPSDK_INLINE float GetLengthSquared () const
SICPPSDK_INLINE CStatus NormalizeInPlace ()
SICPPSDK_INLINE CStatus Normalize (const CVector3f &in_vector3)
SICPPSDK_INLINE float Dot (const CVector3f &in_vector3) const
SICPPSDK_INLINE CVector3fCross (const CVector3f &in_vector3A, const CVector3f &in_vector3B)
SICPPSDK_INLINE float GetAngle (const CVector3f &in_vector3) const
SICPPSDK_INLINE CVector3fLinearlyInterpolate (const CVector3f &in_vector3A, const CVector3f &in_vector3B, const float in_fAlpha)
SICPPSDK_INLINE CVector3fAbsoluteInPlace ()
SICPPSDK_INLINE CVector3fAbsolute (const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3fClampInPlace (const float in_fMinValue, const float in_fMaxValue)
SICPPSDK_INLINE CVector3fClamp (const float in_fMinValue, const float in_fMaxValue, const CVector3f &in_vector3)
SICPPSDK_INLINE bool EpsilonEquals (const CVector3f &in_vector3, const float in_fEpsilon) const
SICPPSDK_INLINE bool Equals (const CVector3f &in_vector3) const
SICPPSDK_INLINE CVector3fScaleAddInPlace (const float in_fS, const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3fScaleAdd (const float in_fS, const CVector3f &in_vector3A, const CVector3f &in_vector3B)
SICPPSDK_INLINE CVector3fScaleInPlace (const float in_fAlpha)
SICPPSDK_INLINE CVector3fScale (const float in_fAlpha, const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3fNegateInPlace ()
SICPPSDK_INLINE CVector3fNegate (const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3fSubInPlace (const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3fSub (const CVector3f &in_vector3A, const CVector3f &in_vector3B)
SICPPSDK_INLINE CVector3fAddInPlace (const CVector3f &in_vector3)
SICPPSDK_INLINE CVector3fAdd (const CVector3f &in_vector3A, const CVector3f &in_vector3B)
SICPPSDK_INLINE float Get (const short &in_sIndex) const
SICPPSDK_INLINE void Set (const short &in_sIndex, const float in_val)
SICPPSDK_INLINE void Get (float &io_fX, float &io_fY, float &io_fZ) const
SICPPSDK_INLINE CVector3fSet (const float in_fX, const float in_fY, const float in_fZ)
SICPPSDK_INLINE float GetZ () const
SICPPSDK_INLINE CVector3fPutZ (const float in_fZ)
SICPPSDK_INLINE float GetY () const
SICPPSDK_INLINE CVector3fPutY (const float in_fY)
SICPPSDK_INLINE float GetX () const
SICPPSDK_INLINE CVector3fPutX (const float in_fX)

Constructor & Destructor Documentation

SICPPSDK_INLINE CVector3f ( )

Default constructor.

SICPPSDK_INLINE CVector3f ( float  in_fX,
float  in_fY,
float  in_fZ 
)

Constructor.

Parameters:
in_fXValue of the x component
in_fYValue of the y component
in_fZValue of the z component
SICPPSDK_INLINE CVector3f ( const CVector3f in_vector3)

Copy constructor.

Parameters:
in_vector3constant class object.
SICPPSDK_INLINE ~CVector3f ( )

Default destructor.


Member Function Documentation

SICPPSDK_INLINE CVector3f & operator= ( const CVector3f in_vector3)

Assignment operator.

Parameters:
in_vector3constant class object.
Returns:
A reference to this vector.
SICPPSDK_INLINE bool operator== ( const CVector3f in_vector3) const

Equality operator tests the strict equality of this CVector3f with the specified vector3.

Parameters:
in_vector3Operand vector.
Returns:
true if equal else false.
See also:
CVector3f::Equals
SICPPSDK_INLINE bool operator!= ( const CVector3f in_vector3) const

Inequality operator tests the strict inequality of this CVector3f with the specified vector3.

Parameters:
in_vector3Operand vector.
Returns:
true if equal else false.
See also:
CVector3f::Equals
SICPPSDK_INLINE CVector3f & operator~ ( )

Negates this vector (this = - this).

Returns:
A reference to this vector.
See also:
CVector3f::NegateInPlace
SICPPSDK_INLINE CVector3f & operator+= ( const CVector3f in_vector3)

Adds the input vector to this one (this = this + in_vector3)

Parameters:
in_vector3Operand vector..
Returns:
A reference to this vector.
See also:
CVector3f::AddInPlace
SICPPSDK_INLINE CVector3f & operator-= ( const CVector3f in_vector3)

Subtracts the input vector (in_vector3) from this one (this = this - in_vector3).

Parameters:
in_vector3Operand vector.
Returns:
A reference to this vector.
See also:
CVector3f::SubInPlace
SICPPSDK_INLINE CVector3f & operator*= ( const CMatrix3f in_matrix3)

Right-multiplies this vector by the matrix m in place (this = this * m ).

Parameters:
in_matrix3Operand matrix.
Returns:
A reference to this vector.
See also:
CVector3f::MulByMatrix3InPlace
SICPPSDK_INLINE CVector3f & operator*= ( const CMatrix4f in_matrix4)

Right-multiplies this vector by the matrix m in place (this = this * m ).

Parameters:
in_matrix4Operand matrix.
Returns:
A reference to this vector.
See also:
CVector3f::MulByMatrix4InPlace
SICPPSDK_INLINE CVector3f & operator*= ( const float  in_fAlpha)

Scales this vector by the input scalar (alpha) (this = alpha * this).

Parameters:
in_fAlphaScalar multiplicator.
Returns:
A reference to this vector.
See also:
CVector3f::ScaleInPlace
SICPPSDK_INLINE float operator[] ( const short &  in_sIndex) const

Read-only accessors to the X,Y,Z components.

Parameters:
in_sIndex0,1,2 for X,Y and Z values.
Returns:
The value of the specified component. If the index supplied is out of range the function returns FLT_MAX.
See also:
CVector3f::GetX(), CVector3f::GetY(), CVector3f::GetZ()
SICPPSDK_INLINE float & operator[] ( const short &  in_sIndex)

Accessor to the X,Y,Z components.

Parameters:
in_sIndex0,1,2 for X,Y and Z values.
Returns:
The value of the specified component. If the index supplied is out of range the function returns FLT_MAX.
See also:
CVector3f::GetX(), CVector3f::GetY(), CVector3f::GetZ()
SICPPSDK_INLINE bool operator< ( const CVector3f in_vector3) const

Less than operator. Performs a comparison with a specified CVector3f to determine if this CVector3f is less than the specified CVector3f. The comparison is arbitrary and not geometrically meaningful, it's only purpose is to make CVector3f compliant with stl for sorting operations.

Parameters:
in_vector3CVector3f to compare.
Returns:
true if this CVector3f is less than the specified CVector3f, false otherwise.
Since:
7.5
SICPPSDK_INLINE CVector3f & MulByMatrix3InPlace ( const CMatrix3f in_matrix3)

Right-multiplies this vector by the matrix m in place (this = this * m ).

Parameters:
in_matrix3Operand matrix.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & MulByMatrix3 ( const CVector3f in_vector3,
const CMatrix3f in_matrix3 
)

Right-multiplies the vector v by the matrix m and store the result in this vector (this = v * m ).

Parameters:
in_vector3Operand vector
in_matrix3Operand matrix.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & MulByMatrix4InPlace ( const CMatrix4f in_matrix4)

Right-multiplies this vector by the matrix m in place (this = this * m ).

Parameters:
in_matrix4Operand matrix.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & MulByMatrix4 ( const CVector3f in_vector3,
const CMatrix4f in_matrix4 
)

Right-multiplies the vector v by the matrix m and store the result in this vector (this = v * m ).

Parameters:
in_vector3Operand vector
in_matrix4Operand matrix.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & SetNull ( )

Sets this vector to a null vector.

Returns:
A reference to this vector.
SICPPSDK_INLINE bool IsNull ( const float  in_fEpsilon = MicroEPS)

Returns true if the vector is a null vector

Parameters:
in_fEpsilonTolerance value
Returns:
Bool value.
SICPPSDK_INLINE short GetMaxComponentIndex ( ) const

Returns the index of the maximum component of this vector.

Returns:
Index of the maximum component of this vector.
SICPPSDK_INLINE float GetMaxComponent ( ) const

Returns the maximum component value of this vector.

Returns:
Maximum component value of this vector.
SICPPSDK_INLINE short GetMinComponentIndex ( ) const

Returns the index of the minimum component of this vector.

Returns:
Index of the minimum component of this vector.
SICPPSDK_INLINE float GetMinComponent ( ) const

Returns the minimum component value of this vector.

Returns:
Minimum component value of this vector.
SICPPSDK_INLINE float GetLength ( ) const

Returns the length of this vector.

Returns:
Length of this vector.
SICPPSDK_INLINE void SetLength ( const float  in_val)

Scales the vector to set its length.

Parameters:
in_valLength to set
SICPPSDK_INLINE float GetLengthSquared ( ) const

Returns the squared length of this vector.

Returns:
Squared length of this vector.
SICPPSDK_INLINE CStatus NormalizeInPlace ( )

Normalizes this vector in place.

Returns:
CStatus::OK if the normalization has been computed,
SICPPSDK_INLINE CStatus Normalize ( const CVector3f in_vector3)

Sets the value of this vector to the normalization of input vector.

Parameters:
in_vector3vector operand.
Returns:
CStatus::OK if the normalization has been computed.
SICPPSDK_INLINE float Dot ( const CVector3f in_vector3) const

Returns the dot product of this vector and the input vector.

Parameters:
in_vector3vector operand.
Returns:
Dot product of this vector and vector in_vector3.
SICPPSDK_INLINE CVector3f & Cross ( const CVector3f in_vector3A,
const CVector3f in_vector3B 
)

Sets this vector to the vector cross product of vectors A and B.

Parameters:
in_vector3Avector operand.
in_vector3Bvector operand.
Returns:
A reference to this vector.
SICPPSDK_INLINE float GetAngle ( const CVector3f in_vector3) const

Returns the angle (in radians) between this vector and the input vector.

Parameters:
in_vector3vector operand.
Returns:
Angle (in radians) between this vector and the input vector.
SICPPSDK_INLINE CVector3f & LinearlyInterpolate ( const CVector3f in_vector3A,
const CVector3f in_vector3B,
const float  in_fAlpha 
)

Linearly interpolates between vectors A and B and places the result into this vector: this = (1-alpha)*A + alpha*B.

Parameters:
in_vector3Avector operand.
in_vector3Bvector operand.
in_fAlphaScalar interpolator
Possible Values: [0.0, 1.0] Domain of validity
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & AbsoluteInPlace ( )

Sets each component of this CVector3 to its absolute value.

Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & Absolute ( const CVector3f in_vector3)

Sets each component of the specified vector to its absolute value and places the modified values into this vector.

Parameters:
in_vector3Vector to make absolute
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & ClampInPlace ( const float  in_fMinValue,
const float  in_fMaxValue 
)

Clamps this vector's components to the range [MinValue, MaxValue].

Parameters:
in_fMinValueLower bound of the clamping domain.
in_fMaxValueHigher bound of the clamping domain.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f& Clamp ( const float  in_fMinValue,
const float  in_fMaxValue,
const CVector3f in_vector3 
)

Clamps the specified vector's components to the range [MinValue, MaxValue] and places the values into this vector3.

Parameters:
in_fMinValueLower bound of the clamping domain.
in_fMaxValueHigher bound of the clamping domain.
in_vector3Operand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE bool EpsilonEquals ( const CVector3f in_vector3,
const float  in_fEpsilon 
) const

Tests the equality of this vector with the specified vector3, with a tolerance of Epsilon.

Parameters:
in_vector3Operand vector.
in_fEpsilonError margin (validity domain: [0, +INF[)
Returns:
true if equal else false.
SICPPSDK_INLINE bool Equals ( const CVector3f in_vector3) const

Tests the strict equality of this vector with the specified vector3.

Parameters:
in_vector3Operand vector.
Returns:
true if equal else false.
SICPPSDK_INLINE CVector3f & ScaleAddInPlace ( const float  in_fS,
const CVector3f in_vector3 
)

Sets the value of this vector to the scalar multiplication of itself by s and then adds vector3 v. (this = s*this + v)

Parameters:
in_fSScalar multiplicator.
in_vector3Operand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & ScaleAdd ( const float  in_fS,
const CVector3f in_vector3A,
const CVector3f in_vector3B 
)

Sets the value of this vector to the scalar multiplication of vector3 A by s and then adds vector3 B. (this = s*v1 + v2).

Parameters:
in_fSScalar multiplicator.
in_vector3AOperand vector.
in_vector3BOperand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & ScaleInPlace ( const float  in_fAlpha)

Scales this vector by the input scalar (alpha) (this = alpha * this).

Parameters:
in_fAlphaScalar multiplicator.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & Scale ( const float  in_fAlpha,
const CVector3f in_vector3 
)

Scales the input vector (v) by (alpha) store the result into this one (this = alpha * v).

Parameters:
in_fAlphaScalar multiplicator.
in_vector3Operand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & NegateInPlace ( )

Negates this vector (this = - this).

Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & Negate ( const CVector3f in_vector3)

Negates the input vector (v) store the result into this one (this = - v).

Parameters:
in_vector3Operand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & SubInPlace ( const CVector3f in_vector3)

Subtracts the input vector3 (v) from this one (this = this - v).

Parameters:
in_vector3Operand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & Sub ( const CVector3f in_vector3A,
const CVector3f in_vector3B 
)

Subtracts the input vector3 (in_vector3B) from the input vector3 (in_vector3A) and stores the result into this one (this = A - B).

Parameters:
in_vector3AOperand vector.
in_vector3BOperand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & AddInPlace ( const CVector3f in_vector3)

Adds the input vector to this one (this = this + in_vector3).

Parameters:
in_vector3Operand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE CVector3f & Add ( const CVector3f in_vector3A,
const CVector3f in_vector3B 
)

Adds both input vectors and stores the result in this one. (this = A + B)

Parameters:
in_vector3AOperand vector.
in_vector3BOperand vector.
Returns:
A reference to this vector.
SICPPSDK_INLINE float Get ( const short &  in_sIndex) const

Accessor to the X,Y,Z components.

Parameters:
in_sIndex0,1,2 for X,Y and Z values.
Returns:
The value of the specified component. If the index supplied is out of range the function returns FLT_MAX.
See also:
CVector3f::GetX(), CVector3f::GetY(), CVector3f::GetZ()
SICPPSDK_INLINE void Set ( const short &  in_sIndex,
const float  in_val 
)

Accessor to the X,Y,Z components.

Parameters:
in_sIndex0,1,2 for X,Y and Z values.
in_valThe value of the specified component.
See also:
CVector3f::Get(), CVector3f::GetY(), CVector3f::GetZ()
SICPPSDK_INLINE void Get ( float &  io_fX,
float &  io_fY,
float &  io_fZ 
) const

Returns the X, Y and Z values of the vector.

Parameters:
io_fXX value to get in the vector.
io_fYY value to get in the vector.
io_fZZ value to get in the vector.
SICPPSDK_INLINE CVector3f & Set ( const float  in_fX,
const float  in_fY,
const float  in_fZ 
)

Sets the X, Y and Z values of the vector.

Parameters:
in_fXX value to set in the vector.
in_fYY value to set in the vector.
in_fZZ value to set in the vector.
Returns:
A reference to the vector.
SICPPSDK_INLINE float GetZ ( ) const

Returns the Z value of this vector.

Returns:
Z value of this vector.
SICPPSDK_INLINE CVector3f & PutZ ( const float  in_fZ)

Sets the Z value of this vector.

Parameters:
in_fZz value.
Returns:
A reference to this vector.
SICPPSDK_INLINE float GetY ( ) const

Returns the Y value of this vector.

Returns:
Y value of this vector.
SICPPSDK_INLINE CVector3f & PutY ( const float  in_fY)

Sets the Y value of this vector.

Parameters:
in_fYy value.
Returns:
A reference to this vector.
SICPPSDK_INLINE float GetX ( ) const

Returns the X value of this vector.

Returns:
X value of this vector.
SICPPSDK_INLINE CVector3f & PutX ( const float  in_fX)

Sets the X value of this vector.

Parameters:
in_fXx value.
Returns:
A reference to this vector.

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