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

Detailed Description

This class describes the units of measurement used within a particular scene.

Examples:: ViewScene/SceneContext.cxx.

Definition at line 32 of file fbxsystemunit.h.

#include <fbxsystemunit.h>

List of all members.

Classes
struct	ConversionOptions
	Struct to define various options that you can use to convert the system unit of a scene. More...
Public Member Functions
	FbxSystemUnit (double pScaleFactor, double pMultiplier=1.0)
	Constructor.
	~FbxSystemUnit ()
	Destructor.
void	ConvertScene (FbxScene *pScene, const ConversionOptions &pOptions=DefaultConversionOptions) const
	Converts a scene from its system units to this system unit.
void	ConvertChildren (FbxNode *pRoot, const FbxSystemUnit &pSrcUnit, const ConversionOptions &pOptions=DefaultConversionOptions) const
	Converts the child (or children) of the given node from the system unit to this system unit.
void	ConvertScene (FbxScene pScene, FbxNode pFbxRoot, const ConversionOptions &pOptions=DefaultConversionOptions) const
	Converts a scene from its system unit to this system unit, using the specified Fbx_Root node.
double	GetScaleFactor () const
	Returns the system unit's scale factor, relative to centimeters.
FbxString	GetScaleFactorAsString (bool pAbbreviated=true) const
	Returns a unit label for the current scale factor.
FbxString	GetScaleFactorAsString_Plurial () const
	Returns a unit label for the current scale factor.
double	GetMultiplier () const
	Returns the multiplier factor of the system unit.
bool	operator== (const FbxSystemUnit &pOther) const
	Equivalence operator.
bool	operator!= (const FbxSystemUnit &pOther) const
	Non-equivalence operator.
double	GetConversionFactorTo (const FbxSystemUnit &pTarget) const
	Returns the conversion factor from this system unit to the target system unit, excluding the multiplier factor.
double	GetConversionFactorFrom (const FbxSystemUnit &pSource) const
	Returns the conversion factor from the source system unit to this system unit, excluding the multiplier factor.
Static Public Attributes
static const FbxSystemUnit	mm
	Predefined system unit for millimeters.
static const FbxSystemUnit	dm
	Predefined system unit for decimeters.
static const FbxSystemUnit	cm
	Predefined system unit for centimeters.
static const FbxSystemUnit	m
	Predefined system unit for meters.
static const FbxSystemUnit	km
	Predefined system unit for kilometers.
static const FbxSystemUnit	Inch
	Predefined system unit for inches.
static const FbxSystemUnit	Foot
	Predefined system unit for feet.
static const FbxSystemUnit	Mile
	Predefined system unit for miles.
static const FbxSystemUnit	Yard
	Predefined system unit for yards.
static const FbxSystemUnit *	sPredefinedUnits
	Points to a FbxSystemUnit array to store the predefined system units. The array size is FBXSDK_SYSTEM_UNIT_PREDEF_COUNT.
static const ConversionOptions	DefaultConversionOptions
	Stores the default conversion options.
Protected Member Functions
void	ApplyMultiplier (FbxNode *pRoot, bool pSubChildrenOnly) const
void	ConvertSTProperties (FbxArray< FbxNode * > &pNodes, double pConversionFactor) const
void	ConvertSProperty (FbxArray< FbxNode * > &pNodes, double pConversionFactor) const
void	ConvertAnimCurveNode (FbxArray< FbxAnimCurveNode * > &pFCurves, double pConversionFactor) const
double	GetConversionFactor (double pTargetScaleFactor, double pSourceScaleFactor) const
void	AdjustPivots (FbxNode *pNode, double pConversionFactor, FbxAMatrix &pOriginalGlobalM) const
void	AdjustLimits (FbxNode *pNode, double pConversionFactor) const
void	AdjustPoses (FbxScene *pScene, double pConversionFactor) const
void	AdjustCluster (FbxNode *pNode, double pConversionFactor) const
void	AdjustLightIntensity (FbxNode *pNode, const double pConversionFactor) const
void	AdjustPhotometricLightProperties (FbxNode *pNode, const double pConversionFactor) const
void	AdjustCameraClipPlanes (FbxNode *pNode, const double pConversionFactor) const
void	ConvertChildren (FbxNode *pRoot, const FbxSystemUnit &pSrcUnit, bool pSubChildrenOnly, const ConversionOptions &pOptions) const
Protected Attributes
double	mScaleFactor
double	mMultiplier
Friends
class	FbxGlobalSettings

Constructor & Destructor Documentation

FbxSystemUnit	(	double	pScaleFactor,
		double	pMultiplier = `1.0`
	)		`[explicit]`

Constructor.

Parameters:

pScaleFactor	The equivalent number of centimeters in the new system unit. For example, an inch unit uses a scale factor of 2.54.
pMultiplier	A multiplier factor of pScaleFactor.

~FbxSystemUnit ( )

Destructor.

Member Function Documentation

void ConvertScene	(	FbxScene *	pScene,
		const ConversionOptions &	pOptions = `DefaultConversionOptions`
	)		const

Search for all occurrences

Converts a scene from its system units to this system unit.

Parameters:

pScene	The scene to convert.
pOptions	Conversion options, see:FbxSystemUnit::ConversionOptions.

Examples:: ViewScene/SceneContext.cxx.

void ConvertChildren	(	FbxNode *	pRoot,
		const FbxSystemUnit &	pSrcUnit,
		const ConversionOptions &	pOptions = `DefaultConversionOptions`
	)		const

Search for all occurrences

Converts the child (or children) of the given node from the system unit to this system unit.

Unlike the ConvertScene() method, this method does not set the axis system of the scene to which the pRoot node belongs. It also does not adjust FbxPose as they are not stored under the scene, and not under a particular node.

Parameters:

pRoot	The given node.
pSrcUnit	The source system unit.
pOptions	Conversion options, see:FbxSystemUnit::ConversionOptions.

void ConvertScene	(	FbxScene *	pScene,
		FbxNode *	pFbxRoot,
		const ConversionOptions &	pOptions = `DefaultConversionOptions`
	)		const

Search for all occurrences

Converts a scene from its system unit to this system unit, using the specified Fbx_Root node.

This method is provided for backwards compatibility only and instead you should use ConvertScene( FbxScene* , const ConversionOptions& ) whenever possible.

Parameters:

pScene	The scene to convert.
pFbxRoot	The Fbx_Root node to use for conversion.
pOptions	Conversion options, see:FbxSystemUnit::ConversionOptions

double GetScaleFactor ( ) const

Search for all occurrences

Returns the system unit's scale factor, relative to centimeters.

This factor scales system unit values to centimeters. If you want to scale values to centimeters, use this value. Ignore the "multiplier" (returned by GetMultiplier()) value.