FbxLimits Class Reference

#include <fbxtransforms.h>

Class Description

FbxLimits 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. 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 34 of file fbxtransforms.h.

Public Member Functions
	FbxLimits ()
	Constructor. More...
FbxLimits &	operator= (const FbxLimits &pLimits)
	Assignment Operator. More...
bool	GetActive () const
	Retrieve the active state of this limit. More...
void	SetActive (const bool pActive)
	Set the active state of this limit. More...
bool	GetMinXActive () const
	Get the active state of the minimum X component. More...
bool	GetMinYActive () const
	Get the active state of the minimum Y component. More...
bool	GetMinZActive () const
	Get the active state of the minimum Z component. More...
void	GetMinActive (bool &pXActive, bool &pYActive, bool &pZActive) const
	Get the active states of the three components of the minimum limit. More...
FbxDouble3	GetMin () const
	Get the minimum limits. More...
void	SetMinXActive (bool pActive)
	Set the active state of the minimum X component. More...
void	SetMinYActive (bool pActive)
	Set the active state of the minimum Y component. More...
void	SetMinZActive (bool pActive)
	Set the active state of the minimum Z component. More...
void	SetMinActive (bool pXActive, bool pYActive, bool pZActive)
	Set the active states of the three components of the minimum limits. More...
void	SetMin (const FbxDouble3 &pMin)
	Set the minimum limits. More...
bool	GetMaxXActive () const
	Get the active state of the maximum X component. More...
bool	GetMaxYActive () const
	Get the active state of the maximum Y component. More...
bool	GetMaxZActive () const
	Get the active state of the maximum Z component. More...
void	GetMaxActive (bool &pXActive, bool &pYActive, bool &pZActive) const
	Get the active states of the three components of the maximum limit. More...
FbxDouble3	GetMax () const
	Get the maximum limits. More...
void	SetMaxXActive (bool pActive)
	Set the active state of the maximum X component. More...
void	SetMaxYActive (bool pActive)
	Set the active state of the maximum Y component. More...
void	SetMaxZActive (bool pActive)
	Set the active state of the maximum Z component. More...
void	SetMaxActive (bool pXActive, bool pYActive, bool pZActive)
	Set the active states of the three components of the maximum limits. More...
void	SetMax (const FbxDouble3 &pMax)
	Set the maximum limits. More...
bool	GetAnyMinMaxActive () const
	Find if any of the minimum or maximum active state are set. More...
FbxDouble3	Apply (const FbxDouble3 &pVector)
	Apply the active limits to the components of the vector provided. More...

Constructor & Destructor Documentation

FbxLimits()

FbxLimits

(

)

Constructor.

Member Function Documentation

operator=()

FbxLimits& operator=

(

const FbxLimits &

pLimits

)

Assignment Operator.

GetActive()

bool GetActive

(

)

const

Retrieve the active state of this limit.

Returns

True if the limit is active.

SetActive()

void SetActive

(

const bool

pActive

)

Set the active state of this limit.

Parameters

pActive

If true, this limit will become globally active.

GetMinXActive()

bool GetMinXActive

(

)

const

Get the active state of the minimum X component.

Returns

True if the X component minimum limit is active.

GetMinYActive()

bool GetMinYActive

(

)

const

Get the active state of the minimum Y component.

Returns

True if the Y component minimum limit is active.

GetMinZActive()

bool GetMinZActive

(

)

const

Get the active state of the minimum Z component.

Returns

True if the Z component minimum limit is active.

GetMinActive()

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

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

Parameters

pXActive	True if the X component minimum limit is active.
pYActive	True if the Y component minimum limit is active.
pZActive	True if the Z component minimum limit is active.

GetMin()

FbxDouble3 GetMin

(

)

const

Get the minimum limits.

Returns

The current X, Y and Z values for the minimum limits.

SetMinXActive()

void SetMinXActive

(

bool

pActive

)

Set the active state of the minimum X component.

Parameters

pActive

If true, the X component minimum limit will be active.

SetMinYActive()

void SetMinYActive

(

bool

pActive

)

Set the active state of the minimum Y component.

Parameters

pActive

If true, the Y component minimum limit will be active.

SetMinZActive()

void SetMinZActive

(

bool

pActive

)

Set the active state of the minimum Z component.

Parameters

pActive

If true, the Z component minimum limit will be active.

SetMinActive()

void SetMinActive	(	bool	pXActive,
		bool	pYActive,
		bool	pZActive
	)

Set the active states of the three components of the minimum limits.

Parameters

pXActive	If true, the X component minimum limit will be active.
pYActive	If true, the Y component minimum limit will be active.
pZActive	If true, the Z component minimum limit will be active.

SetMin()

void SetMin

(

const FbxDouble3 &

pMin

)

Set the minimum limits.

Parameters

pMin	The X, Y and Z values for the minimum limits.

GetMaxXActive()

bool GetMaxXActive

(

)

const

Get the active state of the maximum X component.

Returns

True if the X component maximum limit is active.

GetMaxYActive()

bool GetMaxYActive

(

)

const

Get the active state of the maximum Y component.

Returns

True if the Y component maximum limit is active.

GetMaxZActive()

bool GetMaxZActive

(

)

const

Get the active state of the maximum Z component.

Returns

True if the Z component maximum limit is active.

GetMaxActive()

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

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

Parameters

pXActive	True if the X component maximum limit is active.
pYActive	True if the Y component maximum limit is active.
pZActive	True if the Z component maximum limit is active.

GetMax()

FbxDouble3 GetMax

(

)

const

Get the maximum limits.

Returns

The current X, Y and Z values for the maximum limits.

SetMaxXActive()

void SetMaxXActive

(

bool

pActive

)

Set the active state of the maximum X component.

Parameters

pActive

If true, the X component maximum limit will be active.

SetMaxYActive()

void SetMaxYActive

(

bool

pActive

)

Set the active state of the maximum Y component.

Parameters

pActive

If true, the Y component maximum limit will be active.

SetMaxZActive()

void SetMaxZActive

(

bool

pActive

)

Set the active state of the maximum Z component.

Parameters

pActive

If true, the Z component maximum limit will be active.

SetMaxActive()

void SetMaxActive	(	bool	pXActive,
		bool	pYActive,
		bool	pZActive
	)

Set the active states of the three components of the maximum limits.

Parameters

pXActive	If true, the X component maximum limit will be active.
pYActive	If true, the Y component maximum limit will be active.
pZActive	If true, the Z component maximum limit will be active.

SetMax()

void SetMax

(

const FbxDouble3 &

pMax

)

Set the maximum limits.

Parameters

pMax	The X, Y and Z values for the maximum limits.

GetAnyMinMaxActive()

bool GetAnyMinMaxActive

(

)

const

Find if any of the minimum or maximum active state are set.

Returns

If any component of the minimum or maximum active state are set, true is returned.

Remarks

The global active state will not count when resolving this.

Apply()

FbxDouble3 Apply

(

const FbxDouble3 &

pVector

)

Apply the active limits to the components of the vector provided.

Returns

The new vector clamped by active limits.

---

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

• fbxsdk/core/math/fbxtransforms.h