#include <mobu-python-api.h>

Class Description

Model class.

In the MotionBuilder UI, a model can be any object in a scene, created using geometry. Models can represent simple objects like cubes, or complex objects like characters. FBModel is a base class which is not used so much directly, but is the parent of well-used classes like FBCamera, FBLight, and FBModelMarker. It also implements a number of widely-implemented functions and attributes, such as:

Clone(), FBDelete()
UI attributes such as Show, Pickable, and Visibility
Positional attributes such as Rotation, Scaling, and Translation The following Python snippet shows how to create, show, rotate, and delete a cube
from pyfbsdk import *

myCube = FBModelCube("cube")

myCube.Show = True

myCube.Rotation = FBVector3d(45, 45, 45)

myCube.FBDelete()

There is a few ways to get a handle on existing models in a scene:

FBFindObjectsByName return a list of objects matching a pattern (can contain *). For usage, see: FindObjectsWithWildcard.py
If you know the name of the model, use FBFindModelByLabelName, as demonstrated in FBComponent.py.
FBGetSelectedModels can get a handle to an object which is derived from FBModel. It searches the scene for a model, based on the model's unique name and returns a list of all the selected things in the scene.

Public Member Functions
	__reduce__ ()

object	__copy__ (FBModel arg1)

FBColor	GetAdditionalUniqueColorID (FBModel arg1, int arg2)
	Get Additional Unique Color Id. More...

str	FbxGetObjectSubType (FBModel arg1)
	Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'. More...

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

str	FbxGetObjectType (FBModel arg1)
	Returns the class type inherited by the class of an object, for example: 'Model'. More...

object	Clone (FBModel arg1)
	Clone the model. More...

	GetBoundingBox (FBModel arg1, FBVector3d arg2, FBVector3d arg3)
	Get the bounding box of the model. More...

	GetMatrix (FBModel arg1, FBMatrix arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Get a matrix from the model. More...

list	GetHierarchyWorldMatrices (FBModel arg1, int arg2, FBModelHiercharyTraverserType arg3, FBEvaluateInfo arg4)
	Computes the global transform matrices between this model and all its children (all levels). More...

int	GetSelectedPointsCount (FBModel arg1)
	Get the number of selected points in the model. More...

	SetupPropertiesForShapes (FBModel arg1)
	Setup Shape Properties. More...

	GetVector (FBModel arg1, FBVector3d arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Get a vector from the model. More...

	SetMatrix (FBModel arg1, FBMatrix arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Set a matrix for the model. More...

	SetMatrixWithPrecision (FBModel arg1, FBMatrix arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5, object arg6)
	Set a matrix for the model. More...

	SetVector (FBModel arg1, FBVector3d arg2, FBModelTransformationType arg3, object arg4, FBEvaluateInfo arg5)
	Set a vector for the model. More...

	MatrixToRotation (FBModel arg1, FBVector3d arg2, FBMatrix arg3)
	Convert Rotation Matrix to Euler Vector based on model's rotation order. More...

	RotationToMatrix (FBModel arg1, FBMatrix arg2, FBVector3d arg3)
	Convert Euler Vector to Rotation Matrix based on model's rotation order. More...

	LRMToDof (FBModel arg1, FBVector3d arg2, FBMatrix arg3)
	Convert local matrix to object space vector. More...

	DofToLRM (FBModel arg1, FBMatrix arg2, FBVector3d arg3)
	Convert object space vector to local matrix. More...

	SetSchematicPosition (...)

FBVector2d	GetSchematicPosition (FBModel arg1)
	Get the position in the schematic view for the model. More...

	CollapseInSchematic (FBModel arg1)
	Collapse the model in the schematic view. More...

	ExpandInSchematic (FBModel arg1)
	Expand the model in the schematic view. More...

bool	IsCollapsedInSchematic (FBModel arg1)
	Returns if the model is collapsed or not (expanded) in the schematic view. More...

int	NoFrustumCullingRequire (FBModel arg1)
	Acquire no frustum culling request. More...

int	NoFrustumCullingRelease (FBModel arg1)
	Release no frustum culling request. More...

bool	UseFrustumCulling (FBModel arg1)
	Get the current Frustum Culling Status. More...

	ForceAlwaysEvaluate (FBModel arg1)
	Force Always Evaluate. More...

bool	IsForceAlwaysEvaluate (FBModel arg1)
	Return Force Always Evaluate status. More...

bool	IsEvaluationReady (FBModel arg1, FBModelEvaluationTaskType arg2, FBEvaluateInfo arg3)
	Is the model's evaluation task result ready. More...

bool	SetAdditionalUniqueColorIDCount (FBModel arg1, int arg2)
	Request additional Unique color IDs. More...

int	GetAdditionalUniqueColorIDCount (FBModel arg1)
	Get additional unique color count. More...

bool	RayCast (FBModel arg1, FBCamera arg2, object arg3, object arg4, FBVector3d arg5, FBVector3d arg6)
	Ray cast test. 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
FBPropertyAnimationNode	AnimationNode
	Read Only Property: Animation node of the model. More...

ORSDK2018::FBPropertyListModel	Children
	Interface to IObject. More...

FBPropertyVector3d	GeometricRotation
	Read Write Property: Geometric rotation. More...

FBPropertyVector3d	GeometricScaling
	Read Write Property: Geometric scaling. More...

FBPropertyVector3d	GeometricTranslation
	Read Write Property: Geometric translation. More...

FBPropertyGeometry	Geometry
	Read Write Property: Geometry for the model. More...

FBPropertyModelVertexData	ModelVertexData
	Read Only Property: ModelVertexData for the model. More...

FBPropertyBool	Icon3D
	Read Write Property: Is model a 3D icon? More...

FBPropertyBool	IsDeformable
	Read Only Property: Is model deformable? More...

FBPropertyBool	IsConstrained
	Read Only Property: Is model constrained? More...

FBPropertyInt	GeometryUpdateId
	Read Only Property: model geometry (vertex data) related update id. More...

FBPropertyBool	SkeletonDeformable
	Read Write Property: Model skeleton deformable. More...

FBPropertyBool	BlendShapeDeformable
	Read Write Property: Model blend-shape deformable. More...

FBPropertyBool	ConstrainDeformable
	Read Write Property: Model constraint deformable. More...

FBPropertyBool	PointCacheDeformable
	Read Write Property: Model point cache deformable. More...

FBPropertyBool	PointCacheRecord
	Read Write Property: Record Point Cache for model? Not Savable More...

FBPropertyColor	UniqueColorId
	Read Only Property: Unique Color Id for color based viewer picking. More...

FBPropertyModel	LookAt
	Read Write Property: Look at model (interest point). More...

FBPropertyModel	Parent
	Read Write Property: Parent model. More...

FBPropertyVector3d	PostRotation
	Read Write Property: Post Rotation (considered if RotationActive is true) More...

FBPropertyVector3d	PreRotation
	Read Write Property: Pre Rotation (considered if RotationActive is true) More...

FBPropertyBool	QuaternionInterpolate
	Read Write Property: Use quaternion interpolation. More...

FBPropertyBool	PrimaryVisibility
	Read Write Property: Control the geometry render state. More...

FBPropertyBool	CastsShadows
	Read Write Property: If true, the geometry will produce shadows. More...

FBPropertyBool	ReceiveShadows
	Read Write Property: If true, the geometry will receive shadows. More...

FBPropertyAnimatableVector3d	Rotation
	Read Write Property: Lcl rotation. More...

FBPropertyBool	RotationActive
	Read Write Property: Is model using Rotation Limits? More...

FBPropertyVector3d	RotationMax
	Read Write Property: Max Rotation Limit (considered if RotationActive is true) More...

FBPropertyBool	RotationMaxX
	Read Write Property: Is model using Maximum Rotation Limits On X? More...

FBPropertyBool	RotationMaxY
	Read Write Property: Is model using Maximum Rotation Limits On Y? More...

FBPropertyBool	RotationMaxZ
	Read Write Property: Is model using Maximum Rotation Limits On Z? More...

FBPropertyVector3d	RotationMin
	Read Write Property: Min Rotation Limit (considered if RotationActive is true) More...

FBPropertyBool	RotationMinX
	Read Write Property: Is model using Minimum Rotation Limits On X? More...

FBPropertyBool	RotationMinY
	Read Write Property: Is model using Minimum Rotation Limits On Y? More...

FBPropertyBool	RotationMinZ
	Read Write Property: Is model using Minimum Rotation Limits On Z? More...

FBPropertyModelRotationOrder	RotationOrder
	Read Write Property: Rotation order. More...

FBPropertyBool	RotationSpaceForLimitOnly
	Read Write Property: Apply Post Rotation Matrix only for Limits? More...

FBPropertyAnimatableVector3d	Scaling
	Read Write Property: Lcl scaling. More...

FBPropertyScene	Scene
	Read Only Property: Scene containing the model. More...

object	Selected

ORSDK2018::FBPropertyListShader	Shaders
	List: Shaders for model. More...

ORSDK2018::FBPropertyListMaterial	Materials
	List: Materials for model. More...

ORSDK2018::FBPropertyListTexture	Textures
	List: Textures with Special UseType (Other than "Color" which should connect to materials). More...

ORSDK2018::FBPropertyListDeformer	Deformers
	List: Deformers (Skeleton Deformer or Point Cache Deformer). More...

FBPropertyModelShadingMode	ShadingMode
	Read Write Property: Shading mode for the model. More...

object	CullingMode

FBPropertyBool	Pickable
	Read Write Property: Indicate if a model can be picked in the viewer. More...

FBPropertyBool	Show
	Read Write Property: Indicate if the viewer should show the object, according to its visibility value. More...

FBPropertyBool	Transformable
	Read Write Property: Indicate if a model can be transformable in the viewer. More...

FBPropertyBool	SoftSelected
	Read Write Property: Is model Soft selected? More...

FBPropertyAnimatableVector3d	Translation
	Read Write Property: Lcl translation. More...

FBPropertyModel	UpVector
	Read Write Property: UpVector model. More...

FBPropertyAnimatableBool	Visibility
	Read Write Property: Visibility of model. More...

object	IsVisible
	If the model is visible. More...

FBPropertyBool	VisibilityInheritance
	Read Write Property: //!< When this value is set to `True` the Visibility of this model is also applied to all its descendants 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

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

GetBoundingBox	(	FBModel	arg1,
		FBVector3d	arg2,
		FBVector3d	arg3
	)

pMin	Minimum value of the bounding box.
pMax	Maximum value of the bounding box.

list GetHierarchyWorldMatrices	(	FBModel	arg1,
		int	arg2,
		FBModelHiercharyTraverserType	arg3,
		FBEvaluateInfo	arg4
	)

pMatricesArray	The matrix array (memory already allocated) to fill in with the hierarchy world matrix of all the model's children models
pMatricesArrayCount	The size of the matrix array

GetMatrix	(	FBModel	arg1,
		FBMatrix	arg2,
		FBModelTransformationType	arg3,
		object	arg4,
		FBEvaluateInfo	arg5
	)

pWhat	Type of information requested (default=transformation).
pGlobalInfo	true if it is GlobalInfo, false if Local (default=true).

GetVector	(	FBModel	arg1,
		FBVector3d	arg2,
		FBModelTransformationType	arg3,
		object	arg4,
		FBEvaluateInfo	arg5
	)

pWhat	Type of evaluation task.
pEvaluateInfo	EvaluateInfo, Take Display if none specified

bool IsEvaluationReady	(	FBModel	arg1,
		FBModelEvaluationTaskType	arg2,
		FBEvaluateInfo	arg3
	)

MatrixToRotation	(	FBModel	arg1,
		FBVector3d	arg2,
		FBMatrix	arg3
	)

bool RayCast	(	FBModel	arg1,
		FBCamera	arg2,
		object	arg3,
		object	arg4,
		FBVector3d	arg5,
		FBVector3d	arg6
	)

pCamera	Camera to use for casting.
pMouseX	Mouse X position.
pMouseY	Mouse Y position.
pHitPosition	Ray cast position on the object.
pHitNormal	Normal at the ray cast position on the object.

RotationToMatrix	(	FBModel	arg1,
		FBMatrix	arg2,
		FBVector3d	arg3
	)

bool SetAdditionalUniqueColorIDCount	(	FBModel	arg1,
		int	arg2
	)

SetMatrix	(	FBModel	arg1,
		FBMatrix	arg2,
		FBModelTransformationType	arg3,
		object	arg4,
		FBEvaluateInfo	arg5
	)

pMatrix	Information to use to set the model's matrix.
pWhat	Type of matrix to set (default=transformation).
pGlobalInfo	true if it is GlobalInfo, false if Local (default=true).
pPushUndo	true if this operation is undoable, don't push undo in non UI thread.
pEvaluateInfo	EvaluateInfo, Take Display if none specified

SetMatrixWithPrecision	(	FBModel	arg1,
		FBMatrix	arg2,
		FBModelTransformationType	arg3,
		object	arg4,
		FBEvaluateInfo	arg5,
		object	arg6
	)

SetVector	(	FBModel	arg1,
		FBVector3d	arg2,
		FBModelTransformationType	arg3,
		object	arg4,
		FBEvaluateInfo	arg5
	)

FBModel Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation

pVector	Vector to use to set values.
pWhat	Type of information to set (default=translation, inverses not supported).
pGlobalInfo	true if it is GlobalInfo, false if Local (default=true).
pPushUndo	true if this operation is undoable, don't push undo in non UI thread.
pEvaluateInfo	EvaluateInfo, Take Display if none specified