KFbxNodeLimits Class Reference

#include <kfbxnodelimits.h>

List of all members.

---

Detailed Description

Manages a separate KFbxLimits object for the translation, rotation, and scaling transform components of a node.

Each transform component limit can be activated or deactivated. All three KFbxLimits objects (mTranslationLimits, mRotationLimits, and mScalingLimits) reference the KMBTransform object (mMBTransform). As a result, a change made with one of the KFbxLimits objects (or the corresponding methods) will affect the respective fields on the other two.

The following example does not show good practice, but does demonstrates how the members of this class are affecting each other :

 // assuming 'this' is a valid KFbxNodeLimits object.

 // Set the translation limits active
 this->SetTranslationLimitActive(false); 

 // overwrite the translation limits (from active to inactive). 
 // rotation limits correctly set to inactive and scaling limits set to active too! 
 this->mRotationLimits.SetLimitMinActive(false, false, true); 

 // The following now returns true even though we never explicitly set 
 // the flags from the mScalingLimit object. 
 this->GetScalingLimitActive() 

Definition at line 216 of file kfbxnodelimits.h.

Node Translation Limits
KFbxLimits	mTranslationLimits
	The translation limits.
void	SetTranslationLimitActive (bool pActive)
	Change the translation limit active flag.
bool	GetTranslationLimitActive () const
	Get the translation limit active flag.
Node Rotation Limits
KFbxLimits	mRotationLimits
	The rotation limits.
void	SetRotationLimitActive (bool pActive)
	Change the rotation limit active flag.
bool	GetRotationLimitActive () const
	Get the rotation limit active flag.
Node Scale Limits
KFbxLimits	mScalingLimits
	The scaling limits.
void	SetScalingLimitActive (bool pActive)
	Change the scaling limit active flag.
bool	GetScalingLimitActive () const
	Get the scaling limit active flag.
Public Member Functions
	KFbxNodeLimits (KFbxNode *pLimitedNode, KMBTransform *pMBTransform)
	Constructor.
KFbxNode *	GetLimitedNode ()
	Get the limited node.

---

Constructor & Destructor Documentation

KFbxNodeLimits	(	KFbxNode *	pLimitedNode,
		KMBTransform *	pMBTransform
	)

Constructor.

Parameters:

	pLimitedNode	Pointer to the node to which these limits apply.
	pMBTransform	Refer to comments in KFbxLimits. The object contains the actual data for all limits of transform components.

---

Member Function Documentation

KFbxNode* GetLimitedNode

(

)

Get the limited node.

Returns:

Pointer to the node to which these limits apply. This node is the same pointer as the one passed to the constructor.

void SetTranslationLimitActive

(

bool

pActive

)

Change the translation limit active flag.

Parameters:

pActive

State of the translation limits active flag.

Remarks:

If this flag is set to false, the values in the mTranslationLimits are ignored.

bool GetTranslationLimitActive

(

)

const

Get the translation limit active flag.

Returns:

Translation limit active flag state.

Remarks:

If this flag is false, the values in the mTranslationLimits are ignored.

void SetRotationLimitActive

(

bool

pActive

)

Change the rotation limit active flag.

Parameters:

pActive

State of the rotation limits active flag.

Remarks:

If this flag is set to false, the values in the mRotationLimits are ignored.

bool GetRotationLimitActive

(

)

const

Get the rotation limit active flag.

Returns:

Rotation limit active flag state.

Remarks:

If this flag is false, the values in the mRotationLimits are ignored.

void SetScalingLimitActive

(

bool

pActive

)

Change the scaling limit active flag.

Parameters:

pActive

State of the scaling limits active flag.

Remarks:

If this flag is set to false, the values in the mScalingLimits are ignored.

bool GetScalingLimitActive

(

)

const

Get the scaling limit active flag.

Returns:

Scaling limit active flag state.

Remarks:

If this flag is false, the values in the mScalingLimits are ignored.

---

Member Data Documentation

KFbxLimits mTranslationLimits

The translation limits.

Definition at line 251 of file kfbxnodelimits.h.

KFbxLimits mRotationLimits

The rotation limits.

Definition at line 273 of file kfbxnodelimits.h.

KFbxLimits mScalingLimits

The scaling limits.

Definition at line 295 of file kfbxnodelimits.h.