FBMarkerSet Class Reference

FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet FBMarkerSet
Inheritance diagram for FBMarkerSet:
Inheritance graph
[legend]

List of all members.


Detailed Description

Marker set class.

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


Public Member Functions

  FBMarkerSet (str pName)
  Constructor.
int  AddMarker (FBSkeletonNodeId pNodeId, FBModel pModel=None, bool pIsOriented=False)
  Add a marker to the marker set.
  BeginTransaction ()
  Specify that you are about to call a group of functions.
  EndTransaction ()
  Specify that you are done calling a group of functions.
bool  GetLinkToModelOk ()
  Get the marker set association correctness.
int  GetMarkerCount (FBSkeletonNodeId pNodeId=kFBSkeletonInvalidIndex)
  Get the number of marker in the set.
FBModel  GetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex)
  Get the model associated with a marker.
str  GetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex)
  Get the name of marker at index pMarkerIndex.
bool  GetMarkerOriented (FBSkeletonNodeId pNodeId, int pMarkerIndex)
  Is marker orientated ?
  GetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector pROffset)
  Get/Set a marker rotation.
int  GetMarkerSetVisibility ()
  Get the marker set visibility.
  GetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector pTOffset)
  Get/Set a marker translation.
bool  GetMarkerUsed (FBSkeletonNodeId pNodeId, int pMarkerIndex)
  Is marker used ?
FBModel  GetReferenceModel ()
  Get the reference model associated with this marker set.
int  GetUsedMarkerCount (FBSkeletonNodeId pNodeId=kFBSkeletonInvalidIndex)
  Get the number of used marker in the set.
  SetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBModel pModel)
  Associate a model to a marker.
  SetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex, str pMarkerName)
  Set the name of marker at index pMarkerIndex.
  SetMarkerOriented (FBSkeletonNodeId pNodeId, int pMarkerIndex, bool pIsOriented)
  Set marker to be oriented or not.
  SetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector pROffset)
  Get/Set a marker rotation.
  SetMarkerSetVisibility (bool pVisibility)
  Set the marker set visibility.
  SetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector pTOffset)
  Get/Set a marker translation.
  SetMarkerUsed (FBSkeletonNodeId pNodeId, int pMarkerIndex, bool pUsed)
  Set marker to be used or not.
bool  SetMultipleMarkerModels (FBModelList pModelList)
  Associate multiple models to markers, matching them by name.
  SetReferenceModel (FBModel pReferenceModel)
  Associate a model to a marker.

Constructor & Destructor Documentation

FBMarkerSet ( str  pName  ) 

Constructor.

Parameters:
pName  Name of new marker set.

Member Function Documentation

int AddMarker ( FBSkeletonNodeId  pNodeId,
FBModel  pModel = None,
bool  pIsOriented = False  
)

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).
Returns:
Index of the new marker.

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.

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.

bool GetLinkToModelOk (  ) 

Get the marker set association correctness.

Returns:
True if all used markers are link with models.

int GetMarkerCount ( FBSkeletonNodeId  pNodeId = kFBSkeletonInvalidIndex  ) 

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.

FBModel GetMarkerModel ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex  
)

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.

str GetMarkerName ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex  
)

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.

bool GetMarkerOriented ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex  
)

Is marker orientated ?

Parameters:
pNodeId  Id of Actor body node.
pMarkerIndex  Index of marker to access.
Returns:
True if marker is oriented, false otherwise.

GetMarkerROffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBRVector  pROffset  
)

Get/Set a marker rotation.

Parameters:
pNodeId  Id of Actor skeleton node.
pMarkerIndex  Index of marker to access.
pROffset  Current or new value of the marker rotation.

int GetMarkerSetVisibility (  ) 

Get the marker set visibility.

Returns:
1 if all markers are visible, 2 if some are visible, 0 if none are visible.

GetMarkerTOffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBTVector  pTOffset  
)

Get/Set a marker translation.

Parameters:
pNodeId  Id of Actor skeleton node.
pMarkerIndex  Index of marker to access.
pTOffset  Current or new value of the marker translation.

bool GetMarkerUsed ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex  
)

Is marker used ?

Parameters:
pNodeId  Id of Actor skeleton node.
pMarkerIndex  Index of marker to access.
Returns:
True if marker is used, false otherwise.

FBModel GetReferenceModel (  ) 

Get the reference model associated with this marker set.

Returns:
The reference model associated with the marker set.

int GetUsedMarkerCount ( FBSkeletonNodeId  pNodeId = kFBSkeletonInvalidIndex  ) 

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.

SetMarkerModel ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBModel  pModel  
)

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.

SetMarkerName ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
str  pMarkerName  
)

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.

SetMarkerOriented ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
bool  pIsOriented  
)

Set marker to be oriented or not.

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

SetMarkerROffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBRVector  pROffset  
)

Get/Set a marker rotation.

Parameters:
pNodeId  Id of Actor skeleton node.
pMarkerIndex  Index of marker to access.
pROffset  Current or new value of the marker rotation.

SetMarkerSetVisibility ( bool  pVisibility  ) 

Set the marker set visibility.

Parameters:
pVisibility  True will make to markers visible, false will hide them.

SetMarkerTOffset ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
FBTVector  pTOffset  
)

Get/Set a marker translation.

Parameters:
pNodeId  Id of Actor skeleton node.
pMarkerIndex  Index of marker to access.
pTOffset  Current or new value of the marker translation.

SetMarkerUsed ( FBSkeletonNodeId  pNodeId,
int  pMarkerIndex,
bool  pUsed  
)

Set marker to be used or not.

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

bool SetMultipleMarkerModels ( FBModelList  pModelList  ) 

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.

SetReferenceModel ( FBModel  pReferenceModel  ) 

Associate a model to a marker.

Parameters:
pReferenceModel  Model to be associated to the marker.

Generated on Tue Feb 9 19:34:26 2010 for Python Reference Guide by  doxygen 1.5.3