Marker set class. More...

#include <fbcharacter.h>

Inheritance diagram for FBMarkerSet:

[legend]

Public Member Functions
	FBMarkerSet (const char *pName, HIObject pObject=NULL)
	Constructor.

FBModel *	GetReferenceModel ()
	Get the reference model associated with this marker set.

void	SetReferenceModel (FBModel *pReferenceModel)
	Associate a model to a marker.

FBModel *	GetMarkerModel (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.

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)

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.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual 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.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Marker set class.

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

Definition at line 603 of file fbcharacter.h.

Constructor & Destructor Documentation

◆ FBMarkerSet()

FBMarkerSet	(	const 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

◆ AddMarker()

int AddMarker	(	FBSkeletonNodeId	pNodeId,
		FBModel *	pModel = `NULL`,
		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()

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.

◆ EndTransaction()

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.

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

const char * 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()

void 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.

Return values

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

void 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.

Return values

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

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

void SetMarkerName	(	FBSkeletonNodeId	pNodeId,
		int	pMarkerIndex,
		const char *	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()

void 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.

◆ SetMarkerSetVisibility()

void SetMarkerSetVisibility ( bool pVisibility )

Set the marker set visibility.

Parameters

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

◆ SetMarkerUsed()

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

void SetReferenceModel ( FBModel * pReferenceModel )

Associate a model to a marker.

Parameters

pReferenceModel Model to be associated to the marker.

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

fbcharacter.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBMarkerSet()

Member Function Documentation

◆ AddMarker()

◆ BeginTransaction()

◆ EndTransaction()

◆ GetLinkToModelOk()

◆ GetMarkerCount()

◆ GetMarkerModel()

◆ GetMarkerName()

◆ GetMarkerOriented()

◆ GetMarkerROffset()

◆ GetMarkerSetVisibility()

◆ GetMarkerTOffset()

◆ GetMarkerUsed()

◆ GetReferenceModel()

◆ GetUsedMarkerCount()

◆ SetMarkerModel()

◆ SetMarkerName()

◆ SetMarkerOriented()

◆ SetMarkerSetVisibility()

◆ SetMarkerUsed()

◆ SetMultipleMarkerModels()

◆ SetReferenceModel()