This reference page is linked to from the following overview topics: FBX Nodes, List of Python FBX classes.

Detailed Description

KFbxLimits defines a limit range for one transform component (either translation, rotation or scaling).

One transform component limit contains two part: a min value and a max value limit, which means that each value of the corresponding transform component cannot go beyond the range set by the min and max values. KFbxLimits uses KFbxVector4 objects to store the range values. Although the members are identified as X, Y and Z (the W component is ignored) at this level, they are unitless values and will only have meaning within the context they are queried.

For each limit, there is one flag to indicate if the limit is active or not. Before accessing the limit info, the caller need to query the flag first to make sure that the retrieved values will be meaningful.

Definition at line 73 of file kfbxnodelimits.h.

#include <kfbxnodelimits.h>

List of all members.

Public Member Functions
	KFbxLimits ()
	Constructor.
virtual	~KFbxLimits ()
	Destructor.
	KFbxLimits (const KFbxLimits &other)
void	SetLimitMinActive (const bool pXActive, const bool pYActive, const bool pZActive)
	Set the active state of min limit.
void	GetLimitMinActive (bool &pXActive, bool &pYActive, bool &pZActive) const
	Get the active states of the three components of the min limit.
void	SetLimitMaxActive (const bool pXActive, const bool pYActive, const bool pZActive)
	Set the active state of max limit.
void	GetLimitMaxActive (bool &pXActive, bool &pYActive, bool &pZActive) const
	Get the active states of the three components of the max limit.
bool	GetLimitSomethingActive () const
	Check if at least one of the active flags is set.
void	SetLimitMin (const KFbxVector4 &pMin)
	Set the min limit.
KFbxVector4	GetLimitMin () const
	Get the min limit.
void	SetLimitMax (const KFbxVector4 &pMax)
	Set the max limit.
KFbxVector4	GetLimitMax () const
	Get the max limit.
KFbxLimits &	operator= (const KFbxLimits &pFbxLimit)
	Assignment operation.
void	Apply (KFbxVector4 &pOut, KFbxVector4 &pIn)
Friends
class	KFbxNodeLimits

Constructor & Destructor Documentation

KFbxLimits ( )

Constructor.

virtual ~KFbxLimits ( ) [virtual]

Destructor.

KFbxLimits ( const KFbxLimits & other )

Member Function Documentation

void SetLimitMinActive	(	const bool	pXActive,
		const bool	pYActive,
		const bool	pZActive
	)

Search for all occurrences

Set the active state of min limit.

Parameters:

pXActive	Set to `true`, to activate the X component min limit.
pYActive	Set to `true`, to activate the Y component min limit.
pZActive	Set to `true`, to activate the Z component min limit.

Examples:: ExportScene05/main.cxx.

void GetLimitMinActive	(	bool &	pXActive,
		bool &	pYActive,
		bool &	pZActive
	)		const

Search for all occurrences

Get the active states of the three components of the min limit.

Parameters:

pXActive	`true` if the X component of the min limit is active.
pYActive	`true` if the Y component of the min limit is active.
pZActive	`true` if the Z component of the min limit is active.

Examples:: ImportScene/DisplayPivotsAndLimits.cxx.

void SetLimitMaxActive	(	const bool	pXActive,
		const bool	pYActive,
		const bool	pZActive
	)

Search for all occurrences

Set the active state of max limit.

Parameters:

pXActive	Set to `true`, to activate the X component max limit.
pYActive	Set to `true`, to activate the Y component max limit.
pZActive	Set to `true`, to activate the Z component max limit.

Examples:: ExportScene05/main.cxx.

void GetLimitMaxActive	(	bool &	pXActive,
		bool &	pYActive,
		bool &	pZActive
	)		const

Search for all occurrences

Get the active states of the three components of the max limit.

Parameters:

pXActive	`true` if the X component of the max limit is active.
pYActive	`true` if the Y component of the max limit is active.
pZActive	`true` if the Z component of the max limit is active.