This reference page is linked to from the following overview topics: Character animation.

Detailed Description

Marker set class.

These classes are under development and may change dramatically between versions.

Definition at line 511 of file fbcharacter.h.

#include <fbcharacter.h>

Inheritance diagram for FBMarkerSet:

[legend]

List of all members.

Public Member Functions
	FBMarkerSet (char *pName, HIObject pObject=NULL)
	Constructor.
HFBModel	GetReferenceModel ()
	Get the reference model associated with this marker set.
void	SetReferenceModel (HFBModel pReferenceModel)
	Associate a model to a marker.
HFBModel	GetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex)
	Get the model associated with a marker.
void	SetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex, HFBModel pModel)
	Associate a model to a marker.
bool	SetMultipleMarkerModels (FBModelList *pModelList)
	Associate multiple models to markers, matching them by name.
char *	GetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex)
	Get the name of marker at index pMarkerIndex.
void	SetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex, char *pMarkerName)
	Set the name of marker at index pMarkerIndex.
bool	GetMarkerOriented (FBSkeletonNodeId pNodeId, int pMarkerIndex)
	Is marker orientated ?
void	SetMarkerOriented (FBSkeletonNodeId pNodeId, int pMarkerIndex, bool pIsOriented)
	Set marker to be oriented or not.
bool	GetMarkerUsed (FBSkeletonNodeId pNodeId, int pMarkerIndex)
	Is marker used ?
void	SetMarkerUsed (FBSkeletonNodeId pNodeId, int pMarkerIndex, bool pUsed)
	Set marker to be used or not.
int	GetMarkerCount (FBSkeletonNodeId pNodeId=kFBSkeletonInvalidIndex)
	Get the number of marker in the set.
int	GetUsedMarkerCount (FBSkeletonNodeId pNodeId=kFBSkeletonInvalidIndex)
	Get the number of used marker in the set.
int	AddMarker (FBSkeletonNodeId pNodeId, HFBModel pModel=NULL, bool pIsOriented=false)
	Add a marker to the marker set.
void	SetMarkerSetVisibility (bool pVisibility)
	Set the marker set visibility.
int	GetMarkerSetVisibility ()
	Get the marker set visibility.
bool	GetLinkToModelOk ()
	Get the marker set association correctness.
void	BeginTransaction ()
	Specify that you are about to call a group of functions.
void	EndTransaction ()
	Specify that you are done calling a group of functions.

void	GetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, HFBTVector pTOffset)
	Get/Set a marker translation.
void	SetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, HFBTVector pTOffset)

void	GetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, HFBRVector pROffset)
	Get/Set a marker rotation.
void	SetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, HFBRVector pROffset)

Constructor & Destructor Documentation

FBMarkerSet	(	char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters:

pName	Name of new marker set.
pObject	For internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

HFBModel GetReferenceModel ( )

Search for all occurrences

Get the reference model associated with this marker set.

Returns:: The reference model associated with the marker set.

void SetReferenceModel ( HFBModel pReferenceModel )

Search for all occurrences

Associate a model to a marker.

Parameters:

pReferenceModel Model to be associated to the marker.

HFBModel GetMarkerModel	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex
	)

Search for all occurrences

Get the model associated with a marker.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker.

Returns:: The model associated with the marker.

void SetMarkerModel	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		HFBModel	pModel
	)

Search for all occurrences

Associate a model to a marker.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker.
pModel	Model to be associated to the marker.

bool SetMultipleMarkerModels ( FBModelList * pModelList )

Search for all occurrences

Associate multiple models to markers, matching them by name.

Parameters:

pModelList A list of models to be matched with marker names.

Returns:: True if at least one marker was matched.

char* GetMarkerName	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex
	)

Search for all occurrences

Get the name of marker at index pMarkerIndex.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.

Returns:: Name of marker at index pMarkerIndex.

void SetMarkerName	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		char *	pMarkerName
	)

Search for all occurrences

Set the name of marker at index pMarkerIndex.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.
pMarkerName	New name to give to the marker.

void GetMarkerTOffset	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		HFBTVector	pTOffset
	)

Search for all occurrences

Get/Set a marker translation.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.

Return values:

pTOffset Current or new value of the marker translation.

void SetMarkerTOffset	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		HFBTVector	pTOffset
	)

Search for all occurrences

void GetMarkerROffset	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		HFBRVector	pROffset
	)

Search for all occurrences

Get/Set a marker rotation.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.

Return values:

pROffset Current or new value of the marker rotation.

void SetMarkerROffset	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		HFBRVector	pROffset
	)

Search for all occurrences

bool GetMarkerOriented	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex
	)

Search for all occurrences

Is marker orientated ?

Parameters:

pNodeId	Id of Actor body node.
pMarkerIndex	Index of marker to access.

Returns:: True if marker is oriented, false otherwise.

void SetMarkerOriented	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		bool	pIsOriented
	)

Search for all occurrences

Set marker to be oriented or not.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.
pIsOriented	Oriented or not.

bool GetMarkerUsed	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex
	)

Search for all occurrences

Is marker used ?

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.

Returns:: True if marker is used, false otherwise.

void SetMarkerUsed	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		bool	pUsed
	)

Search for all occurrences

Set marker to be used or not.

Parameters:

pNodeId	Id of Actor skeleton node.
pMarkerIndex	Index of marker to access.
pUsed	Used or not.

int GetMarkerCount ( FBSkeletonNodeId pNodeId = kFBSkeletonInvalidIndex )

Search for all occurrences

Get the number of marker in the set.

Parameters:

pNodeId If specified, obtain the number of marker for the specific node.

Returns:: Total number of marker.

int GetUsedMarkerCount ( FBSkeletonNodeId pNodeId = kFBSkeletonInvalidIndex )

Search for all occurrences

Get the number of used marker in the set.

Parameters:

pNodeId If specified, obtain the number of used marker for the specific node.

Returns:: Total number of used marker.

int AddMarker	(	FBSkeletonNodeId	pNodeId,
		HFBModel	pModel = `NULL`,
		bool	pIsOriented = `false`
	)

Search for all occurrences

Add a marker to the marker set.

Parameters:

pNodeId	Id of Actor skeleton node. For hand, use the "C" index (ex:kFBSkeletonLeftThumbCIndex, kFBSkeletonLeftMiddleCIndex...)
pModel	The model to be associated with the marker (Optional).
pIsOriented	Set marker to be oriented or not (Optional).