FBMarkerSet Class Reference

Marker set class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBMarkerSet:

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)
	SetMarkerSetVisibility (bool pVisibility)
	Set the marker set visibility.
	SetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector pTOffset)
	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.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Additional Inherited Members
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Marker set class.

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

Constructor & Destructor Documentation

FBMarkerSet()

FBMarkerSet

(

str

pName

)

Constructor.

Parameters

pName

Name of new marker set.

Member Function Documentation

AddMarker()

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()

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()

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.

GetLinkToModelOk()

bool GetLinkToModelOk

(

)

Get the marker set association correctness.

Returns

True if all used markers are link with models.

GetMarkerCount()

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.

GetMarkerModel()

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.

GetMarkerName()

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.

GetMarkerOriented()

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()

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.

GetMarkerSetVisibility()

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()

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.

GetMarkerUsed()

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.

GetReferenceModel()

FBModel GetReferenceModel

(

)

Get the reference model associated with this marker set.

Returns

The reference model associated with the marker set.

GetUsedMarkerCount()

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()

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()

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()

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()

SetMarkerROffset	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		FBRVector	pROffset
	)

SetMarkerSetVisibility()

SetMarkerSetVisibility

(

bool

pVisibility

)

Set the marker set visibility.

Parameters

pVisibility

True will make to markers visible, false will hide them.

SetMarkerTOffset()

SetMarkerTOffset	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		FBTVector	pTOffset
	)

SetMarkerUsed()

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.

SetMultipleMarkerModels()

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()

SetReferenceModel

(

FBModel

pReferenceModel

)

Associate a model to a marker.

Parameters

pReferenceModel

Model to be associated to the marker.