#include<kfbxmarker.h>

Inheritance diagram for KFbxMarker:

[legend]

List of all members.

Detailed Description

This node attribute contains the properties of a marker.

Definition at line59of filekfbxmarker.h.

Property Names
static const char *	sLook
static const char *	sSize
static const char *	sShowLabel
static const char *	sIKPivot
Property Default Values
static constELook	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
	Marker types.More...
enum	ELook
	Marker look.More...
Public Member Functions
virtualEAttributeType	GetAttributeType() const
	Return the type of node attribute which is EAttributeType::eMARKER.
void	Reset()
	Reset the marker to default values.
void	SetType(ETypepType)
	Set marker type.
EType	GetType() const
	Get marker type.
K_DEPRECATED void	SetLook(ELookpLook)
	Set marker look.
K_DEPRECATEDELook	GetLook() const
	Get marker look.
K_DEPRECATED void	SetSize(double pSize)
	Set marker size.
K_DEPRECATED double	GetSize() const
	Get marker size.
K_DEPRECATED void	SetShowLabel(bool pShowLabel)
	Set whether a marker label is shown.
K_DEPRECATED bool	GetShowLabel() const
	Get whether a marker label is shown.
K_DEPRECATED void	SetIKPivot(KFbxVector4&pIKPivot)
	Set the IK pivot position.
K_DEPRECATEDKFbxVector4	GetIKPivot() const
	Get the IK pivot position.

Member Enumeration Documentation

enumEType

Marker types.

• eSTANDARD
• eOPTICAL
• eFK_EFFECTOR
• eIK_EFFECTOR

Definition at line76of filekfbxmarker.h.

enumELook

Marker look.

• eCUBE
• eHARD_CROSS
• eLIGHT_CROSS
• eSPHERE

Definition at line99of filekfbxmarker.h.

Member Function Documentation

virtualEAttributeTypeGetAttributeType

(

)

const[virtual]

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

Reimplemented fromKFbxNodeAttribute.

void Reset

(

)

Reset the marker to default values.

void SetType

(

EType

pType

)

Set marker type.

Parameters:

pType

The type of marker.

ETypeGetType

(

)

const

Get marker type.

Returns:

The type of the marker.

K_DEPRECATED void SetLook

(

ELook

pLook

)

Set marker look.

Parameters:

pLook

The look of the marker.

Remarks:

This function is deprecated. Use property SetLook.Set(pLook) instead.

K_DEPRECATEDELookGetLook

(

)

const

Get marker look.

Returns:

The look of the marker.

Remarks:

This function is deprecated. Use property SetLook.Get() instead.

K_DEPRECATED void SetSize

(

double

pSize

)

Set marker size.

Parameters:

pSize

The size of the marker.

Remarks:

This function is deprecated. Use property Size.Set(pSize) instead.

K_DEPRECATED double GetSize

(

)

const

Get marker size.

Returns:

The currently set marker size.

Remarks:

This function is deprecated. Use property Size.Get() instead.

K_DEPRECATED void SetShowLabel

(

bool

pShowLabel

)

Set whether a marker label is shown.

Parameters:

pShowLabel

If set totruethe marker label is visible.

Remarks:

This function is deprecated. Use property ShowLabel.Set(pShowLabel) instead.

K_DEPRECATED bool GetShowLabel

(

)

const

Get whether a marker label is shown.

Returns:

trueif the marker label is visible.

Remarks:

This function is deprecated. Use property ShowLabel.Get() instead.

K_DEPRECATED void SetIKPivot

(

KFbxVector4&

pIKPivot

)

Set the IK pivot position.

Parameters:

pIKPivot

The translation in local coordinates.

Remarks:

This function is deprecated. Use property IKPivot.Set(pIKPivot) instead.

K_DEPRECATEDKFbxVector4GetIKPivot

(

)

const

Get the IK pivot position.

Returns:

The pivot position vector.

Remarks:

This function is deprecated. Use property IKPivot.Get() instead.

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

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 line251of filekfbxmarker.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 line260of filekfbxmarker.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 line269of filekfbxmarker.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 line278of filekfbxmarker.h.