KFbxAxisSystem Class Reference

#include
<kfbxaxissystem.h>

List of all members.

Detailed Description

This class represents the coordinate system of the scene, and can convert scenes from its coordinate system to other coordinate systems.

Definition at line 61 of file kfbxaxissystem.h.


Constructor and Destructor
	KFbxAxisSystem (eUpVector pUpVector, eFrontVector pFrontVector, eCoorSystem pCoorSystem)
	Constructor!
	KFbxAxisSystem (const KFbxAxisSystem &pAxisSystem)
	Copy constructor!
	KFbxAxisSystem (const ePreDefinedAxisSystem pAxisSystem)
	Constructor!
virtual	~KFbxAxisSystem ()
	Destructor.
Boolean operation.
bool	operator== (const KFbxAxisSystem &pAxisSystem) const
	Equivalence operator.
bool	operator!= (const KFbxAxisSystem &pAxisSystem) const
	Non-equivalence operator.
Public Types
enum	eUpVector
	Specifies which canonical axis represents up in the system. More...
enum	eFrontVector
	Vector with origin at the screen pointing toward the camera. More...
enum	eCoorSystem
	RightHanded LeftHanded More...
enum	ePreDefinedAxisSystem
	eMayaZUp eMayaYUp eMax eMotionBuilder eOpenGL eDirectX eLightwave More...
Public Member Functions
KFbxAxisSystem &	operator= (const KFbxAxisSystem &pAxisSystem)
	Assignment operation.
void	ConvertScene (KFbxScene *pScene) const
	Convert a scene to this axis system.
void	ConvertScene (KFbxScene pScene, KFbxNode pFbxRoot) const
	Convert a scene to this axis system by using the specified node as an Fbx_Root.
eUpVector	GetUpVector (int &pSign) const
	Returns the eUpVector this axis system and get the sign of the axis.
eCoorSystem	GetCoorSystem () const
	Returns the eCoorSystem this axis system.
void	ConvertChildren (KFbxNode *pRoot, const KFbxAxisSystem &pSrcSystem) const
	Converts the children of the given node to this axis system.
Static Public Attributes
static const KFbxAxisSystem	MayaZUp
	Predefined axis system: MayaZUp.
static const KFbxAxisSystem	MayaYUp
	Predefined axis system: MayaYUp.
static const KFbxAxisSystem	Max
	Predefined axis system: Max.
static const KFbxAxisSystem	Motionbuilder
	Predefined axis system: Motionbuilder.
static const KFbxAxisSystem	OpenGL
	Predefined axis system: OpenGL.
static const KFbxAxisSystem	DirectX
	Predefined axis system: DirectX.
static const KFbxAxisSystem	Lightwave
	Predefined axis system: Lightwave.

Member Enumeration Documentation

enum eUpVector

Specifies which canonical axis represents up in the system.

Typically Y or Z.

XAxis
YAxis
ZAxis

Definition at line 70 of file kfbxaxissystem.h.

enum eFrontVector

Vector with origin at the screen pointing toward the camera.

This is a subset of enum eUpVector because axis cannot be repeated.

ParityEven
ParityOdd

Definition at line 81 of file kfbxaxissystem.h.

enum eCoorSystem

RightHanded
- LeftHanded

Definition at line 90 of file kfbxaxissystem.h.

enum ePreDefinedAxisSystem

eMayaZUp
- eMayaYUp
- eMax
- eMotionBuilder
- eOpenGL
- eDirectX
- eLightwave

Definition at line 104 of file kfbxaxissystem.h.

Constructor & Destructor Documentation

KFbxAxisSystem	(	eUpVector	pUpVector,
		eFrontVector	pFrontVector,
		eCoorSystem	pCoorSystem
	)

Constructor!

Parameters:

	pUpVector	Specify the up vector.
	pFrontVector	Specify the front vector.
	pCoorSystem	Specify RightHanded coordinate system or LeftHanded coordinate system.

KFbxAxisSystem ( const KFbxAxisSystem & pAxisSystem )

Copy constructor!

Parameters:

pAxisSystem

Another KFbxAxisSystem object copied to this one.

KFbxAxisSystem ( const ePreDefinedAxisSystem pAxisSystem )

Constructor!

Parameters:

pAxisSystem

Specify which predefined axis system to copy.

virtual ~KFbxAxisSystem ( ) [virtual]

Destructor.

Member Function Documentation

bool operator== ( const KFbxAxisSystem & pAxisSystem ) const

Equivalence operator.

Parameters:

pAxisSystem

The axis system to compare against this one.

Returns:: true if these two axis systems are equal, false otherwise.

bool operator!= ( const KFbxAxisSystem & pAxisSystem ) const

Non-equivalence operator.

Parameters:

pAxisSystem

The axis system to compare against this one.

Returns:: true if these two axis systems are unequal, false otherwise.

KFbxAxisSystem& operator= ( const KFbxAxisSystem & pAxisSystem )

Assignment operation.

Parameters:

pAxisSystem

Axis system assigned to this one.

void ConvertScene ( KFbxScene * pScene ) const

Convert a scene to this axis system.

Sets the axis system of the scene to this system unit.

Parameters:

pScene

The scene to convert

void ConvertScene	(	KFbxScene *	pScene,
		KFbxNode *	pFbxRoot
	)			const

Convert a scene to this axis system by using the specified node as an Fbx_Root.

This is provided for backwards compatibility only and ConvertScene(KFbxScene* pScene) should be used instead when possible.

Parameters:

	pScene	The scene to convert
	pFbxRoot	The Fbx_Root node that will be transformed.

eUpVector GetUpVector ( int & pSign ) const

Returns the eUpVector this axis system and get the sign of the axis.

Parameters:

pSign

The sign of the axis, 1 if up, -1 is down.

eCoorSystem GetCoorSystem ( ) const

Returns the eCoorSystem this axis system.

Returns:: The current coordinate axis system.

void ConvertChildren	(	KFbxNode *	pRoot,
		const KFbxAxisSystem &	pSrcSystem
	)			const

Converts the children of the given node to this axis system.

Unlike the ConvertScene() method, this method does not set the axis system of the scene that the pRoot node belongs, nor does it adjust KFbxPoses as they are not stored under the scene, and not under a particular node.

Parameters: