This reference page is linked to from the following overview topics: MotionBuilder 2013, Data types & properties, Events & callbacks, Object Model, FBComponent - The Base Entity Class, FBProperty - Object Properties, FBPlug - Object Connection Management, Example: Cube Counter, FBModel - Transformation Data and the Scene Graph, Joint Chains.

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.

Definition at line 629 of file fbcomponent.h.

#include <fbcomponent.h>

Inherits FBPlug.

Inherited by FBActorFace, FBAMMenu, FBAnimationLayer, FBAnimationNode, FBApplication, FBApplyManagerRule, FBAssetItem, FBAssetMng, FBAudioClip, FBAudioIn, FBAudioOut, FBBox, FBCharacterManipulator, FBCluster, FBCommand, FBCommPort, FBConsole, FBConsoleChannel, FBConstraintManager, FBControlSet, FBCustomManager, FBDeck, FBDeformer, FBDeviceInstrument, FBDeviceOpticalMarker, FBDeviceSyncPacket, FBEvaluateManager, FBFbxObject, FBFbxOptions, FBFCurve, FBFileMonitoringManager, FBFilter, FBFolder, FBGenericMenu, FBGenericMenuItem, FBGeometry, FBGroup, FBHUD, FBHUDElement, FBImage, FBJLCooper, FBKeyControl, FBKeyingGroup, FBManipulator, FBMarkerSet, FBMenuManager, FBModelOpticalAdvanced, FBModelTemplate, FBModelVertexData, FBMotionClip, FBMotionClip, FBNamespace, FBOpticalGap, FBOpticalSegment, FBPlayerControl, FBPointCacheFile, FBPointCacheManager, FBPose, FBProfiler, FBReferenceTime, FBRenderer, FBRigidBody, FBScene, FBSet, FBSpreadPart, FBStory, FBStoryClip, FBStoryFolder, FBSyncReference, FBSystem, FBTake, FBTCPIP, FBTimeWarpManager, FBTreeNode, FBTrigger, FBTriggerBranch, FBTriggerGroup, FBTriggerManager, FBVideoGrabber, and FBVisualComponent.

List of all members.

Public Member Functions
	FBComponent (HIObject pObject)
	Constructor.
virtual	~FBComponent ()
	Destructor.
virtual bool	FBCreate ()
	Open Reality Creation function.
virtual void	FBDestroy ()
	Open Reality destruction function.
virtual void	FBDelete () override
	Open Reality deletion function.
virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.
virtual 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.
void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.
void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
void	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.
void	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.
virtual const char *	ClassName () override
	Get the class name.
const char *	GetFullName (void)
	Get the full name.
void	SetOwnerNamespace (HFBNamespace pOwnerNSObj)
	Set the owner Namespace object.
HFBNamespace	GetOwnerNamespace (void)
	Get the owner Namespace object.
void	HardSelect ()
	HardSelect.
	IObject_Declare (Implementation)
	ICallback_Declare (Implementation)
virtual bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
virtual int	GetTypeId ()
	GetTypeId( int pTypeId )
void	KObjectEvent (HIRegister pView, HKEventBase pEvent)

void *	operator new (size_t stAllocateBlock)
void	operator delete (void *pvMem)
void *	operator new (size_t stAllocateBlock, int blockType, const char *filename, int linenumber)

void	RegisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void	UnregisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void	InvalidatePropertyEventsParents ()
Static Public Member Functions
static int	GetInternalClassId ()
static void	FBComponentSetName (FBComponent pObject, const char pName)
static const char *	FBComponentGetName (FBComponent *pObject)
static void	FBComponentSetLongName (FBComponent pObject, const char pName)
static const char *	FBComponentGetLongName (FBComponent *pObject)
Public Attributes
HDataFBComponent	mLocalPtr
	Handle on HDataFBComponent.
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
FBPropertyListComponent	Components
	List: List of components.
FBPropertyListComponent	Parents
	List: Parents.
FBPropertyBool	Selected
	Read Write Property: Selected property.
FBPropertyString	Name
	Read Write Property: Unique name of object.
FBPropertyString	LongName
	Read Write Property: Name and namespace for object.
FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.
KObject *	mDummyObject
	Internal Dummy Object for non KObject Components.
Static Public Attributes
static int	TypeInfo
	Contains the Type information of the object.
Protected Attributes
FBString	mName
	Name of the component.

Constructor & Destructor Documentation

FBComponent ( HIObject pObject )

Constructor.

Parameters:

pObject Object to copy component from (default is NULL).

virtual ~FBComponent ( ) [virtual]

Destructor.

Member Function Documentation

GetInternalClassId ( ) [static]

virtual bool SetHIObject	(	HIObject	pObject,
		bool	pSDKComponent
	)		`[override, virtual]`

void PropertyGetModifiedList	(	FBArrayTemplate< FBProperty * > &	pPropList,
		FBPlugModificationFlag	pModificationFlags
	)

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

FBProperty* PropertyCreate	(	const char *	pName,
		FBPropertyType	pType,
		const char *	pDataType,
		bool	pAnimatable,
		bool	pIsUser = `false`,
		FBProperty *	pReferenceSource = `NULL`
	)

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.

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

void ProcessNamespaceHierarchy	(	FBNamespaceAction	pNamespaceAction,
		const char *	pNamespaceName,
		const char *	pReplaceTo = `NULL`,
		bool	pAddRight = `true`
	)

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.

void ProcessObjectNamespace	(	FBNamespaceAction	pNamespaceAction,
		const char *	pNamespaceName,
		const char *	pReplaceTo = `NULL`,
		bool	pAddRight = `true`
	)

void* operator new	(	size_t	stAllocateBlock,
		int	blockType,
		const char *	filename,
		int	linenumber
	)

void SetObjectStatus	(	FBObjectStatus	pStatus,
		bool	pValue
	)

static void FBComponentSetName	(	FBComponent *	pObject,
		const char *	pName
	)		`[static]`

static void FBComponentSetLongName	(	FBComponent *	pObject,
		const char *	pName
	)		`[static]`

FBComponent Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation