Public Member Functions | Friends

KFbxNodeLimits Class Reference

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


Search for all occurrences

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.

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() 
Examples:

ImportScene/DisplayPivotsAndLimits.cxx.

Definition at line 174 of file kfbxnodelimits.h.

#include <kfbxnodelimits.h>

List of all members.

Public Member Functions

  KFbxNodeLimits (KFbxNode *pLimitedNode)
  Constructor.
KFbxNode GetLimitedNode ()
  Get the limited node.
KFbxNodeLimits operator= (KFbxNodeLimits const &pNodeLimits)
KMBLimit *  GetRLimit ()

Friends

class  KFbxNode

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.

Constructor & Destructor Documentation

KFbxNodeLimits ( KFbxNode pLimitedNode )

Constructor.

Parameters:
pLimitedNode Pointer to the node to which these limits apply.

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.
Examples:
ExportScene05/main.cxx.
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.
Examples:
ImportScene/DisplayPivotsAndLimits.cxx.
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.
Examples:
ImportScene/DisplayPivotsAndLimits.cxx.
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.
Examples:
ImportScene/DisplayPivotsAndLimits.cxx.
KFbxNodeLimits& operator= ( KFbxNodeLimits const &  pNodeLimits )
KMBLimit* GetRLimit ( ) [inline]

Definition at line 250 of file kfbxnodelimits.h.

{ return mRotationLimits.mLimit; }

Friends And Related Function Documentation

friend class KFbxNode [friend]

Definition at line 255 of file kfbxnodelimits.h.


Member Data Documentation

The translation limits.

Examples:
ExportScene05/main.cxx, and ImportScene/DisplayPivotsAndLimits.cxx.

Definition at line 205 of file kfbxnodelimits.h.

The rotation limits.

Examples:
ExportScene05/main.cxx, and ImportScene/DisplayPivotsAndLimits.cxx.

Definition at line 225 of file kfbxnodelimits.h.

The scaling limits.

Examples:
ImportScene/DisplayPivotsAndLimits.cxx.

Definition at line 245 of file kfbxnodelimits.h.


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

KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits
KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits KFbxNodeLimits