This reference page is linked to from the following overview topics: 2012.1, Supported Scene Elements, Scene Axis and Unit Conversion, List of Python FBX classes.

Detailed Description

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

By default the KFbxScene uses a Y-Up axis system. If the calling application wishes to change the default axis it will need to define the new axis system and call the convert method with the scene as argument. The appropriate transforms will be applied to the first level objects of the scene only (objects whose parent is the scene itself). Child objects do not need to be transformed since they inherit from their parents. The adjustment will affect the translation animation curves and the objects pivots values (the rotation transformation is applied as a pre-rotation transform therefore the rotation animation curves do not need to be transformed). Once converted, the scene will have its axis definition changed to the new system.

For example:

        KFbxScene* lScene = KFbxScene::Create(sdkmanager, "MyScene");
        ...
        // the scene is filled with objects

        int dir;
        lScene->GetGlobalSettings().GetAxisSystem().GetUpVector(dir); // this returns the equivalent of KFbxAxisSystem::YAxis

        KFbxAxisSystem max; // we desire to convert the scene from Y-Up to Z-Up
        max.ConvertScene(lScene);

        lScene->GetGlobalSettings().GetAxisSystem().GetUpVector(dir); // this will now return the equivalent of KFbxAxisSystem::ZAxis

No conversion will take place if the scene current axis system is equal to the new one.

The eUpVector specifies which axis has the up and down direction in the system (typically this is the Y or Z axis). The sign of the eUpVector is applied to represent the direction (1 is up and -1 is down relative to the observer).

The eFrontVector specifies which axis has the front and back direction in the system. It is not an independent variable, which means it depends on eUpVector. The enum values ParityEven and ParityOdd denote the first one and the second one of the remain two axes in addition to the up axis.

For example if the up axis is X, the remain two axes will be Y And Z, so the ParityEven is Y, and the ParityOdd is Z ; If the up axis is Y, the remain two axes will X And Z, so the ParityEven is X, and the ParityOdd is Z; If the up axis is Z, the remain two axes will X And Y, so the ParityEven is X, and the ParityOdd is Y.

There still needs a parameter to denote the direction of the eFrontVector just as the eUpVector. And the sign of the eFrontVector represents the direction (1 is front and -1 is back relative to observer).

If the front axis and the up axis are determined, the third axis will be automatically determined as the left one. The eCoorSystem enum is a parameter to determine the direction of the third axis just as the eUpVector sign. It determines if the axis system is right-handed or left-handed just as the enum values.

Some code for reconstructing a KFbxAxisSystem object from reference scene.

        //the reference scene
        KFbxScene* lSceneReference = KFbxScene::Create(sdkmanager, "ReferenceScene");
        ...
        // the scene is filled with objects

        KFbxAxisSystem lAxisSytemReference = lSceneReference->GetGlobalSettings().GetAxisSystem();

        int lUpVectorSign = 1;
        int lFrontVectorSign = 1;

        //get upVector and its sign.
        eUpVector lUpVector = lAxisSsytemReference.getUpVector( lUpVectorSign );

        //get FrontVector and its sign.
        eFrontVector lFrontVector = lAxisSsytemReference.getFrontVector( lFrontVectorSign );

        //get uCoorSystem. 
        eCoorSystem lCoorSystem = lAxisSsytemReference.GetCoorSystem();

        //The KFbxAxisSystem object to reconstruct back by saved parameter
        KFbxAxisSystem lAxisSytemReconstruct( lUpVectorSign * lUpVector, 
                                              lFrontVectorSign * lFrontVector,
                                              lCoorSystem);

Examples:: ViewScene/main.cxx.

Definition at line 105 of file kfbxaxissystem.h.

#include <kfbxaxissystem.h>

List of all members.

Classes
class	KFbxAxis
Public Types
enum	eUpVector { XAxis = 1, YAxis = 2, ZAxis = 3 }
	Specifies which canonical axis represents up in the system (typically Y or Z). More...
enum	eFrontVector { ParityEven = 1, ParityOdd = 2 }
	Vector with origin at the screen pointing toward the camera. More...
enum	eCoorSystem { RightHanded = 0, LeftHanded = 1 }
	Specifies the third vector of the system. More...
enum	ePreDefinedAxisSystem { eMayaZUp = 0, eMayaYUp, eMax, eMotionBuilder, eOpenGL, eDirectX, eLightwave }
	Enumeration that can be used to initialize a new instance of this class with predefined configurations (see the "Predefined axis systems" section). 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.
eFrontVector	GetFrontVector (int &pSign) const
	Get the eFrontVector and its sign of this axis system.
eUpVector	GetUpVector (int &pSign) const
	Get the eUpVector and its sign of this axis system.
eCoorSystem	GetCoorSystem () const
	Accessor to the eCoorSystem of this object.
void	ConvertChildren (KFbxNode *pRoot, const KFbxAxisSystem &pSrcSystem) const
	Converts the children of the given node to this axis system.
Protected Member Functions
void	ConvertTProperty (KArrayTemplate< KFbxNode * > &pNodes, const KFbxAxisSystem &pFrom) const
	Apply the axis conversion to the translation property of the nodes.
void	ConvertCurveNodes (KArrayTemplate< KFbxAnimCurveNode * > &pCurveNodes, const KFbxAxisSystem &pFrom) const
	Apply the axis conversion to the translation animation curves.
void	AdjustPreRotation (KFbxNode *pNode, const KFbxMatrix &pConversionRM) const
	Adjust the Pre rotation to orient the node and children correctly.
void	AdjustPivots (KFbxNode *pNode, const KFbxMatrix &pConversionRM) const
	Adjust the pivots of the node for the new axis system.
void	GetConversionMatrix (const KFbxAxisSystem &pFrom, KFbxMatrix &pConversionRM) const
	Computes the transformation matrix to pass from the pFrom system to this one.
void	AdjustLimits (KFbxNode *pNode, const KFbxMatrix &pConversionRM) const
	Adjust the node translation limits for the new axis system.
void	AdjustPoses (KFbxScene *pScene, const KFbxMatrix &pConversionRM) const
	Adjust all the poses in the pScene for the new axis system.
void	AdjustCamera (KFbxNode *pNode, const KFbxMatrix &pConversionRM) const
	Recompute the camera's up-vector for the new axis system.
void	AdjustCluster (KFbxNode *pNode, const KFbxMatrix &pConversionRM) const
	Adjust the node cluster's matrices for the new axis system.
void	ConvertChildren (KFbxNode *pRoot, const KFbxAxisSystem &pSrcSystem, bool pSubChildrenOnly) const
	This is the main function that will dispatch all the calls of the "Adjust" methods.
Protected Attributes
KFbxAxis	mUpVector
	The up vector (and sign) of this object.
KFbxAxis	mFrontVector
	The front vector (and sign) of this object.
KFbxAxis	mCoorSystem
	The third vector (and sign) of this object.
Friends
class	KFbxGlobalSettings
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.
Predefined axis systems.
These static members define the axis system of the most popular applications.
static const KFbxAxisSystem	MayaZUp
	Predefined axis system: MayaZUp (UpVector = +Z, FrontVector = -Y, CoordSystem = +X (RightHanded))
static const KFbxAxisSystem	MayaYUp
	Predefined axis system: MayaYUp (UpVector = +Y, FrontVector = +Z, CoordSystem = +X (RightHanded))
static const KFbxAxisSystem	Max
	Predefined axis system: Max (UpVector = +Z, FrontVector = -Y, CoordSystem = +X (RightHanded))
static const KFbxAxisSystem	Motionbuilder
	Predefined axis system: Motionbuilder (UpVector = +Y, FrontVector = +Z, CoordSystem = +X (RightHanded))
static const KFbxAxisSystem	OpenGL
	Predefined axis system: OpenGL (UpVector = +Y, FrontVector = +Z, CoordSystem = +X (RightHanded))
static const KFbxAxisSystem	DirectX
	Predefined axis system: DirectX (UpVector = +Y, FrontVector = +Z, CoordSystem = -X (LeftHanded))
static const KFbxAxisSystem	Lightwave
	Predefined axis system: Lightwave (UpVector = +Y, FrontVector = +Z, CoordSystem = -X (LeftHanded))

XAxis	Search for all occurrences
YAxis	Search for all occurrences
ZAxis	Search for all occurrences

ParityEven	Search for all occurrences
ParityOdd	Search for all occurrences

RightHanded	Search for all occurrences
LeftHanded	Search for all occurrences

eMayaZUp	UpVector = ZAxis, FrontVector = -ParityOdd, CoordSystem = RightHanded. Search for all occurrences
eMayaYUp	UpVector = YAxis, FrontVector = ParityOdd, CoordSystem = RightHanded. Search for all occurrences
eMax	UpVector = ZAxis, FrontVector = -ParityOdd, CoordSystem = RightHanded. Search for all occurrences
eMotionBuilder	UpVector = YAxis, FrontVector = ParityOdd, CoordSystem = RightHanded. Search for all occurrences
eOpenGL	UpVector = YAxis, FrontVector = ParityOdd, CoordSystem = RightHanded. Search for all occurrences
eDirectX	UpVector = YAxis, FrontVector = ParityOdd, CoordSystem = LeftHanded. Search for all occurrences
eLightwave	UpVector = YAxis, FrontVector = ParityOdd, CoordSystem = LeftHanded. Search for all occurrences

KFbxAxisSystem	(	eUpVector	pUpVector,
		eFrontVector	pFrontVector,
		eCoorSystem	pCoorSystem
	)

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

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

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

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

pRoot	The node whose children are converted.
pSrcSystem	The source axis system.

void ConvertTProperty	(	KArrayTemplate< KFbxNode * > &	pNodes,
		const KFbxAxisSystem &	pFrom
	)		const `[protected]`

void ConvertCurveNodes	(	KArrayTemplate< KFbxAnimCurveNode * > &	pCurveNodes,
		const KFbxAxisSystem &	pFrom
	)		const `[protected]`

void AdjustPreRotation	(	KFbxNode *	pNode,
		const KFbxMatrix &	pConversionRM
	)		const `[protected]`

void AdjustPivots	(	KFbxNode *	pNode,
		const KFbxMatrix &	pConversionRM
	)		const `[protected]`

void GetConversionMatrix	(	const KFbxAxisSystem &	pFrom,
		KFbxMatrix &	pConversionRM
	)		const `[protected]`

void AdjustLimits	(	KFbxNode *	pNode,
		const KFbxMatrix &	pConversionRM
	)		const `[protected]`

void AdjustPoses	(	KFbxScene *	pScene,
		const KFbxMatrix &	pConversionRM
	)		const `[protected]`

void AdjustCamera	(	KFbxNode *	pNode,
		const KFbxMatrix &	pConversionRM
	)		const `[protected]`

void AdjustCluster	(	KFbxNode *	pNode,
		const KFbxMatrix &	pConversionRM
	)		const `[protected]`

KFbxAxisSystem Class Reference

Detailed Description

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Constructor and Destructor

Boolean operation.

Predefined axis systems.

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation