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

Detailed Description

This node attribute contains the properties of a marker.

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

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

Definition at line 33 of file kfbxmarker.h.

#include <kfbxmarker.h>

Inheritance diagram for KFbxMarker:

[legend]

List of all members.

Public Types
enum	EType { eSTANDARD, eOPTICAL, eFK_EFFECTOR, eIK_EFFECTOR }
	Marker types. More...
enum	ELook { eCUBE, eHARD_CROSS, eLIGHT_CROSS, eSPHERE, eCAPSULE, eBOX, eBONE, eCIRCLE, eSQUARE, eSTICK, eNONE }
	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.
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.
Property Names
static const char *	sLook
static const char *	sDrawLink
static const char *	sSize
static const char *	sShowLabel
static const char *	sIKPivot
Property Default Values
static const ELook	sDefaultLook
static const fbxBool1	sDefaultDrawLink
static const fbxDouble1	sDefaultSize
static const fbxBool1	sDefaultShowLabel
static const fbxDouble3	sDefaultIKPivot
KFbxTypedProperty< ELook >	Look
	This property handles the marker's look.
KFbxTypedProperty< fbxBool1 >	DrawLink
	This property handles the marker's link visibility.
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.
EType	mType
KFbxProperty	dynProp
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.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
	KFbxMarker (KFbxSdkManager &pManager, char const *pName)
virtual void	Construct (const KFbxMarker *pFrom)
virtual bool	ConstructProperties (bool pForceSet)
void	Reset (bool pResetProperties)
virtual const char *	GetTypeName () const
	Used to retrieve the KProperty list from an attribute.
virtual KStringList	GetTypeFlags () const

Member Enumeration Documentation

enum EType

Search for all occurrences

Marker types.

eSTANDARD
eOPTICAL
eFK_EFFECTOR
eIK_EFFECTOR

Enumerator:

eSTANDARD	Search for all occurrences
eOPTICAL	Search for all occurrences
eFK_EFFECTOR	Search for all occurrences
eIK_EFFECTOR	Search for all occurrences

Definition at line 50 of file kfbxmarker.h.

                 { 
        eSTANDARD, 
        eOPTICAL, 
        eFK_EFFECTOR,
        eIK_EFFECTOR
    } EType;

enum ELook

Search for all occurrences

Marker look.

eCUBE
eHARD_CROSS
eLIGHT_CROSS
eSPHERE
eCAPSULE
eBOX
eBONE
eCIRCLE
eSQUARE
eSTICK
eNONE

Enumerator:

eCUBE	Search for all occurrences
eHARD_CROSS	Search for all occurrences
eLIGHT_CROSS	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	Search for all occurrences

Definition at line 80 of file kfbxmarker.h.

                 { 
        eCUBE, 
        eHARD_CROSS, 
        eLIGHT_CROSS, 
        eSPHERE,
        eCAPSULE,
        eBOX,
        eBONE,
        eCIRCLE,
        eSQUARE,
        eSTICK,
        eNONE
    } ELook;

Constructor & Destructor Documentation

KFbxMarker	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Member Function Documentation

virtual EAttributeType GetAttributeType ( ) const [virtual]

Search for all occurrences

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

Reimplemented from KFbxNodeAttribute.

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 KFbxMarker::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 KFbxMarker::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 KFbxMarker::eIK_EFFECTOR.

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 KFbxMarker::eIK_EFFECTOR.

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 KFbxMarker::eIK_EFFECTOR.

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 KFbxMarker::eIK_EFFECTOR.

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

Search for all occurrences

Set default color.

Parameters:

pColor The marker color to be set.

Remarks:: Marker color can not be animated anymore.

KFbxProperty* GetOcclusion ( )

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

KFbxProperty* GetIKReachTranslation ( )

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

KFbxProperty* GetIKReachRotation ( )

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

virtual KFbxObject& Copy ( const KFbxObject & pObject ) [virtual]

Search for all occurrences

Copy an object content into this object.

Parameters:

pObject The source object to copy data from.

Returns:: Returns the destination object being modified by the source.

Remarks:: This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from KFbxObject.

virtual void Construct ( const KFbxMarker * pFrom ) [protected, virtual]

Search for all occurrences

virtual bool ConstructProperties ( bool pForceSet ) [protected, virtual]

Search for all occurrences

Reimplemented from KFbxNodeAttribute.

void Reset ( bool pResetProperties ) [protected]

Search for all occurrences

virtual const char* GetTypeName ( ) const [protected, virtual]

Search for all occurrences

Used to retrieve the KProperty list from an attribute.

Reimplemented from KFbxObject.

virtual KStringList GetTypeFlags ( ) const [protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

Member Data Documentation

const char* sLook [static]

Search for all occurrences

Definition at line 165 of file kfbxmarker.h.

const char* sDrawLink [static]

Search for all occurrences

Definition at line 166 of file kfbxmarker.h.

const char* sSize [static]

Search for all occurrences

Definition at line 167 of file kfbxmarker.h.

const char* sShowLabel [static]

Search for all occurrences

Definition at line 168 of file kfbxmarker.h.

const char* sIKPivot [static]

Search for all occurrences

Definition at line 169 of file kfbxmarker.h.

const ELook sDefaultLook [static]

Search for all occurrences

Definition at line 174 of file kfbxmarker.h.

const fbxBool1 sDefaultDrawLink [static]

Search for all occurrences

Definition at line 175 of file kfbxmarker.h.

const fbxDouble1 sDefaultSize [static]

Search for all occurrences

Definition at line 176 of file kfbxmarker.h.

const fbxBool1 sDefaultShowLabel [static]

Search for all occurrences

Definition at line 177 of file kfbxmarker.h.

const fbxDouble3 sDefaultIKPivot [static]

Search for all occurrences

Definition at line 178 of file kfbxmarker.h.

KFbxTypedProperty<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 193 of file kfbxmarker.h.

KFbxTypedProperty<fbxBool1> 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(fbxBool1).

Default value is false

Definition at line 202 of file kfbxmarker.h.

KFbxTypedProperty<fbxDouble1> 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(fbxDouble1).

Default value is 100

Examples:: ImportScene/DisplayMarker.cxx.

Definition at line 211 of file kfbxmarker.h.

KFbxTypedProperty<fbxBool1> 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(fbxBool1).

Default value is false

Definition at line 220 of file kfbxmarker.h.

KFbxTypedProperty<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 229 of file kfbxmarker.h.

EType mType [protected]

Search for all occurrences

Definition at line 277 of file kfbxmarker.h.

KFbxProperty dynProp [protected]

Search for all occurrences

Definition at line 279 of file kfbxmarker.h.

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

fbxfilesdk/kfbxplugins/kfbxmarker.h

KFbxMarker Class Reference

Detailed Description

Public Types

Public Member Functions

Default Animation Values

Obsolete functions

Property Names

Property Default Values

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation