#include <mobu-python-api.h>

Class Description

Base class for constraints.

Inheritance diagram for FBConstraint:

Public Member Functions
	__reduce__ ()

object	AnimationNodeInCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)

object	__copy__ (FBConstraint arg1)

object	AnimationNodeOutCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)
	Animation Node Creations (IN/OUT). More...

object	Clone (FBConstraint arg1)
	Clone the constraint. More...

bool	DeformerBind (FBConstraint arg1, FBModel arg2)
	Bind/Unbind pModel to deformation constraint. More...

bool	DeformerUnBind (FBConstraint arg1, FBModel arg2)

bool	Disable (FBConstraint arg1, FBModel arg2)
	Disable constraint on pModel. More...

	FreezeSRT (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
	Freeze current model state. More...

	FreezeSuggested (FBConstraint arg1)
	Suggest 'freeze'. More...

bool	ReferenceAdd (FBConstraint arg1, object arg2, FBModel arg3)
	Add a reference to a specified group. More...

object	ReferenceGet (FBConstraint arg1, object arg2, object arg3)
	Get a reference. More...

int	ReferenceGetCount (FBConstraint arg1, object arg2)
	Get number of references in a specified group. More...

int	ReferenceGroupAdd (FBConstraint arg1, str arg2, object arg3)
	Add a group of references. More...

int	ReferenceGroupGetCount (FBConstraint arg1)
	Return the number of reference groups. More...

int	ReferenceGroupGetMaxCount (FBConstraint arg1, object arg2)
	Get the maximum number of items that can exist in the reference group in question. More...

str	ReferenceGroupGetName (FBConstraint arg1, object arg2)
	Get the name of the reference group. More...

bool	ReferenceRemove (FBConstraint arg1, object arg2, FBModel arg3)
	Remove a reference to pModel from the group at pGroupIndex. More...

	RemoveAllAnimationNodes (FBConstraint arg1)
	Remove animation nodes. More...

	RestoreModelState (FBConstraint arg1, FBModel arg2)
	Restore the saved model state onto pModel. More...

	SaveModelState (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
	Save current state of pModel. More...

	SetupAllAnimationNodes (FBConstraint arg1)
	Setup animation nodes. More...

	Snap (FBConstraint arg1)
	Function Property: Snap constraint. More...

	SnapSuggested (FBConstraint arg1)
	Suggest 'snap'. More...

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

Public Member Functions inherited from FBBox
	__reduce__ ()

bool	AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
	Destroy an animation node. More...

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

object	AnimationNodeInGet (FBBox arg1)
	Get the (IN/OUT) animation node for this box. More...

bool	AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
	Is the animation node user data? More...

object	AnimationNodeOutGet (FBBox arg1)

int	GetOutConnectorCount (FBBox arg1)
	Get the number of animation node outputs for this box. More...

int	GetInConnectorCount (FBBox arg1)
	Get the number of animation node inputs for this box. More...

object	GetOutConnector (FBBox arg1, object arg2)
	Get the animation node output associated with the given index. More...

object	GetInConnector (FBBox arg1, object arg2)
	Get the animation node input associated with 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	Active
	Read Write Property: Active state. More...

FBPropertyBool	Deformer
	Read Write Property: Is a deformer constraint? More...

ORSDK2018::FBPropertyString	Description
	Read Write Property: Long description of constraint. More...

FBPropertyBool	HasLayout
	Read Write Property: Does the constraint have a layout? More...

FBPropertyBool	Lock
	Read Write Property: Lock state. More...

FBPropertyAnimatableDouble	Weight
	Read Write Property: Weight of constraint. More...

Public Attributes inherited from FBBox
FBPropertyBool	Animatable
	Read Write Property: Is the box animatable. More...

FBPropertyBool	Live
	Read Write Property: Is live? More...

FBPropertyBool	RecordMode
	Read Write Property: Is recording? More...

const char *	UniqueName
	internal Unique name. 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

object __copy__ ( FBConstraint arg1 )

Python Docstring:

__copy__( (FBConstraint)arg1) -> object

__init__ ( ... )

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python

C++ Signature:

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

Parameters

pName	Name of constraint.
pObject	For internal use only (default is NULL).

See the C++ reference

__reduce__ ( )

object AnimationNodeInCreate	(	FBConstraint	arg1,
		object	arg2,
		FBModel	arg3,
		str	arg4
	)

Python Docstring:

AnimationNodeInCreate( (FBConstraint)arg1, (object)arg2, (FBModel)arg3, (str)arg4) -> object

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

ORSDK2018::FBAnimationNode * AnimationNodeInCreate(kReference pUserId, ORSDK2018::FBModel * pModel, const char * pAttribute)
ORSDK2018::FBAnimationNode * AnimationNodeInCreate(kReference pUserId, ORSDK2018::FBProperty * pProperty)

object AnimationNodeOutCreate	(	FBConstraint	arg1,
		object	arg2,
		FBModel	arg3,
		str	arg4
	)

Animation Node Creations (IN/OUT).

Python Docstring:

AnimationNodeOutCreate( (FBConstraint)arg1, (object)arg2, (FBModel)arg3, (str)arg4) -> object

C++ Signature:

ORSDK2018::FBAnimationNode * AnimationNodeOutCreate(kReference pUserId, ORSDK2018::FBModel * pModel, const char * pAttribute)

Used to create the connectors (in or out) on an animation node. This function will return a newly created animation node, connected to the model specified by pModel.

Parameters

pUserId	User specified reference number.
pModel	Model to associate with animation node.
pAttribute	Attribute of model to animate (i.e. Translation, Lcl Translation, etc.)

Returns: Newly created IN/OUT animation node.

See the C++ reference

object Clone ( FBConstraint arg1 )

Clone the constraint.

Python Docstring:

Clone( (FBConstraint)arg1) -> object

C++ Signature:

ORSDK2018::FBConstraint * Clone()

Returns: Newly created (and copied) constraint.

See the C++ reference

bool DeformerBind	(	FBConstraint	arg1,
		FBModel	arg2
	)

Bind/Unbind pModel to deformation constraint.

Python Docstring:

DeformerBind( (FBConstraint)arg1, (FBModel)arg2) -> bool

C++ Signature:

bool DeformerBind(ORSDK2018::FBModel * pModel)

These functions are used for adding/removing a deformation binding to/from pModel if the constraint is a deformation constraint.

Parameters

pModel Model to bind/unbind.

Returns: true if successful.

See the C++ reference

bool DeformerUnBind	(	FBConstraint	arg1,
		FBModel	arg2
	)

Python Docstring:

DeformerUnBind( (FBConstraint)arg1, (FBModel)arg2) -> bool

C++ Signature:

bool DeformerUnBind(ORSDK2018::FBModel * pModel)

See the C++ reference

bool Disable	(	FBConstraint	arg1,
		FBModel	arg2
	)

Disable constraint on pModel.

Python Docstring:

Disable( (FBConstraint)arg1, (FBModel)arg2) -> bool

C++ Signature:

bool Disable(ORSDK2018::FBModel * pModel)

Parameters

pModel Model on which constraint should be disabled.

Returns: true if successful.

See the C++ reference

FreezeSRT	(	FBConstraint	arg1,
		FBModel	arg2,
		object	arg3,
		object	arg4,
		object	arg5
	)

Freeze current model state.

Python Docstring:

FreezeSRT( (FBConstraint)arg1, (FBModel)arg2, (object)arg3, (object)arg4, (object)arg5) -> None

C++ Signature:

void FreezeSRT(ORSDK2018::FBModel * pModel, bool pS, bool pR, bool pT)

Parameters

pModel	Model to freeze constraint on.
pS	Scaling freeze?
pR	Rotation freeze?
pT	Translation freeze?

See the C++ reference

FreezeSuggested ( FBConstraint arg1 )

Suggest 'freeze'.

Python Docstring:

FreezeSuggested( (FBConstraint)arg1) -> None

C++ Signature:

void FreezeSuggested()

See the C++ reference

bool ReferenceAdd	(	FBConstraint	arg1,
		object	arg2,
		FBModel	arg3
	)

Add a reference to a specified group.

Python Docstring:

ReferenceAdd( (FBConstraint)arg1, (object)arg2, (FBModel)arg3) -> bool

C++ Signature:

bool ReferenceAdd(int pGroupIndex, ORSDK2018::FBModel * pModel)

Parameters

pGroupIndex	Group to add reference to.
pModel	Model to place at new reference.

Returns: true if successful.

Warning: If you try to add a model to a group that is already full, the success of the operation will be false and the reference will not be added.

See the C++ reference

object ReferenceGet	(	FBConstraint	arg1,
		object	arg2,
		object	arg3
	)

Get a reference.

Python Docstring:

ReferenceGet( (FBConstraint)arg1, (object)arg2 [, (object)arg3]) -> object

C++ Signature:

ORSDK2018::FBModel * ReferenceGet(int pGroupIndex, int pItemIndex = 0)

Parameters

pGroupIndex	Index of reference group containing desired reference.
pItemIndex	Index of reference in group to get (default is 0).

Returns: Model at specified reference.

See the C++ reference

int ReferenceGetCount	(	FBConstraint	arg1,
		object	arg2
	)

Get number of references in a specified group.

Python Docstring:

ReferenceGetCount( (FBConstraint)arg1, (object)arg2) -> int

C++ Signature:

int ReferenceGetCount(int pGroupIndex)

Parameters

pGroupIndex Index of group to query the number of references.

Returns: Number of references in specified group.

See the C++ reference

int ReferenceGroupAdd	(	FBConstraint	arg1,
		str	arg2,
		object	arg3
	)

Add a group of references.

Python Docstring:

ReferenceGroupAdd( (FBConstraint)arg1, (str)arg2, (object)arg3) -> int

C++ Signature:

int ReferenceGroupAdd(const char * pGroupName, int pMaxItemCount)

Parameters

pGroupName	Name of reference group to add.
pMaxItemCount	Maximum number of items in pGroupName.

Returns: Index of new reference group.

See the C++ reference

int ReferenceGroupGetCount ( FBConstraint arg1 )

Return the number of reference groups.

Python Docstring:

ReferenceGroupGetCount( (FBConstraint)arg1) -> int

C++ Signature:

int ReferenceGroupGetCount()

Returns: Number of reference groups.

See the C++ reference

int ReferenceGroupGetMaxCount	(	FBConstraint	arg1,
		object	arg2
	)

Get the maximum number of items that can exist in the reference group in question.

Python Docstring:

ReferenceGroupGetMaxCount( (FBConstraint)arg1, (object)arg2) -> int

C++ Signature:

int ReferenceGroupGetMaxCount(int pGroupIndex)

Parameters

pGroupIndex Index of reference group.

Returns: Maximum number of items that can be added to the reference group.

See the C++ reference

str ReferenceGroupGetName	(	FBConstraint	arg1,
		object	arg2
	)

Get the name of the reference group.

Python Docstring:

ReferenceGroupGetName( (FBConstraint)arg1, (object)arg2) -> str

C++ Signature:

const char * ReferenceGroupGetName(int pGroupIndex)

Parameters

pGroupIndex Index of the reference group to get the name for.

Returns: The name of the reference group pGroupIndex.

See the C++ reference

bool ReferenceRemove	(	FBConstraint	arg1,
		object	arg2,
		FBModel	arg3
	)

Remove a reference to pModel from the group at pGroupIndex.

Python Docstring:

ReferenceRemove( (FBConstraint)arg1, (object)arg2, (FBModel)arg3) -> bool

C++ Signature:

bool ReferenceRemove(int pGroupIndex, ORSDK2018::FBModel * pModel)

Parameters

pGroupIndex	Index to remove reference from.
pModel	Model to remove reference from.

Returns: true if successful.

See the C++ reference

RemoveAllAnimationNodes ( FBConstraint arg1 )

Remove animation nodes.

Python Docstring:

RemoveAllAnimationNodes( (FBConstraint)arg1) -> None

C++ Signature:

void RemoveAllAnimationNodes()

See the C++ reference

RestoreModelState	(	FBConstraint	arg1,
		FBModel	arg2
	)

Restore the saved model state onto pModel.

Python Docstring:

RestoreModelState( (FBConstraint)arg1, (FBModel)arg2) -> None

C++ Signature:

void RestoreModelState(ORSDK2018::FBModel * pModel)

Parameters

pModel Model to affect with previous state.

See the C++ reference

SaveModelState	(	FBConstraint	arg1,
		FBModel	arg2,
		object	arg3,
		object	arg4,
		object	arg5
	)

Save current state of pModel.

Python Docstring:

SaveModelState( (FBConstraint)arg1, (FBModel)arg2, (object)arg3, (object)arg4, (object)arg5) -> None

C++ Signature:

void SaveModelState(ORSDK2018::FBModel * pModel, bool pS, bool pR, bool pT)

Parameters

pModel	Model to save.
pS	Scaling information?
pR	Rotation information?
pT	Translation information?

See the C++ reference

SetupAllAnimationNodes ( FBConstraint arg1 )

Setup animation nodes.

Python Docstring:

SetupAllAnimationNodes( (FBConstraint)arg1) -> None

C++ Signature:

void SetupAllAnimationNodes()

See the C++ reference

Snap ( FBConstraint arg1 )

Function Property: Snap constraint.

Python Docstring:

Snap( (FBConstraint)arg1) -> None

See the C++ reference

SnapSuggested ( FBConstraint arg1 )

Suggest 'snap'.

Python Docstring:

SnapSuggested( (FBConstraint)arg1) -> None

C++ Signature:

void SnapSuggested()

See the C++ reference

Member Data Documentation

FBPropertyBool Active

Read Write Property: Active state.

See the C++ reference

FBPropertyBool Deformer

Read Write Property: Is a deformer constraint?

See the C++ reference

ORSDK2018::FBPropertyString Description

Read Write Property: Long description of constraint.

See the C++ reference

FBPropertyBool HasLayout

Read Write Property: Does the constraint have a layout?

See the C++ reference

FBPropertyBool Lock

Read Write Property: Lock state.

See the C++ reference

FBPropertyAnimatableDouble Weight

Read Write Property: Weight of constraint.

See the C++ reference

FBConstraint Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation