KFbxVector4
#include<kfbxvector4.h>

Inherits fbxVectorTemplate4<double>.

List of all members.

Detailed Description

FBX SDK 4-elements vector class.

Definition at line61of filekfbxvector4.h.


Constructors and Destructor

 KFbxVector4()
 Constructor.
 KFbxVector4(constKFbxVector4&pVector4)
 Copy constructor.
 KFbxVector4(double pX, double pY, double pZ, double pW=1.0)
 Constructor.
 KFbxVector4(const double pValue[4])
 Constructor.
 KFbxVector4(const fbxDouble3&pValue)
 Constructor.
 ~KFbxVector4()
 Destructor.

Access

KFbxVector4operator=(constKFbxVector4&pVector4)
 Assignment operation.
KFbxVector4operator=(const double *pValue)
 Assignment operation.
KFbxVector4operator=(const fbxDouble3&pValue)
 Assignment operation.
double& operator[](int pIndex)
 Accessor.
double const& operator[](int pIndex) const
 Assignment operation.
double GetAt(int pIndex)
 Get a vector element.
void SetAt(int pIndex, double pValue)
 Set a vector element.
void Set(double pX, double pY, double pZ, double pW=1.0)
 Set vector.

Scalar Operations

KFbxVector4 operator+(double pValue)
 Add a value to all vector components.
KFbxVector4 operator-(double pValue)
 Substract a value from all vector components.
KFbxVector4 operator*(double pValue)
 Multiply a value to all vector components.
KFbxVector4 operator/(double pValue)
 Divide all vector components by a value.
KFbxVector4operator+=(double pValue)
 Add a value to all vector components.
KFbxVector4operator-=(double pValue)
 Subtract a value from all vector components.
KFbxVector4operator*=(double pValue)
 Multiply a value to all vector elements.
KFbxVector4operator/=(double pValue)
 Divide all vector elements by a value.

Vector Operations

KFbxVector4 operator-()
 Unary minus operator.
KFbxVector4 operator+(KFbxVector4&pVector)
 Add two vectors together.
KFbxVector4 operator-(KFbxVector4&pVector)
 Subtract a vector from another vector.
KFbxVector4 operator*(KFbxVector4&pVector)
 Memberwise multiplication of two vectors.
KFbxVector4 operator/(KFbxVector4&pVector)
 Memberwise division of a vector with another vector.
KFbxVector4operator+=(KFbxVector4&pVector)
 Add two vectors together.
KFbxVector4operator-=(KFbxVector4&pVector)
 Subtract a vector from another vector.
KFbxVector4operator*=(KFbxVector4&pVector)
 Memberwise multiplication of two vectors.
KFbxVector4operator/=(KFbxVector4&pVector)
 Memberwise division of a vector with another vector.
double DotProduct(KFbxVector4&pVector)
 Calculate the dot product of two vectors.
KFbxVector4 CrossProduct(KFbxVector4&pVector)
 Calculate the cross product of two vectors.
static bool AxisAlignmentInEulerAngle(KFbxVector4const&pAB,KFbxVector4const&pA,KFbxVector4const&pB,KFbxVector4&pAngles)
 Calculate the Euler rotation required to align axis pAB-pA on pAB-pB.

Boolean Operations

bool operator==(KFbxVector4&pVector)
 Equivalence operator.
bool operator==(KFbxVector4const&pVector) const
 Equivalence operator.
bool operator!=(KFbxVector4&pVector)
 Non equivalence operator.
bool operator!=(KFbxVector4const&pVector) const
 Equivalence operator.

Length

double Length()
 Get the vector's length.
double SquareLength()
 Get the vector's length squared.
double Distance(KFbxVector4&pVector)
 Find the distance between 2 vectors.
void Normalize()
 Normalize the vector, length set to 1.

Casting

 operator double *()
 Cast the vector in a double pointer.
 operator const double *()
 Cast the vector in a const double pointer.
 operator const double *() const
 Cast the vector in a double pointer.

Constructor&Destructor Documentation

Constructor.

KFbxVector4(constKFbxVector4pVector4 ) 

Copy constructor.

KFbxVector4(double pX,
double pY,
double pZ,
double pW=1.0 
)

Constructor.

Parameters:
pX X component.
pY Y component.
pZ Z component.
pW W component.

KFbxVector4(const double pValue[4] ) 

Constructor.

Parameters:
pValue X,Y,Z,W components.

KFbxVector4(const fbxDouble3& pValue ) 

Constructor.

Parameters:
pValue X,Y,Z components.
Remarks:
The fourth component of this object is assigned 1.

Destructor.

Member Function Documentation

KFbxVector4&operator=(constKFbxVector4pVector4 ) 

Assignment operation.

KFbxVector4&operator=(const double * pValue ) 

Assignment operation.

KFbxVector4&operator=(const fbxDouble3& pValue ) 

Assignment operation.

double&operator[](int pIndex ) 

Accessor.

Parameters:
pIndex The index of the component to access.
Returns:
The reference to the indexed component.
Remarks:
The parameter is not checked for values out of bounds. The valid range is [0,3].

double const&operator[](int pIndex ) const

Assignment operation.

double GetAt(int pIndex ) 

Get a vector element.

Parameters:
pIndex The index of the component to access.
Returns:
The value of the indexed component.
Remarks:
The parameter is not checked for values out of bounds. The valid range is [0,3].

void SetAt(int pIndex,
double pValue 
)

Set a vector element.

Parameters:
pIndex The index of the component to set.
pValue The new value to set the component.
Remarks:
The index parameter is not checked for values out of bounds. The valid range is [0,3].

void Set(double pX,
double pY,
double pZ,
double pW=1.0 
)

Set vector.

Parameters:
pX The X component value.
pY The Y component value.
pZ The Z component value.
pW The W component value.

KFbxVector4operator+(double pValue ) 

Add a value to all vector components.

Parameters:
pValue The value to add to each component of the vector.
Returns:
New vector.
Remarks:
The passed value is not checked.

KFbxVector4operator-(double pValue ) 

Substract a value from all vector components.

Parameters:
pValue The value to substract from each component of the vector.
Returns:
New vector.
Remarks:
The passed value is not checked.

KFbxVector4operator*(double pValue ) 

Multiply a value to all vector components.

Parameters:
pValue The value multiplying each component of the vector.
Returns:
New vector.
Remarks:
The passed value is not checked.

KFbxVector4operator/(double pValue ) 

Divide all vector components by a value.

Parameters:
pValue The value dividing each component of the vector.
Returns:
New vector.
Remarks:
The passed value is not checked.

KFbxVector4&operator+=(double pValue ) 

Add a value to all vector components.

Parameters:
pValue The value to add to each component of the vector.
Returns:
thisupdated with the operation result.
Remarks:
The passed value is not checked.

KFbxVector4&operator-=(double pValue ) 

Subtract a value from all vector components.

Parameters:
pValue The value to subtract from each component of the vector.
Returns:
thisupdated with the operation result.
Remarks:
The passed value is not checked.

KFbxVector4&operator*=(double pValue ) 

Multiply a value to all vector elements.

Parameters:
pValue The value multiplying each component of the vector.
Returns:
thisupdated with the operation result.
Remarks:
The passed value is not checked.

KFbxVector4&operator/=(double pValue ) 

Divide all vector elements by a value.

Parameters:
pValue The value dividing each component of the vector.
Returns:
thisupdated with the operation result.
Remarks:
The passed value is not checked.

KFbxVector4operator-( ) 

Unary minus operator.

Returns:
The vector that is the negation ofthis.

KFbxVector4operator+(KFbxVector4pVector ) 

Add two vectors together.

Parameters:
pVector Vector to add.
Returns:
The vector v' = this + pVector.
Remarks:
The values in pVector are not checked.

KFbxVector4operator-(KFbxVector4pVector ) 

Subtract a vector from another vector.

Parameters:
pVector Vector to subtract.
Returns:
The vector v' = this - pVector.
Remarks:
The values in pVector are not checked.

KFbxVector4operator*(KFbxVector4pVector ) 

Memberwise multiplication of two vectors.

Parameters:
pVector Multiplying vector.
Returns:
The vector v' = this * pVector.
Remarks:
The values in pVector are not checked.

KFbxVector4operator/(KFbxVector4pVector ) 

Memberwise division of a vector with another vector.

Parameters:
pVector Dividing vector.
Returns:
The vector v[i]' = this[i] / pVector[i].
Remarks:
The values in pVector are not checked.

KFbxVector4&operator+=(KFbxVector4pVector ) 

Add two vectors together.

Parameters:
pVector Vector to add.
Returns:
thisupdated with the operation result.
Remarks:
The values in pVector are not checked.

KFbxVector4&operator-=(KFbxVector4pVector ) 

Subtract a vector from another vector.

Parameters:
pVector Vector to subtract.
Returns:
thisupdated with the operation result.
Remarks:
The values in pVector are not checked.

KFbxVector4&operator*=(KFbxVector4pVector ) 

Memberwise multiplication of two vectors.

Parameters:
pVector Multiplying vector.
Returns:
thisupdated with the operation result.
Remarks:
The values in pVector are not checked.

KFbxVector4&operator/=(KFbxVector4pVector ) 

Memberwise division of a vector with another vector.

Parameters:
pVector Dividing vector.
Returns:
thisupdated with the operation result.
Remarks:
The values in pVector are not checked.

double DotProduct(KFbxVector4pVector ) 

Calculate the dot product of two vectors.

Parameters:
pVector The second vector.
Returns:
The dot product value.
Remarks:
Being considered as a XYZ vector with a weight, only the 3 first elements are considered in this operation.

KFbxVector4CrossProduct(KFbxVector4pVector ) 

Calculate the cross product of two vectors.

Parameters:
pVector The second vector.
Returns:
The cross product vector.
Remarks:
Being considered as a XYZ vector with a weight, only the first 3 elements are considered in this operation.

static bool AxisAlignmentInEulerAngle(KFbxVector4const& pAB,
KFbxVector4const& pA,
KFbxVector4const& pB,
KFbxVector4pAngles 
)[static]

Calculate the Euler rotation required to align axis pAB-pA on pAB-pB.

Parameters:
pAB The intersection of the 2 axis.
pA A point on axis to be aligned.
pB A point on reference axis.
pAngles Resulting euler angles.
Returns:
trueon success.
Remarks:
Being considered as a XYZ vector with a weight, only the first 3 elements are considered in this operation.

bool operator==(KFbxVector4pVector ) 

Equivalence operator.

Parameters:
pVector The vector to be compared tothis.
Returns:
trueif the two vectors are equal (each element is within a 1.0e-6 tolerance) andfalseotherwise.

bool operator==(KFbxVector4const& pVector ) const

Equivalence operator.

Parameters:
pVector The vector to be compared tothis.
Returns:
trueif the two vectors are equal (each element is within a 1.0e-6 tolerance) andfalseotherwise.

bool operator!=(KFbxVector4pVector ) 

Non equivalence operator.

Parameters:
pVector The vector to be compared tothis.
Returns:
falseif the two vectors are equal (each element is within a 1.0e-6 tolerance) andtrueotherwise.

bool operator!=(KFbxVector4const& pVector ) const

Equivalence operator.

Parameters:
pVector The vector to be compared tothis.
Returns:
trueif the two vectors are equal (each element is within a 1.0e-6 tolerance) andfalseotherwise.

double Length( ) 

Get the vector's length.

Returns:
The mathematical length of the vector.
Remarks:
Being considered as a XYZ vector with a weight, only the first 3 elements are considered in this operation.

double SquareLength( ) 

Get the vector's length squared.

Returns:
The mathematical square length of the vector.
Remarks:
Being considered as a XYZ vector with a weight, only the first 3 elements are considered in this operation.

double Distance(KFbxVector4pVector ) 

Find the distance between 2 vectors.

Parameters:
pVector The second vector.
Returns:
The mathematical distance between the two vectors.
Remarks:
Being considered as a XYZ vector with a weight, only the 3 first elements are considered in this operation.

void Normalize( ) 

Normalize the vector, length set to 1.

Remarks:
Being considered as a XYZ vector with a weight, only the first 3 elements are considered in this operation.

operator double *( ) 

Cast the vector in a double pointer.

operator const double *( ) 

Cast the vector in a const double pointer.

operator const double *( ) const

Cast the vector in a double pointer.