KFbxMarker Class Reference

#include <kfbxmarker.h>

Inherits KFbxNodeAttribute.

Inheritance diagram for KFbxMarker:

Inheritance graph
List of all members.

Detailed Description

This node attribute contains the properties of a marker.

Definition at line 67 of file kfbxmarker.h.

Default Animation Values

This set of functions provides direct access to default animation values specific to a marker.

The default animation values are found in the default take node of the associated node. Hence, these functions only work if the marker has been associated with a node.

double GetDefaultOcclusion () const
 Get default occlusion.
void SetDefaultOcclusion (double pOcclusion)
 Set default occlusion.
double GetDefaultIKReachTranslation () const
 Get default IK reach translation.
void SetDefaultIKReachTranslation (double pIKReachTranslation)
 Set default IK reach translation.
double GetDefaultIKReachRotation () const
 Get default IK reach rotation.
void SetDefaultIKReachRotation (double pIKReachRotation)
 Set default IK reach rotation.

Obsolete functions

KFbxColor & GetDefaultColor (KFbxColor &pColor) const
 Get default color.
void SetDefaultColor (KFbxColor &pColor)
 Set default color.

Public Types

enum  EType
 Marker types. More...
enum  ELook
 Marker look. More...

Public Member Functions

virtual EAttributeType GetAttributeType () const
 Return the type of node attribute which is EAttributeType::eMARKER.
void Reset ()
 Reset the marker to default values.
void SetType (EType pType)
 Set marker type.
EType GetType () const
 Get marker type.
void SetLook (ELook pLook)
 Set marker look.
ELook GetLook () const
 Get marker look.
void SetSize (double pSize)
 Set marker size.
double GetSize () const
 Get marker size.
void SetColor (KFbxColor pColor)
 Set marker color.
KFbxColor GetColor () const
 Get marker color.
void SetShowLabel (bool pShowLabel)
 Set whether a marker label is shown.
bool GetShowLabel () const
 Get whether a marker label is shown.
void SetIKPivot (KFbxVector4 &pIKPivot)
 Set the IK pivot position.
KFbxVector4 GetIKPivot () const
 Get the IK pivot position.

Member Enumeration Documentation

enum EType

Marker types.

  • eSTANDARD
  • eOPTICAL
  • eIK_EFFECTOR
  • eFK_EFFECTOR

Definition at line 84 of file kfbxmarker.h.

enum ELook

Marker look.

  • eCUBE
  • eHARD_CROSS
  • eLIGHT_CROSS
  • eSHPERE

Definition at line 107 of file kfbxmarker.h.

Member Function Documentation

virtual EAttributeType GetAttributeType (  )  const [virtual]

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

Reimplemented from KFbxNodeAttribute.

void Reset (  ) 

Reset the marker to default values.

void SetType ( EType  pType  ) 

Set marker type.

Parameters:
pType The type of marker.

EType GetType (  )  const

Get marker type.

Returns:
The type of the marker.

void SetLook ( ELook  pLook  ) 

Set marker look.

Parameters:
pLook The look of the marker.

ELook GetLook (  )  const

Get marker look.

Returns:
The look of the marker.

void SetSize ( double  pSize  ) 

Set marker size.

Parameters:
pSize The size of the marker.

double GetSize (  )  const

Get marker size.

Returns:
The currently set marker size.

void SetColor ( KFbxColor  pColor  ) 

Set marker color.

Parameters:
pColor The color used to display the marker.

Reimplemented from KFbxNodeAttribute.

KFbxColor GetColor (  )  const

Get marker color.

Returns:
The marker color.

void SetShowLabel ( bool  pShowLabel  ) 

Set whether a marker label is shown.

Parameters:
pShowLabel If set to true the marker label is visible.

bool GetShowLabel (  )  const

Get whether a marker label is shown.

Returns:
true if the marker label is visible.

void SetIKPivot ( KFbxVector4 &  pIKPivot  ) 

Set the IK pivot position.

Parameters:
pIKPivot The translation in local coordinates.

KFbxVector4 GetIKPivot (  )  const

Get the IK pivot position.

Returns:
The pivot position vector.

double GetDefaultOcclusion (  )  const

Get default occlusion.

Returns:
0.0 if optical marker animation is valid by default, 1.0 if it is occluded by default.
Remarks:
This function only works if marker type is set to KFbxMarker::eOPTICAL.

void SetDefaultOcclusion ( double  pOcclusion  ) 

Set default occlusion.

Parameters:
pOcclusion 0.0 if optical marker animation is valid by default, 1.0 if it is occluded by default.
Remarks:
This function only works if marker type is set to KFbxMarker::eOPTICAL.

double GetDefaultIKReachTranslation (  )  const

Get default IK reach translation.

Returns:
A value between 0.0 and 100.0, 100.0 means complete IK reach.
Remarks:
This function only works if marker type is set to KFbxMarker::eIK_EFFECTOR.

void SetDefaultIKReachTranslation ( double  pIKReachTranslation  ) 

Set default IK reach translation.

Parameters:
pIKReachTranslation A value between 0.0 and 100.0, 100.0 means complete IK reach.
Remarks:
This function only works if marker type is set to KFbxMarker::eIK_EFFECTOR.

double GetDefaultIKReachRotation (  )  const

Get default IK reach rotation.

Returns:
A value between 0.0 and 100.0, 100.0 means complete IK reach.
Remarks:
This function only works if marker type is set to KFbxMarker::eIK_EFFECTOR.

void SetDefaultIKReachRotation ( double  pIKReachRotation  ) 

Set default IK reach rotation.

Parameters:
pIKReachRotation A value between 0.0 and 100.0, 100.0 means complete IK reach.
Remarks:
This function only works if marker type is set to KFbxMarker::eIK_EFFECTOR.

KFbxColor& GetDefaultColor ( KFbxColor &  pColor  )  const

Get default color.

Returns:
Input parameter filled with appropriate data.
Remarks:
Marker color can not be animated anymore.

void SetDefaultColor ( KFbxColor &  pColor  ) 

Set default color.

Remarks:
Marker color can not be animated anymore.