#include <mobu-python-api.h>

Class Description

Marker set class.

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

Inheritance diagram for FBMarkerSet:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1, str arg2)
	Constructor. More...

int	AddMarker (FBMarkerSet arg1, FBSkeletonNodeId arg2, FBModel arg3, object arg4)
	Add a marker to the marker set. More...

	BeginTransaction (FBMarkerSet arg1)
	Specify that you are about to call a group of functions. More...

	EndTransaction (FBMarkerSet arg1)
	Specify that you are done calling a group of functions. More...

int	GetMarkerCount (FBMarkerSet arg1, FBSkeletonNodeId arg2)
	Get the number of marker in the set. More...

object	GetMarkerModel (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3)
	Get the model associated with a marker. More...

str	GetMarkerName (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3)
	Get the name of marker at index pMarkerIndex. More...

bool	GetMarkerOriented (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3)
	Is marker orientated ? More...

	GetMarkerROffset (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, FBVector3d arg4)
	Get/Set a marker rotation. More...

	GetMarkerTOffset (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, FBVector3d arg4)
	Get/Set a marker translation. More...

bool	GetMarkerUsed (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3)
	Is marker used ? More...

object	GetReferenceModel (FBMarkerSet arg1)
	Get the reference model associated with this marker set. More...

int	GetUsedMarkerCount (FBMarkerSet arg1, FBSkeletonNodeId arg2)
	Get the number of used marker in the set. More...

	SetMarkerModel (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, FBModel arg4)
	Associate a model to a marker. More...

	SetMarkerName (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, str arg4)
	Set the name of marker at index pMarkerIndex. More...

	SetMarkerOriented (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, object arg4)
	Set marker to be oriented or not. More...

	SetMarkerROffset (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, FBVector3d arg4)

	SetMarkerTOffset (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, FBVector3d arg4)

	SetMarkerUsed (FBMarkerSet arg1, FBSkeletonNodeId arg2, object arg3, object arg4)
	Set marker to be used or not. More...

bool	SetMultipleMarkerModels (FBMarkerSet arg1, FBModelList arg2)
	Associate multiple models to markers, matching them by name. More...

	SetReferenceModel (FBMarkerSet arg1, FBModel arg2)
	Associate a model to a marker. More...

	SetMarkerSetVisibility (FBMarkerSet arg1, object arg2)
	Set the marker set visibility. More...

int	GetMarkerSetVisibility (FBMarkerSet arg1)
	Get the marker set visibility. More...

bool	GetLinkToModelOk (FBMarkerSet arg1)
	Get the marker set association correctness. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Additional Inherited Members
Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None

C++ Signature:

 FBMarkerSet(const char * pName, HIObject pObject = ((void *) 0))

Parameters

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

See the C++ reference

__reduce__ ( )

int AddMarker	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		FBModel	arg3,
		object	arg4
	)

Add a marker to the marker set.

Python Docstring:

AddMarker( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2 [, (FBModel)arg3 [, (object)arg4]]) -> int

C++ Signature:

int AddMarker(FBSkeletonNodeId pNodeId, ORSDK2018::FBModel * pModel = ((void *) 0), bool pIsOriented = false)

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.

See the C++ reference

BeginTransaction ( FBMarkerSet arg1 )

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

Python Docstring:

BeginTransaction( (FBMarkerSet)arg1) -> None

C++ Signature:

void BeginTransaction()

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

See the C++ reference

EndTransaction ( FBMarkerSet arg1 )

Specify that you are done calling a group of functions.

Python Docstring:

EndTransaction( (FBMarkerSet)arg1) -> None

C++ Signature:

void EndTransaction()

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

See the C++ reference

bool GetLinkToModelOk ( FBMarkerSet arg1 )

Get the marker set association correctness.

Python Docstring:

GetLinkToModelOk( (FBMarkerSet)arg1) -> bool

C++ Signature:

bool GetLinkToModelOk()

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

See the C++ reference

int GetMarkerCount	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2
	)

Get the number of marker in the set.

Python Docstring:

GetMarkerCount( (FBMarkerSet)arg1 [, (FBSkeletonNodeId)arg2]) -> int

C++ Signature:

int GetMarkerCount(FBSkeletonNodeId pNodeId = kFBSkeletonInvalidIndex)

Parameters

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

Returns: Total number of marker.

See the C++ reference

object GetMarkerModel	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3
	)

Get the model associated with a marker.

Python Docstring:

GetMarkerModel( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3) -> object

C++ Signature:

ORSDK2018::FBModel * GetMarkerModel(FBSkeletonNodeId pNodeId, int pMarkerIndex)

Parameters

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

Returns: The model associated with the marker.

See the C++ reference

str GetMarkerName	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3
	)

Get the name of marker at index pMarkerIndex.

Python Docstring:

GetMarkerName( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3) -> str

C++ Signature:

const char * GetMarkerName(FBSkeletonNodeId pNodeId, int pMarkerIndex)

Parameters

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

Returns: Name of marker at index pMarkerIndex.

See the C++ reference

bool GetMarkerOriented	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3
	)

Is marker orientated ?

Python Docstring:

GetMarkerOriented( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3) -> bool

C++ Signature:

bool GetMarkerOriented(FBSkeletonNodeId pNodeId, int pMarkerIndex)

Parameters

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

Returns: True if marker is oriented, false otherwise.

See the C++ reference

GetMarkerROffset	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		FBVector3d	arg4
	)

Get/Set a marker rotation.

Python Docstring:

GetMarkerROffset( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (FBVector3d)arg4) -> None

C++ Signature:

void GetMarkerROffset(FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector * pROffset)

Parameters

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

Return values

pROffset Current or new value of the marker rotation.

See the C++ reference

int GetMarkerSetVisibility ( FBMarkerSet arg1 )

Get the marker set visibility.

Python Docstring:

GetMarkerSetVisibility( (FBMarkerSet)arg1) -> int

C++ Signature:

int GetMarkerSetVisibility()

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

See the C++ reference

GetMarkerTOffset	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		FBVector3d	arg4
	)

Get/Set a marker translation.

Python Docstring:

GetMarkerTOffset( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (FBVector3d)arg4) -> None

C++ Signature:

void GetMarkerTOffset(FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector * pTOffset)

Parameters

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

Return values

pTOffset Current or new value of the marker translation.

See the C++ reference

bool GetMarkerUsed	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3
	)

Is marker used ?

Python Docstring:

GetMarkerUsed( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3) -> bool

C++ Signature:

bool GetMarkerUsed(FBSkeletonNodeId pNodeId, int pMarkerIndex)

Parameters

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

Returns: True if marker is used, false otherwise.

See the C++ reference

object GetReferenceModel ( FBMarkerSet arg1 )

Get the reference model associated with this marker set.

Python Docstring:

GetReferenceModel( (FBMarkerSet)arg1) -> object

C++ Signature:

ORSDK2018::FBModel * GetReferenceModel()

Returns: The reference model associated with the marker set.

See the C++ reference

int GetUsedMarkerCount	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2
	)

Get the number of used marker in the set.

Python Docstring:

GetUsedMarkerCount( (FBMarkerSet)arg1 [, (FBSkeletonNodeId)arg2]) -> int

C++ Signature:

int GetUsedMarkerCount(FBSkeletonNodeId pNodeId = kFBSkeletonInvalidIndex)

Parameters

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

Returns: Total number of used marker.

See the C++ reference

SetMarkerModel	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		FBModel	arg4
	)

Associate a model to a marker.

Python Docstring:

SetMarkerModel( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (FBModel)arg4) -> None

C++ Signature:

void SetMarkerModel(FBSkeletonNodeId pNodeId, int pMarkerIndex, ORSDK2018::FBModel * pModel)

Parameters

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

See the C++ reference

SetMarkerName	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		str	arg4
	)

Set the name of marker at index pMarkerIndex.

Python Docstring:

SetMarkerName( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (str)arg4) -> None

C++ Signature:

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

Parameters

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

See the C++ reference

SetMarkerOriented	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		object	arg4
	)

Set marker to be oriented or not.

Python Docstring:

SetMarkerOriented( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (object)arg4) -> None

C++ Signature:

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

Parameters

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

See the C++ reference

SetMarkerROffset	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		FBVector3d	arg4
	)

Python Docstring:

SetMarkerROffset( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (FBVector3d)arg4) -> None

C++ Signature:

void SetMarkerROffset(FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector * pROffset)

See the C++ reference

SetMarkerSetVisibility	(	FBMarkerSet	arg1,
		object	arg2
	)

Set the marker set visibility.

Python Docstring:

SetMarkerSetVisibility( (FBMarkerSet)arg1, (object)arg2) -> None

C++ Signature:

void SetMarkerSetVisibility(bool pVisibility)

Parameters

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

See the C++ reference

SetMarkerTOffset	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		FBVector3d	arg4
	)

Python Docstring:

SetMarkerTOffset( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (FBVector3d)arg4) -> None

C++ Signature:

void SetMarkerTOffset(FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector * pTOffset)

See the C++ reference

SetMarkerUsed	(	FBMarkerSet	arg1,
		FBSkeletonNodeId	arg2,
		object	arg3,
		object	arg4
	)

Set marker to be used or not.

Python Docstring:

SetMarkerUsed( (FBMarkerSet)arg1, (FBSkeletonNodeId)arg2, (object)arg3, (object)arg4) -> None

C++ Signature:

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

Parameters

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

See the C++ reference

bool SetMultipleMarkerModels	(	FBMarkerSet	arg1,
		FBModelList	arg2
	)

Associate multiple models to markers, matching them by name.

Python Docstring:

SetMultipleMarkerModels( (FBMarkerSet)arg1, (FBModelList)arg2) -> bool

C++ Signature:

bool SetMultipleMarkerModels(FBModelList * pModelList)

Parameters

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

Returns: True if at least one marker was matched.

See the C++ reference

SetReferenceModel	(	FBMarkerSet	arg1,
		FBModel	arg2
	)

Associate a model to a marker.

Python Docstring:

SetReferenceModel( (FBMarkerSet)arg1, (FBModel)arg2) -> None

C++ Signature:

void SetReferenceModel(ORSDK2018::FBModel * pReferenceModel)

Parameters

pReferenceModel Model to be associated to the marker.

See the C++ reference

FBMarkerSet Class Reference

Class Description

Public Member Functions

Additional Inherited Members

Member Function Documentation