#include <mobu-python-api.h>

Class Description

Control set class.

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

Inheritance diagram for FBControlSet:

Public Member Functions
	__reduce__ ()

object	GetReferenceModel (FBControlSet arg1)
	Get the reference model associated with this Control Set. More...

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

str	GetReferenceName (FBControlSet arg1)
	Get the reference name associated with this Control Set. More...

int	GetIKEffectorIndex (FBControlSet arg1, FBModel arg2)
	Return the Index of the Given Model. More...

object	GetIKEffectorModel (FBControlSet arg1, FBEffectorId arg2, object arg3)
	Return the object associated to the given Index. More...

int	GetIKEffectorPivotCount (FBControlSet arg1, FBEffectorId arg2)
	return the number of IK Effector Slot More...

str	GetIKEffectorName (FBControlSet arg1, FBEffectorId arg2)
	return the name of IK Effector More...

int	GetFKIndex (FBControlSet arg1, FBModel arg2)
	Return The Index of the Given Model. More...

object	GetFKModel (FBControlSet arg1, FBBodyNodeId arg2)
	Return the object associated to the given Index. More...

str	GetFKName (FBControlSet arg1, FBBodyNodeId arg2)
	return the name of FK Effector at the given index 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
FBPropertyBool	UseAxis
	Read Write Property: is using axis. More...

FBPropertyControlSetType	ControlSetType
	Read Property: the control Set Type (FKIK or IK). 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:

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

Parameters

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

See the C++ reference

__reduce__ ( )

int GetFKIndex	(	FBControlSet	arg1,
		FBModel	arg2
	)

Return The Index of the Given Model.

Python Docstring:

GetFKIndex( (FBControlSet)arg1, (FBModel)arg2) -> int

C++ Signature:

int GetFKIndex(ORSDK2018::FBModel * pModel)

Parameters

pModel Given Model to obtain Index

Returns: The Index of the Given Model.

See the C++ reference

object GetFKModel	(	FBControlSet	arg1,
		FBBodyNodeId	arg2
	)

Return the object associated to the given Index.

Python Docstring:

GetFKModel( (FBControlSet)arg1, (FBBodyNodeId)arg2) -> object

C++ Signature:

ORSDK2018::FBModel * GetFKModel(int pIndex)

Parameters

pIndex Given Index to obtain Model

Returns: return the model at the specified Index.

See the C++ reference

str GetFKName	(	FBControlSet	arg1,
		FBBodyNodeId	arg2
	)

return the name of FK Effector at the given index

Python Docstring:

GetFKName( (FBControlSet)arg1, (FBBodyNodeId)arg2) -> str

C++ Signature:

const char * GetFKName(int pIndex)

Parameters

pIndex Given Index

Returns: return the name of IK Effector Slot

See the C++ reference

int GetIKEffectorIndex	(	FBControlSet	arg1,
		FBModel	arg2
	)

Return the Index of the Given Model.

Python Docstring:

GetIKEffectorIndex( (FBControlSet)arg1, (FBModel)arg2) -> int

C++ Signature:

int GetIKEffectorIndex(ORSDK2018::FBModel * pModel)

Parameters

pModel Given Model to Obtain Index

Returns: The Index of the Given Model.

See the C++ reference

object GetIKEffectorModel	(	FBControlSet	arg1,
		FBEffectorId	arg2,
		object	arg3
	)

Return the object associated to the given Index.

Python Docstring:

GetIKEffectorModel( (FBControlSet)arg1, (FBEffectorId)arg2, (object)arg3) -> object

C++ Signature:

ORSDK2018::FBModel * GetIKEffectorModel(FBEffectorId pEffectorIndex, int pPivotIndex = 0)

Parameters

pEffectorIndex	Given Index to obtain Model
pPivotIndex	Index of effector pivot

Returns: return the model at the specified Index.

See the C++ reference

str GetIKEffectorName	(	FBControlSet	arg1,
		FBEffectorId	arg2
	)

return the name of IK Effector

Python Docstring:

GetIKEffectorName( (FBControlSet)arg1, (FBEffectorId)arg2) -> str

C++ Signature:

const char * GetIKEffectorName(FBEffectorId pEffectorIndex)

Parameters

pEffectorIndex Given Index to obtain Name

Returns: the name of IK Effector

See the C++ reference

int GetIKEffectorPivotCount	(	FBControlSet	arg1,
		FBEffectorId	arg2
	)

return the number of IK Effector Slot

Python Docstring:

GetIKEffectorPivotCount( (FBControlSet)arg1, (FBEffectorId)arg2) -> int

C++ Signature:

int GetIKEffectorPivotCount(FBEffectorId pEffectorIndex)

Returns: return the number of IK Effector Slot

See the C++ reference

object GetReferenceModel ( FBControlSet arg1 )

Get the reference model associated with this Control Set.

Python Docstring:

GetReferenceModel( (FBControlSet)arg1) -> object

C++ Signature:

ORSDK2018::FBModel * GetReferenceModel()

Returns: The reference model associated with the Control Set.

See the C++ reference

str GetReferenceName ( FBControlSet arg1 )

Get the reference name associated with this Control Set.

Python Docstring:

GetReferenceName( (FBControlSet)arg1) -> str

C++ Signature:

const char * GetReferenceName()

Returns: The reference name associated with the Control Set.

See the C++ reference

Member Data Documentation

FBPropertyControlSetType ControlSetType

Read Property: the control Set Type (FKIK or IK).

See the C++ reference

FBPropertyBool UseAxis

Read Write Property: is using axis.

See the C++ reference

FBControlSet Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation