KFbxLimits
#include<kfbxnodelimits.h>

List of all members.

Detailed Description

KFbxLimitsdefines a 3 component min, max limit.

KFbxLimitsusesKFbxVector4objects to store the 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.

Definition at line78of filekfbxnodelimits.h.


Public Member Functions

 KFbxLimits(KMBTransform *pMBTransform=NULL)
 Constructor.
virtual ~KFbxLimits()
 Destructor.
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(constKFbxVector4&pMin)
 Set the min limit.
KFbxVector4 GetLimitMin() const
 Get the min limit.
void SetLimitMax(constKFbxVector4&pMax)
 Set the max limit.
KFbxVector4 GetLimitMax() const
 Get the max limit.
void SetLimitedProperty(ELimitedPropertypProperty)
 Set the property that is limited.
ELimitedProperty GetLimitedProperty()
 Get the property that is limited.

Constructor&Destructor Documentation

KFbxLimits(KMBTransform * pMBTransform=NULL ) 

Constructor.

virtual ~KFbxLimits( ) [virtual]

Destructor.

Member Function Documentation

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

Set the active state of min limit.

Parameters:
pXActive Set totrue, to activate the X component min limit.
pYActive Set totrue, to activate the Y component min limit.
pZActive Set totrue, to activate the Z component min limit.

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

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

Parameters:
pXActive trueif the X component of the min limit is active.
pYActive trueif the Y component of the min limit is active.
pZActive trueif the Z component of the min limit is active.

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

Set the active state of max limit.

Parameters:
pXActive Set totrue, to activate the X component max limit.
pYActive Set totrue, to activate the Y component max limit.
pZActive Set totrue, to activate the Z component max limit.

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

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

Parameters:
pXActive trueif the X component of the max limit is active.
pYActive trueif the Y component of the max limit is active.
pZActive trueif the Z component of the max limit is active.

bool GetLimitSomethingActive( ) const

Check if at least one of the active flags is set.

Returns:
trueif one of the six active flags is set.

void SetLimitMin(constKFbxVector4pMin ) 

Set the min limit.

Parameters:
pMin The X, Y and Z values to be set for the min limit.

KFbxVector4GetLimitMin( ) const

Get the min limit.

Returns:
The current X, Y and Z values for the min limit.

void SetLimitMax(constKFbxVector4pMax ) 

Set the max limit.

Parameters:
pMax The X, Y and Z values to be set for the max limit.

KFbxVector4GetLimitMax( ) const

Get the max limit.

Returns:
The current X, Y and Z values for the max limit.

void SetLimitedProperty(ELimitedProperty pProperty ) [inline]

Set the property that is limited.

Parameters:
pProperty The limited property

Definition at line144of filekfbxnodelimits.h.

ELimitedPropertyGetLimitedProperty( ) [inline]

Get the property that is limited.

Returns:
The current limited property

Definition at line152of filekfbxnodelimits.h.