#include <fbxvector4.h>

Class Description

A four double mathematic vector class.

Examples:: Common/GeometryUtility.cxx, ExportDocument/main.cxx, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ExportScene05/main.cxx, ImportScene/DisplayCache.cxx, ImportScene/DisplayCommon.cxx, ImportScene/DisplayCommon.h, ImportScene/DisplayMaterial.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayNurb.cxx, ImportScene/DisplayPatch.cxx, ImportScene/DisplayPivotsAndLimits.cxx, ImportScene/DisplayPose.cxx, ImportScene/DisplayShape.cxx, ImportScene/main.cxx, Instances/main.cxx, Layers/main.cxx, Normals/main.cxx, Pivot/main.cxx, ProceduralTexture/main.cxx, Transformations/DisplayCommon.cxx, Transformations/DisplayCommon.h, Transformations/main.cxx, UI_Examples/CubeCreator/SDK_Utility.cxx, UI_Examples/SceneTreeView/SDK_Utility.cxx, UserProperties/main.cxx, ViewScene/DrawScene.cxx, ViewScene/GetPosition.cxx, ViewScene/GlFunctions.cxx, ViewScene/GlFunctions.h, ViewScene/SceneCache.cxx, ViewScene/SceneCache.h, ViewScene/SceneContext.h, ViewScene/SetCamera.cxx, and ViewScene/SetCamera.h.

Definition at line 25 of file fbxvector4.h.

Inheritance diagram for FbxVector4:

Public Member Functions
bool	IsZero (int pSize=4) const
	Find out if the vector is equal to zero. More...

void	FixIncorrectValue ()

Public Member Functions inherited from FbxVectorTemplate4< T >
	FbxVectorTemplate4 ()

	FbxVectorTemplate4 (T pValue)

	FbxVectorTemplate4 (T pData0, T pData1, T pData2, T pData3)

	~FbxVectorTemplate4 ()

T &	operator[] (int pIndex)

const T &	operator[] (int pIndex) const

	operator FbxVectorTemplate3< T > & () const

FbxVectorTemplate4< T > &	operator= (const T &pValue)

FbxVectorTemplate4< T > &	operator= (const FbxVectorTemplate3< T > &pValue)

FbxVectorTemplate4< T > &	operator= (const FbxVectorTemplate4< T > &pVector)

bool	operator== (const FbxVectorTemplate4< T > &pVector) const

bool	operator!= (const FbxVectorTemplate4< T > &pVector) const

T *	Buffer ()

const T *	Buffer () const

Constructors and Destructor
	FbxVector4 ()
	Constructor. More...

	FbxVector4 (const FbxVector4 &pVector4)
	Copy constructor. More...

	FbxVector4 (double pX, double pY, double pZ, double pW=1.0)
	Constructor. More...

	FbxVector4 (const double pValue[4])
	Constructor. More...

	FbxVector4 (const FbxDouble3 &pValue)
	Constructor. More...

Access
FbxVector4 &	operator= (const FbxVector4 &pVector4)
	Assignment operation. More...

FbxVector4 &	operator= (const double *pValue)
	Assignment operation. More...

FbxVector4 &	operator= (const FbxDouble3 &pValue)
	Assignment operation. More...

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

Scalar Operations
FbxVector4	operator+ (double pValue) const
	Add a value to all vector components. More...

FbxVector4	operator- (double pValue) const
	Subtract a value from all vector components. More...

FbxVector4	operator* (double pValue) const
	Multiply a value to all vector components. More...

FbxVector4	operator/ (double pValue) const
	Divide all vector components by a value. More...

FbxVector4 &	operator+= (double pValue)
	Add a value to all vector components. More...

FbxVector4 &	operator-= (double pValue)
	Subtract a value from all vector components. More...

FbxVector4 &	operator*= (double pValue)
	Multiply a value to all vector elements. More...

FbxVector4 &	operator/= (double pValue)
	Divide all vector elements by a value. More...

Vector Operations
FbxVector4	operator- () const
	Unary minus operator. More...

FbxVector4	operator+ (const FbxVector4 &pVector) const
	Add two vectors together. More...

FbxVector4	operator- (const FbxVector4 &pVector) const
	Subtract a vector from another vector. More...

FbxVector4	operator* (const FbxVector4 &pVector) const
	Memberwise multiplication of two vectors. More...

FbxVector4	operator/ (const FbxVector4 &pVector) const
	Memberwise division of a vector with another vector. More...

FbxVector4 &	operator+= (const FbxVector4 &pVector)
	Add two vectors together. More...

FbxVector4 &	operator-= (const FbxVector4 &pVector)
	Subtract a vector from another vector. More...

FbxVector4 &	operator*= (const FbxVector4 &pVector)
	Memberwise multiplication of two vectors. More...

FbxVector4 &	operator/= (const FbxVector4 &pVector)
	Memberwise division of a vector with another vector. More...

double	DotProduct (const FbxVector4 &pVector) const
	Calculate the dot product of two vectors. More...

FbxVector4	CrossProduct (const FbxVector4 &pVector) const
	Calculate the cross product of two vectors. More...

static bool	AxisAlignmentInEulerAngle (const FbxVector4 &pAB, const FbxVector4 &pA, const FbxVector4 &pB, FbxVector4 &pAngles)
	Calculate the Euler rotation required to align axis pAB-pA on pAB-pB. More...

Boolean Operations
bool	operator== (const FbxVector4 &pVector) const
	Equivalence operator. More...

bool	operator!= (const FbxVector4 &pVector) const
	Non equivalence operator. More...

Length
double	Length () const
	Get the vector's length. More...

double	SquareLength () const
	Get the vector's length squared. More...

double	Distance (const FbxVector4 &pVector) const
	Find the distance between 2 vectors. More...

void	Normalize ()
	Normalize the vector, length set to 1. More...

void	SetXYZ (const FbxQuaternion pQuat)
	Set the Euler XYZ from a Quaternion. More...

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

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

Additional Inherited Members
Public Attributes inherited from FbxVectorTemplate4< T >
T	mData [4]

Constructor & Destructor Documentation

FbxVector4 ( )

Constructor.

FbxVector4 ( const FbxVector4 & pVector4 )

Copy constructor.

Parameters

pVector4 The vector copied to this one.

FbxVector4	(	double	pX,
		double	pY,
		double	pZ,
		double	pW = `1.0`
	)

Constructor.

Parameters

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

FbxVector4 ( const double pValue[4] )

Constructor.

Parameters

pValue X,Y,Z,W components.

FbxVector4 ( const FbxDouble3 & pValue )

Constructor.

Parameters

pValue X,Y,Z components.

Remarks: The fourth component of this object is assigned 1.

Member Function Documentation

FbxVector4& operator= ( const FbxVector4 & pVector4 )

Assignment operation.

Parameters

pVector4 The vector assigned to this one.

Returns: This vector after assignment.

FbxVector4& operator= ( const double * pValue )

Assignment operation.

Parameters

pValue The pointer to an array whose elements are assigned to this vector.

Returns: This vector after assignment.

FbxVector4& operator= ( const FbxDouble3 & pValue )

Assignment operation.

Parameters

pValue The vector with 3 elements assigned to this vector.

Returns: This vector after assignment.

Remarks: The first three elements are assigned with pValue. The fourth element is set as 1.0

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.

Examples:: ExportScene01/main.cxx, ExportScene02/main.cxx, and ExportScene05/main.cxx.

FbxVector4 operator+ ( double pValue ) const

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.

FbxVector4 operator- ( double pValue ) const

Subtract a value from all vector components.

Parameters

pValue The value to subtract from each component of the vector.

Returns: New vector.

Remarks: The passed value is not checked.

FbxVector4 operator* ( double pValue ) const

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.

FbxVector4 operator/ ( double pValue ) const

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.

FbxVector4& operator+= ( double pValue )

Add a value to all vector components.

Parameters

pValue The value to add to each component of the vector.

Returns: this updated with the operation result.

Remarks: The passed value is not checked.

FbxVector4& operator-= ( double pValue )

Subtract a value from all vector components.

Parameters

pValue The value to subtract from each component of the vector.

Returns: this updated with the operation result.

Remarks: The passed value is not checked.

FbxVector4& operator*= ( double pValue )

Multiply a value to all vector elements.

Parameters

pValue The value multiplying each component of the vector.

Returns: this updated with the operation result.

Remarks: The passed value is not checked.

FbxVector4& operator/= ( double pValue )

Divide all vector elements by a value.

Parameters

pValue The value dividing each component of the vector.

Returns: this updated with the operation result.

Remarks: The passed value is not checked.

FbxVector4 operator- ( ) const

Unary minus operator.

Returns: The vector that is the negation of this.

FbxVector4 operator+ ( const FbxVector4 & pVector ) const

Add two vectors together.

Parameters

pVector Vector to add.

Returns: The vector v' = this + pVector.

Remarks: The values in pVector are not checked.

FbxVector4 operator- ( const FbxVector4 & pVector ) const

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.

FbxVector4 operator* ( const FbxVector4 & pVector ) const

Memberwise multiplication of two vectors.

Parameters

pVector Multiplying vector.

Returns: The vector v' = this * pVector.

Remarks: The values in pVector are not checked.

FbxVector4 operator/ ( const FbxVector4 & pVector ) const

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.

FbxVector4& operator+= ( const FbxVector4 & pVector )

Add two vectors together.

Parameters

pVector Vector to add.

Returns: this updated with the operation result.

Remarks: The values in pVector are not checked.

FbxVector4& operator-= ( const FbxVector4 & pVector )

Subtract a vector from another vector.

Parameters

pVector Vector to subtract.

Returns: this updated with the operation result.

Remarks: The values in pVector are not checked.

FbxVector4& operator*= ( const FbxVector4 & pVector )

Memberwise multiplication of two vectors.

Parameters

pVector Multiplying vector.

Returns: this updated with the operation result.

Remarks: The values in pVector are not checked.

FbxVector4& operator/= ( const FbxVector4 & pVector )

Memberwise division of a vector with another vector.

Parameters

pVector Dividing vector.

Returns: this updated with the operation result.

Remarks: The values in pVector are not checked.

double DotProduct ( const FbxVector4 & pVector ) const

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.

FbxVector4 CrossProduct ( const FbxVector4 & pVector ) const

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.

Examples:: ViewScene/SetCamera.cxx.

static bool AxisAlignmentInEulerAngle	(	const FbxVector4 &	pAB,
		const FbxVector4 &	pA,
		const FbxVector4 &	pB,
		FbxVector4 &	pAngles
	)

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: true on success.

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

Examples:: ExportScene04/main.cxx, and ViewScene/DrawScene.cxx.

bool operator== ( const FbxVector4 & pVector ) const

Equivalence operator.

Parameters

pVector The vector to be compared to this.

Returns: true if the two vectors are equal (each element is within a FBXSDK_TOLERANCE tolerance) and false otherwise.

bool operator!= ( const FbxVector4 & pVector ) const

Non equivalence operator.

Parameters

pVector The vector to be compared to this.

Returns: false if the two vectors are equal (each element is within a FBXSDK_TOLERANCE tolerance) and true otherwise.

double Length ( ) const

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.

Examples:: ViewScene/SetCamera.cxx.

double SquareLength ( ) const

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 ( const FbxVector4 & pVector ) const

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.

Examples:: ViewScene/SetCamera.cxx.

void SetXYZ ( const FbxQuaternion pQuat )

Set the Euler XYZ from a Quaternion.

Parameters

pQuat Quaternion from which Euler XYZ information is got.

operator double * ( )

Cast the vector in a double pointer.

operator const double * ( ) const

Cast the vector in a const double pointer.

bool IsZero ( int pSize = 4 ) const

Find out if the vector is equal to zero.

Parameters

pSize The number of element to test, starting at beginning. Value must range between [1, 4].

Returns: true if all elements of the vector are zero, false otherwise.

void FixIncorrectValue ( )

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

fbxsdk/core/math/fbxvector4.h

FbxVector4 Class Reference

Class Description

Public Member Functions

Constructors and Destructor

Access

Scalar Operations

Vector Operations

Boolean Operations

Length

Casting

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation