Public Member Functions

FBMarkerSet Class Reference

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


Search for all occurrences

Detailed Description

Marker set class.

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

Definition at line 512 of file fbcharacter.h.

#include <fbcharacter.h>

Inheritance diagram for FBMarkerSet:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBMarkerSet (const char *pName, HIObject pObject=NULL)
 Constructor.
FBModelGetReferenceModel ()
 Get the reference model associated with this marker set.
void SetReferenceModel (FBModel *pReferenceModel)
 Associate a model to a marker.
FBModelGetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex)
 Get the model associated with a marker.
void SetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBModel *pModel)
 Associate a model to a marker.
bool SetMultipleMarkerModels (FBModelList *pModelList)
 Associate multiple models to markers, matching them by name.
const char * GetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex)
 Get the name of marker at index pMarkerIndex.
void SetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex, const 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, FBModel *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, FBTVector *pTOffset)
 Get/Set a marker translation.
void SetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector *pTOffset)
void GetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector *pROffset)
 Get/Set a marker rotation.
void SetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector *pROffset)

Constructor & Destructor Documentation

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

Constructor.

Parameters:
pNameName of new marker set.
pObjectFor internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

FBModel* GetReferenceModel ( )

Get the reference model associated with this marker set.

Returns:
The reference model associated with the marker set.
void SetReferenceModel ( FBModel pReferenceModel)

Associate a model to a marker.

Parameters:
pReferenceModelModel to be associated to the marker.
FBModel* GetMarkerModel ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex 
)

Get the model associated with a marker.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker.
Returns:
The model associated with the marker.
void SetMarkerModel ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBModel pModel 
)

Associate a model to a marker.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker.
pModelModel to be associated to the marker.
bool SetMultipleMarkerModels ( FBModelList pModelList)

Associate multiple models to markers, matching them by name.

Parameters:
pModelListA list of models to be matched with marker names.
Returns:
True if at least one marker was matched.
const char* GetMarkerName ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex 
)

Get the name of marker at index pMarkerIndex.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
Returns:
Name of marker at index pMarkerIndex.
void SetMarkerName ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
const char *  pMarkerName 
)

Set the name of marker at index pMarkerIndex.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
pMarkerNameNew name to give to the marker.
void GetMarkerTOffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBTVector pTOffset 
)

Get/Set a marker translation.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
Return values:
pTOffsetCurrent or new value of the marker translation.
void SetMarkerTOffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBTVector pTOffset 
)
void GetMarkerROffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBRVector pROffset 
)

Get/Set a marker rotation.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
Return values:
pROffsetCurrent or new value of the marker rotation.
void SetMarkerROffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBRVector pROffset 
)
bool GetMarkerOriented ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex 
)

Is marker orientated ?

Parameters:
pNodeIdId of Actor body node.
pMarkerIndexIndex of marker to access.
Returns:
True if marker is oriented, false otherwise.
void SetMarkerOriented ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
bool  pIsOriented 
)

Set marker to be oriented or not.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
pIsOrientedOriented or not.
bool GetMarkerUsed ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex 
)

Is marker used ?

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
Returns:
True if marker is used, false otherwise.
void SetMarkerUsed ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
bool  pUsed 
)

Set marker to be used or not.

Parameters:
pNodeIdId of Actor skeleton node.
pMarkerIndexIndex of marker to access.
pUsedUsed or not.
int GetMarkerCount ( FBSkeletonNodeId  pNodeId = kFBSkeletonInvalidIndex)

Get the number of marker in the set.

Parameters:
pNodeIdIf specified, obtain the number of marker for the specific node.
Returns:
Total number of marker.
int GetUsedMarkerCount ( FBSkeletonNodeId  pNodeId = kFBSkeletonInvalidIndex)

Get the number of used marker in the set.

Parameters:
pNodeIdIf specified, obtain the number of used marker for the specific node.
Returns:
Total number of used marker.
int AddMarker ( FBSkeletonNodeId  pNodeId,
FBModel pModel = NULL,
bool  pIsOriented = false 
)

Add a marker to the marker set.

Parameters:
pNodeIdId of Actor skeleton node. For hand, use the "C" index (ex:kFBSkeletonLeftThumbCIndex, kFBSkeletonLeftMiddleCIndex...)
pModelThe model to be associated with the marker (Optional).
pIsOrientedSet marker to be oriented or not (Optional).
Returns:
Index of the new marker.
void SetMarkerSetVisibility ( bool  pVisibility)

Set the marker set visibility.

Parameters:
pVisibilityTrue will make to markers visible, false will hide them.
int GetMarkerSetVisibility ( )

Get the marker set visibility.

Returns:
1 if all markers are visible, 2 if some are visible, 0 if none are visible.
bool GetLinkToModelOk ( )

Get the marker set association correctness.

Returns:
True if all used markers are link with models.
void BeginTransaction ( )

Specify that you are about to call a group of functions.

Remarks:
This is used to speed up operations, the UI won't be refreshed until EndTransaction() is called.
void EndTransaction ( )

Specify that you are done calling a group of functions.

Remarks:
This is used to speed up operations, the UI won't be refreshed until EndTransaction() is called.

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

FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet
FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet