This reference page is linked to from the following overview topics: Cameras, Supported Scene Elements, FBX SDK 2014, List of Python Fbx classes, FBX Node Attributes, Lights.

#include <fbxmarker.h>

Class Description

This node attribute contains the properties of a marker.

A FbxMarker can represent a motion capture marker or a HIK IK/FK effector.

Examples:: ExportScene04/main.cxx, ImportScene/DisplayMarker.cxx, and UI_Examples/CubeCreator/SDK_Utility.cxx.

Definition at line 26 of file fbxmarker.h.

Inheritance diagram for FbxMarker:

List of all members.

Public Types
enum	EType { eStandard, eOptical, eEffectorFK, eEffectorIK }
	Marker types. More...
enum	ELook { eCube, eHardCross, eLightCross, eSphere, eCapsule, eBox, eBone, eCircle, eSquare, eStick, eNone }
	Marker look. More...
Public Member Functions
virtual FbxNodeAttribute::EType	GetAttributeType () const
	Return the type of node attribute which is EType::eMarker.
void	Reset ()
	Reset the marker to default values.
void	SetType (EType pType)
	Set marker type.
EType	GetType () const
	Get marker type.
FbxProperty	GetOcclusion () const
	This method grants access to the occlusion property.
FbxProperty	GetIKReachTranslation () const
	This method grants access to the IKReachTranslation property.
FbxProperty	GetIKReachRotation () const
	This method grants access to the IKReachRotation property.
FbxProperty	GetIKPull () const
	This method grants access to the IKPull property.
FbxProperty	GetIKPullHips () const
	This method grants access to the IKPullHips property.
Public Attributes
FbxPropertyT< ELook >	Look
	This property handles the marker's look.
FbxPropertyT< FbxBool >	DrawLink
	This property handles the marker's link visibility.
FbxPropertyT< FbxDouble >	Size
	This property handles the marker's size.
FbxPropertyT< FbxBool >	ShowLabel
	This property handles the marker's label visibility.
FbxPropertyT< FbxDouble3 >	IKPivot
	This property handles the marker's pivot position.
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.
double	GetDefaultIKPull () const
	Get default IK pull.
void	SetDefaultIKPull (double pIKPull)
	Set default IK pull.
double	GetDefaultIKPullHips () const
	Get default IK pull hips.
void	SetDefaultIKPullHips (double pIKPullHips)
	Set default IK pull hips.
Obsolete functions
FbxColor &	GetDefaultColor (FbxColor &pColor) const
	Get default color.
void	SetDefaultColor (FbxColor &pColor)
	Set default color.

Member Enumeration Documentation

enum EType

Search for all occurrences

Marker types.

eStandard
eOptical
eEffectorFK
eEffectorIK

Enumerator:

eStandard	Search for all occurrences
eOptical	Search for all occurrences
eEffectorFK	Search for all occurrences
eEffectorIK	Search for all occurrences

Reimplemented from FbxNodeAttribute.

Definition at line 43 of file fbxmarker.h.

        {
                eStandard, 
                eOptical, 
                eEffectorFK,
                eEffectorIK
        };

enum ELook

Search for all occurrences

Marker look.

eCube
eHardCross
eLightCross
eSphere
eCapsule
eBox
eBone
eCircle
eSquare
eStick
eNone

Enumerator:

eCube	Search for all occurrences
eHardCross	Search for all occurrences
eLightCross	Search for all occurrences
eSphere	Search for all occurrences
eCapsule	Search for all occurrences
eBox	Search for all occurrences
eBone	Search for all occurrences
eCircle	Search for all occurrences
eSquare	Search for all occurrences
eStick	Search for all occurrences
eNone	No flags. Search for all occurrences

Definition at line 74 of file fbxmarker.h.

        { 
                eCube, 
                eHardCross, 
                eLightCross, 
        eSphere,
        eCapsule,
        eBox,
        eBone,
        eCircle,
        eSquare,
        eStick,
                eNone
        };

Member Function Documentation

virtual FbxNodeAttribute::EType GetAttributeType ( ) const [virtual]

Search for all occurrences

Return the type of node attribute which is EType::eMarker.

Reimplemented from FbxNodeAttribute.

void Reset ( )

Search for all occurrences

Reset the marker to default values.

void SetType ( EType pType )

Search for all occurrences

Set marker type.

Parameters:

pType The type of marker.

EType GetType ( ) const

Search for all occurrences

Get marker type.

Returns:: The type of the marker.

Examples:: ImportScene/DisplayMarker.cxx.

double GetDefaultOcclusion ( ) const

Search for all occurrences

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 FbxMarker::eOptical.

void SetDefaultOcclusion ( double pOcclusion )

Search for all occurrences

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 FbxMarker::eOptical.

double GetDefaultIKReachTranslation ( ) const

Search for all occurrences

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 FbxMarker::eEffectorIK.

void SetDefaultIKReachTranslation ( double pIKReachTranslation )

Search for all occurrences

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 FbxMarker::eEffectorIK.

double GetDefaultIKReachRotation ( ) const

Search for all occurrences

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 FbxMarker::eEffectorIK.

void SetDefaultIKReachRotation ( double pIKReachRotation )

Search for all occurrences

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 FbxMarker::eEffectorIK.

double GetDefaultIKPull ( ) const

Search for all occurrences

Get default IK pull.

Returns:: A value between 0.0 and 100.0, 100.0 means complete IK pull.

Remarks:: This function only works if marker type is set to FbxMarker::eIK_EFFECTOR.

void SetDefaultIKPull ( double pIKPull )

Search for all occurrences

Set default IK pull.

Parameters:

pIKPull A value between 0.0 and 100.0, 100.0 means complete IK pull.

Remarks:: This function only works if marker type is set to FbxMarker::eIK_EFFECTOR.

double GetDefaultIKPullHips ( ) const

Search for all occurrences

Get default IK pull hips.

Returns:: A value between 0.0 and 100.0, 100.0 means complete IK pull.

Remarks:: This function only works if marker type is set to FbxMarker::eIK_EFFECTOR.

void SetDefaultIKPullHips ( double pIKPullHips )

Search for all occurrences

Set default IK pull hips.

Parameters:

pIKPull A value between 0.0 and 100.0, 100.0 means complete IK pull.

Remarks:: This function only works if marker type is set to FbxMarker::eIK_EFFECTOR.

FbxColor& GetDefaultColor ( FbxColor & pColor ) const

Search for all occurrences

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 ( FbxColor & pColor )

Search for all occurrences

Set default color.

Parameters:

pColor The marker color to be set.

Remarks:: Marker color can not be animated anymore.

FbxProperty GetOcclusion ( ) const

Search for all occurrences

This method grants access to the occlusion property.

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

FbxProperty GetIKReachTranslation ( ) const

Search for all occurrences

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

FbxProperty GetIKReachRotation ( ) const

Search for all occurrences

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

FbxProperty GetIKPull ( ) const

Search for all occurrences

This method grants access to the IKPull property.

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

FbxProperty GetIKPullHips ( ) const

Search for all occurrences

This method grants access to the IKPullHips property.

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

Member Data Documentation

FbxPropertyT<ELook> Look

Search for all occurrences

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

Examples:: ImportScene/DisplayMarker.cxx.

Definition at line 194 of file fbxmarker.h.

FbxPropertyT<FbxBool> DrawLink

Search for all occurrences

This property handles the marker's link visibility.

To access this property do: DrawLink.Get(). To set this property do: DrawLink.Set(FbxBool).

Default value is true

Definition at line 203 of file fbxmarker.h.

FbxPropertyT<FbxDouble> Size

Search for all occurrences

This property handles the marker's size.

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

Default value is 100

Examples:: ImportScene/DisplayMarker.cxx.

Definition at line 212 of file fbxmarker.h.

FbxPropertyT<FbxBool> ShowLabel

Search for all occurrences

This property handles the marker's label visibility.

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

Default value is false

Definition at line 221 of file fbxmarker.h.

FbxPropertyT<FbxDouble3> IKPivot

Search for all occurrences

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.)

Examples:: ImportScene/DisplayMarker.cxx.

Definition at line 230 of file fbxmarker.h.

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

fbxsdk/scene/geometry/fbxmarker.h

Class Description

Public Types

Public Member Functions

Public Attributes

Default Animation Values

Obsolete functions

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation