MotionBuilder SDK base class. More...

#include <pyfbsdk_generated.h>

Inherits FBPlug.

Inherited by FBActionManager, FBActorFace, FBAnimationLayer, FBAnimationNode, FBApplication, FBAssetItem, FBAssetMng, FBAudioClip, FBAudioIn, FBAudioOut, FBBox, FBCameraSwitcherAudioManager, FBCharacterMarkerSet, FBCluster, FBConstraintManager, FBConstructionHistory, FBControlSet, FBCycleCreator, FBDeck, FBDeformer, FBDeviceInstrument, FBDeviceOpticalMarker, FBEvaluateManager, FBFCurve, FBFCurveEditorUtility, FBFCurveEventManager, FBFbxOptions, FBFileMonitoringManager, FBFilter, FBFolder, FBGenericMenu, FBGenericMenuItem, FBGeometry, FBHUDManager, FBImage, FBKeyControl, FBKeyingGroup, FBManipulator, FBMarkerSet, FBMenuManager, FBModelOpticalAdvanced, FBModelTemplate, FBModelVertexData, FBModuleManager, FBMotionBlend, FBMotionBlendEdit, FBMotionClip, FBMotionFileExportOptions, FBMotionFileImportOptions, FBNamespace, FBOpticalGap, FBOpticalSegment, FBPlayerControl, FBPointCacheFile, FBPointCacheManager, FBPose, FBProfiler, FBPropertyViewManager, FBReferenceTime, FBRenderer, FBRendererCallback, FBRigidBody, FBScene, FBSpreadPart, FBStory, FBStoryClip, FBStoryFolder, FBStoryGroupClip, FBSystem, FBTake, FBTimeWarpManager, FBToolLayoutManager, FBTransportAudioManager, FBTreeNode, FBUndoManager, FBVideoGrabber, and FBVisualComponent.

Public Member Functions
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed Description

MotionBuilder SDK base class.

FBComponent defines common object characteristics, including creation and destruction methods. It is used to encapsulate internal application objects so they can be exposed to the SDK. It is also used as the base class to encapsulate objects with FBProperty data members and provides a scheme for property management. You cannot instantiate FBProperty objects. To reference a property, use an instance of an FBComponent object. The methods FBComponent::PropertyCreate and FBComponent::PropertyRemove can be used to modify an object's properties. Basic operators are overloaded in FBComponent. The constructor and destructor are created and defined with macros in the header files. Objects inheriting from FBComponent must define FBComponent::FBCreate(), and FBComponent::FBDestroy(). All memory management issues for the component should also be addressed here. Destroy an object with FBDelete(). The code sample FBComponent.py shows how to get a handle on a scene object via its name.

See sample: ReplaceNamespace.py.

Constructor & Destructor Documentation

◆ FBComponent()

FBComponent ( )

Constructor.

Member Function Documentation

◆ ClassName()

str ClassName ( )

Get the class name.

Returns: The class name (i.e. "FBComponent").

See sample: RePrefixAllMarkers.py.

◆ DisableObjectFlags()

DisableObjectFlags ( FBObjectFlag pFlags )

Disable a specific Object Flags.

Parameters

pFlags Flags to disable.

◆ EnableObjectFlags()

EnableObjectFlags ( FBObjectFlag pFlags )

Enable a specific Object Flags.

Parameters

pFlags Flags to enable.

◆ FBCreate()

bool FBCreate ( )

Open Reality Creation function.

Returns: Outcome of creation (true/false).

◆ FBDelete()

FBDelete ( )

Open Reality deletion function.

See sample: DeleteHierarchy.py.

◆ FBDestroy()

FBDestroy ( )

Open Reality destruction function.

◆ GetObjectFlags()

FBObjectFlag GetObjectFlags ( )

Get all Object Flags (concatenated).

Returns: Get all object flags in one call. Flags can be concatenated.

◆ GetObjectStatus()

bool GetObjectStatus ( FBObjectStatus pStatus )

Check to see if an object status is enabled.

Parameters

pStatus Status to query.

◆ GetOwnerFileReference()

FBFileReference GetOwnerFileReference ( p0 )

Get the owner FileReference object.

Returns: the owner FileReference object

◆ HardSelect()

HardSelect ( )

HardSelect.

Selects the object, and emits a hard select event for UI update notification.

◆ HasObjectFlags()

bool HasObjectFlags ( FBObjectFlag pFlags )

Check whether a specific object flag is enabled.

Parameters

pFlags Flags to check if they are present.

Returns: True if all flags in pFlags are enabled.

◆ Is()

bool Is ( int pTypeId )

Returns true if object is of type TypeId.

Parameters

pTypeId TypeId to compare object to.

Returns: Result of the comparison.

◆ ProcessNamespaceHierarchy()

bool ProcessNamespaceHierarchy	(	FBNamespaceAction	pNamespaceAction,
		str	pNamespaceName,
		str	pReplaceTo = `None`,
		bool	pAddRight = `True`
	)

ProcessNamespaceHierarchy.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.

Parameters

pNamespaceAction	Which operation to do on the hierarchy (children).
pNamespaceName	The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo	The new Namespace Name or NULL in case of add or delete.
pAddRight	Whether to add the namespace on right-most or left-most side or other namespace.

Returns: return true if process successful.

◆ ProcessObjectNamespace()

bool ProcessObjectNamespace	(	FBNamespaceAction	pNamespaceAction,
		str	pNamespaceName,
		str	pReplaceTo = `None`,
		bool	pAddRight = `True`
	)

ProcessObjectNamespace.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.

Parameters

pNamespaceAction	Which operation to do on the hierarchy (children).
pNamespaceName	The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo	The new Namespace Name or NULL in case of add or delete.
pAddRight	Whether to add the namespace on right-most or left-most side or other namespace.

Returns: return true if process successful.

◆ PropertyAdd()

int PropertyAdd ( FBProperty pProperty )

Add a property to the component's property manager.

Parameters

pProperty The property to add to the property manager.

Returns: Index in the property array where property was inserted.

◆ PropertyAddReferenceProperty()

bool PropertyAddReferenceProperty ( FBProperty pReferenceProperty )

Add a reference property to the component's property manager.

Parameters

pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).

Returns: True if the reference property could be added.

◆ PropertyCreate()

FBProperty PropertyCreate	(	str	pName,
		FBType	pType,
		str	pDataType,
		bool	pAnimatable,
		bool	pIsUser = `False`,
		FBProperty	pReferenceSource = `None`
	)

Create user or dynamic property.

Parameters

pName	The name of the property.
pType	Type of the property. See enum FBPropertyType.
pDataType	DataType of the property.
pAnimatable	To specify if the property can be animated.
pIsUser	To specify if the property is available as a custom property or dynamic and attached to the object.
pReferenceSource	Specifies the property that a reference refers to.

◆ PropertyGetModifiedList()

PropertyGetModifiedList	(	FBArrayTemplate< FB >	pPropList,
		FBPlugModificationFlag	pModificationFlags
	)

Get list of properties which have been modified since last loading.

Parameters

pPropList	property list to hold the modified properties.
pModificationFlags	type of modification to query.

◆ PropertyRemove()

PropertyRemove ( FBProperty pProperty )

Remove a Property from the component's Property manager.

If the property was dynamically allocated, it is deleted.

Parameters

pProperty The property to remove from the property manager.

◆ SetObjectFlags()

SetObjectFlags ( FBObjectFlag pFlags )

SetObjectFlags.

Parameters

pFlags Set flag values. Note: this function overwrites all flags with those passed in parameter.

◆ SetObjectStatus()

SetObjectStatus	(	FBObjectStatus	pStatus,
		bool	pValue
	)

Enable/Disable a specific Object Status.

Parameters

pStatus	Status to change.
pValue	Value to change the status to.

Member Data Documentation

◆ Components

FBListComponent Components

List: List of components.

◆ LongName

str LongName

Read Write Property: Name and namespace for object.

◆ Name

str Name

Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

◆ Parents

FBListComponent Parents

List: Parents.

◆ PropertyList

FBManager PropertyList

Read Only Property: Manages all of the properties for the component.

◆ Selected

bool Selected

Read Write Property: Selected property.

◆ TypeInfo

int TypeInfo

Contains the Type information of the object.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FBComponent()

Member Function Documentation

◆ ClassName()

◆ DisableObjectFlags()

◆ EnableObjectFlags()

◆ FBCreate()

◆ FBDelete()

◆ FBDestroy()

◆ GetObjectFlags()

◆ GetObjectStatus()

◆ GetOwnerFileReference()

◆ HardSelect()

◆ HasObjectFlags()

◆ Is()

◆ ProcessNamespaceHierarchy()

◆ ProcessObjectNamespace()

◆ PropertyAdd()

◆ PropertyAddReferenceProperty()

◆ PropertyCreate()

◆ PropertyGetModifiedList()

◆ PropertyRemove()

◆ SetObjectFlags()

◆ SetObjectStatus()

Member Data Documentation

◆ Components

◆ LongName

◆ Name

◆ Parents

◆ PropertyList

◆ Selected

◆ TypeInfo