#include <mobu-python-api.h>

Class Description

Pose class.

Inheritance diagram for FBPose:

Public Member Functions
	__reduce__ ()

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

int	AddNode (FBPose arg1, FBModel arg2, FBMatrix arg3, object arg4)
	Add a new pose node. More...

int	Find (FBPose arg1, str arg2)
	Look in this pose if the given node is present. More...

int	GetNodeCount (FBPose arg1)
	Returns the number of pose nodes stored. More...

FBMatrix	GetNodeMatrix (FBPose arg1, object arg2)
	Get the pose node matrix. More...

str	GetNodeName (FBPose arg1, object arg2)
	Get the pose node at specified index. More...

object	GetNodeObject (FBPose arg1, object arg2)
	Get the pose node object. More...

bool	IsNodeLocalMatrix (FBPose arg1, object arg2)
	Get the type of the Matrix for a given node. More...

	RemoveNode (FBPose arg1, object arg2)
	Remove the pose node at specified index. More...

	SetIsNodeLocalMatrix (FBPose arg1, object arg2, object arg3)
	Set the type of the Matrix for a given node. More...

	SetNodeMatrix (FBPose arg1, object arg2, FBMatrix arg3)
	Set the pose node matrix. More...

	SetNodeObject (FBPose arg1, object arg2, FBModel arg3)
	Set the pose node object. More...

	CreatePoseThumbnail (FBPose arg1)
	Create an image thumbnail for the current pose. 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__ (...)

Public Attributes
FBPropertyPoseType	Type
	Read Only Property: Type of the pose (bind pose or rest pose) More...

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:

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

Parameters

pName	Name of pose.
pObject	For internal use only (default=NULL).

See the C++ reference

__reduce__ ( )

int AddNode	(	FBPose	arg1,
		FBModel	arg2,
		FBMatrix	arg3,
		object	arg4
	)

Add a new pose node.

Python Docstring:

AddNode( (FBPose)arg1, (FBModel)arg2 [, (FBMatrix)arg3 [, (object)arg4]]) -> int

C++ Signature:

int AddNode(ORSDK2018::FBModel * pObject, ORSDK2018::FBMatrix * pMatrix = ((void *) 0), bool pIsLocalMatrix = false)

Parameters

pObject	The object for which we are creating the pose information.
pMatrix	The transformation of the object we want to save.
pIsLocalMatrix	Is the matrix a local matrix?

See the C++ reference

CreatePoseThumbnail ( FBPose arg1 )

Create an image thumbnail for the current pose.

Python Docstring:

CreatePoseThumbnail( (FBPose)arg1) -> None

C++ Signature:

void CreatePoseThumbnail()

See the C++ reference

int Find	(	FBPose	arg1,
		str	arg2
	)

Look in this pose if the given node is present.

Python Docstring:

Find( (FBPose)arg1, (str)arg2) -> int

C++ Signature:

int Find(ORSDK2018::FBString pNodeName)

Parameters

pNodeName Name of the node we are looking for.

Returns: -1 if the node is not in the list or it's position.

See the C++ reference

int GetNodeCount ( FBPose arg1 )

Returns the number of pose nodes stored.

Python Docstring:

GetNodeCount( (FBPose)arg1) -> int

C++ Signature:

int GetNodeCount()

See the C++ reference

FBMatrix GetNodeMatrix	(	FBPose	arg1,
		object	arg2
	)

Get the pose node matrix.

Python Docstring:

GetNodeMatrix( (FBPose)arg1, (object)arg2) -> FBMatrix

C++ Signature:

ORSDK2018::FBMatrix GetNodeMatrix(int pIndex)

Parameters

pIndex Index of the node.

Returns: a reference to the node's Matrix.

Remarks: if the index is invalid a reference to an identiy matrix is returned.; The reference will become undefined if this object is destroyed.

See the C++ reference

str GetNodeName	(	FBPose	arg1,
		object	arg2
	)

Get the pose node at specified index.

Python Docstring:

GetNodeName( (FBPose)arg1, (object)arg2) -> str

C++ Signature:

ORSDK2018::FBString GetNodeName(int pIndex)

Parameters

pIndex Index of the node.

Remarks: if the index is invalid a reference to an empty string is returned.; The reference will become undefined if this object is destroyed.

See the C++ reference

object GetNodeObject	(	FBPose	arg1,
		object	arg2
	)

Get the pose node object.

Python Docstring:

GetNodeObject( (FBPose)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBModel * GetNodeObject(int pIndex)

Parameters

pIndex Index of the node.

Returns: a pointer to the node's Object.

Remarks: if the index is invalid a null pointer is returned.

See the C++ reference

bool IsNodeLocalMatrix	(	FBPose	arg1,
		object	arg2
	)

Get the type of the Matrix for a given node.

Python Docstring:

IsNodeLocalMatrix( (FBPose)arg1, (object)arg2) -> bool

C++ Signature:

bool IsNodeLocalMatrix(int pIndex)

Parameters

pIndex Index of the node.

Returns: true if the matrix is defined in Local coordinate space.

Remarks: If this object is configured to hold BindPose data, this method will always return false.

See the C++ reference

RemoveNode	(	FBPose	arg1,
		object	arg2
	)

Remove the pose node at specified index.

Python Docstring:

RemoveNode( (FBPose)arg1, (object)arg2) -> None

C++ Signature:

void RemoveNode(int pIndex)

Parameters

pIndex Index of the node to be removed.

See the C++ reference

SetIsNodeLocalMatrix	(	FBPose	arg1,
		object	arg2,
		object	arg3
	)

Set the type of the Matrix for a given node.

Python Docstring:

SetIsNodeLocalMatrix( (FBPose)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void SetIsNodeLocalMatrix(int pIndex, bool pIsNodeLocalMatrix)

Parameters

pIndex	Index of the node.
pIsNodeLocalMatrix	True if the matrix of the node is a local matrix.

See the C++ reference

SetNodeMatrix	(	FBPose	arg1,
		object	arg2,
		FBMatrix	arg3
	)

Set the pose node matrix.

Python Docstring:

SetNodeMatrix( (FBPose)arg1, (object)arg2, (FBMatrix)arg3) -> None

C++ Signature:

void SetNodeMatrix(int pIndex, ORSDK2018::FBMatrix * pMatrix)

Parameters

pIndex	Index of the node.
pMatrix	Matrix to set for this pose node.

See the C++ reference

SetNodeObject	(	FBPose	arg1,
		object	arg2,
		FBModel	arg3
	)

Set the pose node object.

Python Docstring:

SetNodeObject( (FBPose)arg1, (object)arg2, (FBModel)arg3) -> None

C++ Signature:

void SetNodeObject(int pIndex, ORSDK2018::FBModel * pObject)

Parameters

pIndex	Index of the node.
pObject	Object to associate with this pose node.

See the C++ reference

Member Data Documentation

FBPropertyPoseType Type

Read Only Property: Type of the pose (bind pose or rest pose)

See the C++ reference

FBPose Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation