KFbxLodGroup Class Reference

#include <kfbxlodgroup.h>
Inheritance diagram for KFbxLodGroup:
Inheritance graph
[legend]

List of all members.


Detailed Description

This node attribute contains the properties of a null node.

Definition at line 54 of file kfbxlodgroup.h.


Public Types

enum   EDisplayLevel
  types. More...

Public Member Functions

virtual EAttributeType  GetAttributeType () const
  Return the type of node attribute which is EAttributeType::eLODGROUP.
int  GetNumThresholds () const
  Get the size of the threshold list.
bool  AddThreshold (fbxDistance pThreshValue)
  Add a new threshold value to the current list.
bool  SetThreshold (int pEl, fbxDistance pThreshValue)
  Set the threshold value for the specified object.
bool  GetThreshold (int pEl, fbxDistance &pThreshValue)
  Get the threshold value for the specified object.
int  GetNumDisplayLevels () const
  Get the size of the displayLevel list.
bool  AddDisplayLevel (KFbxLodGroup::EDisplayLevel pValue)
  Add a new displayLevel value to the current list.
bool  SetDisplayLevel (int pEl, KFbxLodGroup::EDisplayLevel pValue)
  Set the display level value for the specified object.
bool  GetDisplayLevel (int pEl, KFbxLodGroup::EDisplayLevel &pValue)
  Get the display level value for the specified object.

Public Attributes

KFbxTypedProperty< fbxBool1 >  MinMaxDistance
  This property handles the use of the Min/Max distances.
KFbxTypedProperty< fbxDouble1 >  MinDistance
  This property handles the Min distance value.
KFbxTypedProperty< fbxDouble1 >  MaxDistance
  This property handles the Max distance value.
KFbxTypedProperty< fbxBool1 >  WorldSpace
  This property handles the WorldSpace flag.

Member Enumeration Documentation

types.

  • eUseLOD
  • eShow
  • eHide

Definition at line 67 of file kfbxlodgroup.h.


Member Function Documentation

virtual EAttributeType GetAttributeType (  )  const [virtual]

Return the type of node attribute which is EAttributeType::eLODGROUP.

Reimplemented from KFbxNodeAttribute.

int GetNumThresholds (  )  const

Get the size of the threshold list.

Returns:
The current size of the threshold list.

bool AddThreshold ( fbxDistance  pThreshValue  ) 

Add a new threshold value to the current list.

Parameters:
pThreshValue  Threshold distance from the previous entry in the threshold list
Remarks:
This list can only expand so the only way to shrink it, is to completely destroy this object.

This method does not check the received values and blindly add them to the list. Therefore duplicated values can exist in different positions in the list.

Returns:
true if successful and false if any error occurred.

bool SetThreshold ( int  pEl,
fbxDistance  pThreshValue  
)

Set the threshold value for the specified object.

Parameters:
pEl  The index of the object we want to set the threshold.
pThreshValue  Threshold distance from the previous entry in the threshold list
Returns:
true if successful and false if the specified index is invalid.

bool GetThreshold ( int  pEl,
fbxDistance pThreshValue  
)

Get the threshold value for the specified object.

Parameters:
pEl  The index of the object we want to get the threshold.
pThreshValue  the current threshold value.
Returns:
true if successfull and false if the specified index is invalid.
Remarks:
in case of a failure, the pThreshValue is left unchanged.

int GetNumDisplayLevels (  )  const

Get the size of the displayLevel list.

Returns:
The current size of the displayLevel list.

bool AddDisplayLevel ( KFbxLodGroup::EDisplayLevel  pValue  ) 

Add a new displayLevel value to the current list.

Parameters:
pValue  Display level value
Remarks:
This list can only expand so the only way to shrink it, is to completely destroy this object.

This method does not check the received values and blindly add them to the list. Therefore duplicated values can exist in different positions in the list.

Returns:
true if successful and false if any error occurred.

bool SetDisplayLevel ( int  pEl,
KFbxLodGroup::EDisplayLevel  pValue  
)

Set the display level value for the specified object.

Parameters:
pEl  The index of the object we want to set the display level.
pValue  New display level value
Returns:
true if successful and false if the specified index is invalid.

bool GetDisplayLevel ( int  pEl,
KFbxLodGroup::EDisplayLevel pValue  
)

Get the display level value for the specified object.

Parameters:
pEl  The index of the object we want to get the display level value.
pValue  the current display level value.
Returns:
true if successfull and false if the specified index is invalid.
Remarks:
in case of a failure, the pValue is left unchanged.

Member Data Documentation

This property handles the use of the Min/Max distances.

To access this property do: MinMaxDistance.Get(). To set this property do: MinMaxDistance.Set(bool).

Default value is false.

Definition at line 86 of file kfbxlodgroup.h.

This property handles the Min distance value.

To access this property do: MinDistance.Get(). To set this property do: MinDistance.Set(double).

Default value is -100

Definition at line 95 of file kfbxlodgroup.h.

This property handles the Max distance value.

To access this property do: MaxDistance.Get(). To set this property do: MaxDistance.Set(double).

Default value is 100

Definition at line 104 of file kfbxlodgroup.h.

This property handles the WorldSpace flag.

To access this property do: WorldSpace.Get(). To set this property do: WorldSpace.Set(bool).

Default value is false

Definition at line 113 of file kfbxlodgroup.h.

KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup
KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup KFbxLodGroup