KFbxMarker Class Reference

#include <kfbxmarker.h>
Inheritance diagram for KFbxMarker:
Inheritance graph
[legend]

List of all members.

Detailed Description

This node attribute contains the properties of a marker.

Definition at line 54 of file kfbxmarker.h.


Property Names
static const char *  sLook
static const char *  sSize
static const char *  sShowLabel
static const char *  sIKPivot

Property Default Values
static const ELook  sDefaultLook
static const fbxDouble1  sDefaultSize
static const fbxBool1  sDefaultShowLabel
static const fbxDouble3  sDefaultIKPivot
KFbxTypedProperty< ELook >  Look
  This property handles the marker's look.
KFbxTypedProperty< fbxDouble1 >  Size
  This property handles the marker's size.
KFbxTypedProperty< fbxBool1 >  ShowLabel
  This property handles the marker's label visibility.
KFbxTypedProperty< fbxDouble3 >  IKPivot
  This property handles the marker's pivot position.
KFbxProperty *  GetOcclusion ()
  This method grants access to the occlusion property.
KFbxProperty *  GetIKReachTranslation ()
  This method grants access to the IKReachTranslation property.
KFbxProperty *  GetIKReachRotation ()
  This method grants access to the IKReachRotation property.

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 {
   eSTANDARD,
   eOPTICAL,
   eFK_EFFECTOR,
   eIK_EFFECTOR
}
  Marker types. More...
enum   ELook {
   eCUBE,
   eHARD_CROSS,
   eLIGHT_CROSS,
   eSPHERE
}
  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.

Member Enumeration Documentation

enum EType

Marker types.

  • eSTANDARD
  • eOPTICAL
  • eFK_EFFECTOR
  • eIK_EFFECTOR
Enumerator:
eSTANDARD 
eOPTICAL 
eFK_EFFECTOR 
eIK_EFFECTOR 

Definition at line 71 of file kfbxmarker.h.

enum ELook

Marker look.

  • eCUBE
  • eHARD_CROSS
  • eLIGHT_CROSS
  • eSPHERE
Enumerator:
eCUBE 
eHARD_CROSS 
eLIGHT_CROSS 
eSPHERE 

Definition at line 94 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.

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.

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

void SetDefaultColor ( KFbxColor &  pColor  ) 

Set default color.

Parameters:
pColor  The marker color to be set.
Remarks:
Marker color can not be animated anymore.

KFbxProperty* GetOcclusion (  ) 

This method grants access to the occlusion property.

Remarks:
If the marker is not of type Optical or the property is invalid, return NULL

KFbxProperty* GetIKReachTranslation (  ) 

This method grants access to the IKReachTranslation property.

Remarks:
If the marker is not of type IK Effector or the property is invalid, return NULL

KFbxProperty* GetIKReachRotation (  ) 

This method grants access to the IKReachRotation property.

Remarks:
If the marker is not of type IK Effector or the property is invalid, return NULL

Member Data Documentation

const char* sLook [static]

Definition at line 172 of file kfbxmarker.h.

const char* sSize [static]

Definition at line 173 of file kfbxmarker.h.

const char* sShowLabel [static]

Definition at line 174 of file kfbxmarker.h.

const char* sIKPivot [static]

Definition at line 175 of file kfbxmarker.h.

const ELook sDefaultLook [static]

Definition at line 180 of file kfbxmarker.h.

const fbxDouble1 sDefaultSize [static]

Definition at line 181 of file kfbxmarker.h.

const fbxBool1 sDefaultShowLabel [static]

Definition at line 182 of file kfbxmarker.h.

const fbxDouble3 sDefaultIKPivot [static]

Definition at line 183 of file kfbxmarker.h.

KFbxTypedProperty<ELook> Look

This property handles the marker's look.

To access this property do: Look.Get(). To set this property do: Look.Set(ELook).

Default value is eCUBE

Definition at line 198 of file kfbxmarker.h.

KFbxTypedProperty<fbxDouble1> Size

This property handles the marker's size.

To access this property do: Size.Get(). To set this property do: Size.Set(fbxDouble1).

Default value is 100

Definition at line 207 of file kfbxmarker.h.

KFbxTypedProperty<fbxBool1> ShowLabel

This property handles the marker's label visibility.

To access this property do: ShowLabel.Get(). To set this property do: ShowLabel.Set(fbxBool1).

Default value is false

Definition at line 216 of file kfbxmarker.h.

KFbxTypedProperty<fbxDouble3> IKPivot

This property handles the marker's pivot position.

To access this property do: IKPivot.Get(). To set this property do: IKPivot.Set(fbxDouble3).

Default value is (0., 0., 0.)

Definition at line 225 of file kfbxmarker.h.

KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker
KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker KFbxMarker