This reference page is linked to from the following overview topics: Your First Python Program, Using C++ with MotionBuilder, Data types & properties, FBModel - Transformation Data and the Scene Graph.

Basic class definitions. More...

#include
<kaydaradef.h>

#include <fbsdk/fblibrary.h>
#include <fbsdk/fbplug.h>
#include <fbsdk/fbarray.h>
#include <fbsdk/fbstring.h>
#include <fbsdk/fbproperties.h>

Go to the source code of this file.

Classes
class	FBPropertyListComponentBase
	PropertyList: Component. More...
class	FBPropertyListComponent
	PropertyList: Concrete class for PropertyList of component More...
class	FBPropertyListObject
	List of scene objects. More...
class	FBComponent
	MotionBuilder SDK base class. More...
class	FBEvent
	Base Event class. More...
class	FBEventConnectionNotify
	Connection notify event class. More...
class	FBEventConnectionDataNotify
	Connection notify event class. More...
class	FBEventConnectionStateNotify
	Connection notify event class. More...
class	FBLibraryBase
	Library class for DLL registration. More...
class	FBLibrary
	Library class for DLL registration. More...
class	FBCustomManager
	Custom manager class for user controlled observer objects. More...
Defines
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FB_DEFAULT_SDK_ICON "openreality_noicon.png"
	Define SDK icon filename.
#define	__FBClassInit mLocalPtr = NULL;
	For internal use only.
#define	__FBClassInitSDKComponent(pObjectToWrappedIsAllocated)
	For internal use onlyL decide if we need to delete the corresponding KObject.
#define	__FBClassImplementation(ThisComponent, pInternalClassId)
	For internal use only.
#define	__FBClassDeclare(Name, Parent)
	For internal use only.
#define	FBStorableClassImplementation(ClassName, Type)
	Storable Class implementation.
#define	FBElementClassImplementation(ClassName, IconFileName)
	Element Class implementation.
#define	FBStorableClassDeclare(Name, Parent)
	Storable Class declaration.
#define	FBPropertyInitComponent(Param, Type, PropName, Get, Set)
	Initialize a property: component.
#define	FBIS(Component, ComponentType) ((Component) && (Component)->Is( ComponentType::TypeInfo ))
	Macro to verify the type of a component.
#define	FBRegisterEvent ( Object, EventId, EventProc ) IQ( Object,IRegister)->Register ( EventId,(HICallback)this,(kICallbackHandler)EventProc );
	Event registration/unregistration.
#define	FBUnregisterEvent ( Object, EventId, EventProc ) IQ( Object,IRegister)->Unregister ( EventId,(HICallback)this,(kICallbackHandler)EventProc );
	Event registration/unregistration.
#define	FBRegisterObject(LocalId, Path, Name, Description, Constructor, IsMultipleAllowed, IconFilename) static int __R##LocalId = FBObject_Register( Path,Name,Description,Constructor,IsMultipleAllowed,IconFilename )
	Event registration/unregistration.
#define	FBDeclareUserObject(ClassName)
	Event registration/unregistration.
#define	FBLibraryDeclare(LibName)
	Declare the library for the application.
#define	FBLibraryModule(Name) void FBModule##Name()
	FBLibraryModule Define a module registration call.
#define	FBLibraryRegister(ClassName)
	FBLibraryRegister Declare the module's registration functions.
#define	FBLibraryRegisterStorable(ClassName)
	FBLibraryRegisterStorable Declare the module's registration functions for storable classes.
#define	FBLibraryRegisterElement(ClassName)
	FBLibraryRegisterElement Declare the module's registration functions for element classes.
#define	FBLibraryDeclareEnd
	Finish library declaration.
#define	FBCustomManagerImplementation(ThisComponent) FBClassImplementation( ThisComponent ) \
	FBCustomManagerImplementation.
#define	FBRegisterCustomManager(ClassName)
	FBRegisterCustomManager.
#define	FBCustomManagerDeclare(ClassName)
	FBRegisterCustomDeclare.
Typedefs
typedef FBArrayTemplate < FBComponent * >	FBComponentList
	typedef FBArrayTemplate<FBComponent*> FBComponentList;
typedef HIRegister	HISender
	HISender.
typedef HKEventBase	HKEvent
	HKEvent.
typedef void(ICallback::*	FBCallback )(HISender pSender, HKEvent pEvent)
	FBCallback.
typedef FBComponent	FBObject
	Equivalent to FBComponent for gradual transition.
Enumerations
enum	FBObjectFlag { kFBFlagSelectable = (1 << 0), kFBFlagDeletable = (1 << 1), kFBFlagSavable = (1 << 2), kFBFlagVisible = (1 << 3), kFBFlagClonable = (1 << 4), kFBFlagSystem = (1 << 5), kFBFlagNewable = (1 << 6), kFBFlagRenamable = (1 << 7), kFBFlagMergeable = (1 << 8), kFBFlagBrowsable = (1 << 9), kFBFlagDetachable = (1 << 10), kFBFlagUndoable = (1 << 11), kFBFlagKeyable = (1 << 12), kFBFlagAllocated = (1 << 13), kFBFlagStory = (1 << 14), kFBFlagStorable6 = (1 << 15), kFBFlagStorableData6 = (1 << 16), kFBFlagStorableBlindData = (1 << 17), kFBFlagUniqueName = (1 << 18), kFBFlagNotSelectableNameSpace = (1 << 19), kFBFlagCustomNode = (1 << 20) }
	Available flags for any component. More...
enum	FBObjectStatus { kFBStatusNone = 0, kFBStatusCreating = (1 << 0), kFBStatusStoring = (1 << 1), kFBStatusRetrieving = (1 << 2), kFBStatusMerging = (1 << 3), kFBStatusDestroying = (1 << 4), kFBStatusOwnedByUndo = (1 << 5) }
	Available lifetime status for any component. More...
enum	FBNamespaceAction { kFBConcatNamespace, kFBReplaceNamespace, kFBRemoveAllNamespace }
	Namespace flags. More...
Functions
	K_FORWARD (IRegister)
	K_FORWARD (IError)
	K_FORWARD (IStore)
	K_FORWARD (IKtView)
	K_FORWARD (KEventBase)
	K_FORWARD (KGlobalNamedEvent)
	__FB_FORWARD (FBComponent)
	__FB_FORWARD (FBVisualComponent)
FBSDK_DLL FBComponent *	GetFBComponent (const HIObject Object)
	Get a handle to the FBComponent belonging to an HIObject.
FBSDK_DLL FBVisualComponent *	FBGetFBVisualComponent (HIKtView pObject, bool pAutoCreate=true)
	Get the FBComponent from an Internal Object.
FBSDK_DLL FBComponent *	FBGetFBComponent (HIObject pObject, bool pAutoCreate=true)
	Get the FBComponent from an Internal Object.
FBSDK_DLL FBPlug *	FBGetFBPlug (HIObject pObject, bool pAutoCreate=true)
	Get the FBPlug from an Internal Object.
FBSDK_DLL FBArrayTemplate < FBComponent * > &	FBGetComponentArray ()
	Get the Root FBComponent.
FBSDK_DLL void	FBSetStoreableCustomModelReigstered ()
FBSDK_DLL bool	FBGetStoreableCustomModelReigstered ()
FBSDK_DLL bool	FBObject_Register (char pGroupName, char pEntryName, char pDescription, kObjectCreatorFnc pCreatorFnc, bool pIsMultipleAllowed, char pIconFilename)
FBSDK_DLL bool	FBObject_Unregister (char pGroupName, char pEntryName, int nth=0)
FBSDK_DLL FBComponent *	FBCreateObject (char pGroupName, char pEntryName, char pName, void pData=NULL, int nth=0)
	FBCreateObject.
bool	FBUnregisterObject (char pGroupName, char pEntryName, int nth=0)
	FBUnregisterObject.
FBSDK_DLL int	FBRegister_ClassId (char *pClassName)
	FB_FORWARD (FBPropertyListComponent)
	FB_DEFINE_LIST (FBSDK_DLL, Component)
	FB_FORWARD (FBFolder)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Folder)
	FB_DEFINE_ENUM (FBSDK_DLL, ConnectionType)
	FB_DEFINE_ENUM (FBSDK_DLL, ConnectionAction)
	FB_DEFINE_ENUM (FBSDK_DLL, ObjectFlag)
	FB_FORWARD (FBPropertyListObject)
	__FB_FORWARD (FBEvent)
	__FB_FORWARD (FBEventConnectionNotify)
	__FB_FORWARD (FBEventConnectionDataNotify)
	__FB_FORWARD (FBEventConnectionStateNotify)
	__FB_FORWARD (FBCustomManager)

Detailed Description

Basic class definitions.

Contains the basic classes that most SDK objects will derive from. These classes form the base of many functionalities of the SDK. The file also contains the base macros used in the definition/registration of the SDK classes.

Definition in file fbcomponent.h.

Define Documentation

#define FBSDK_DLL K_DLLIMPORT

#define __FBClassImplementation	(	ThisComponent,
		pInternalClassId
	)

#define FBElementClassImplementation	(	ClassName,
		IconFileName
	)

Name	Name of class to declare.
Parent	Parent class to associate with Name.

#define FBPropertyInitComponent	(	Param,
		Type,
		PropName,
		Get,
		Set
	)

Param	Owner name.
Type	Type of variable.
PropName	Component name.
Get	Get function pointer.
Set	Set function pointer.

#define FBIS	(	Component,
		ComponentType
	)	((Component) && (Component)->Is( ComponentType::TypeInfo ))

Component	Component to verify.
ComponentType	Type to verify Component with.

#define FBRegisterObject	(	LocalId,
		Path,
		Name,
		Description,
		Constructor,
		IsMultipleAllowed,
		IconFilename
	)	static int __R##LocalId = FBObject_Register( Path,Name,Description,Constructor,IsMultipleAllowed,IconFilename )

kFBFlagSelectable	Can be selected. Search for all occurrences
kFBFlagDeletable	Can be deleted. Search for all occurrences
kFBFlagSavable	Can be saved. Search for all occurrences
kFBFlagVisible	Can be visible. Search for all occurrences
kFBFlagClonable	Can be cloned. Search for all occurrences
kFBFlagSystem	Created from System (not from user) Search for all occurrences
kFBFlagNewable	Deleted on File->New. Search for all occurrences
kFBFlagRenamable	Can be renamed. Search for all occurrences
kFBFlagMergeable	Can be merged. Search for all occurrences
kFBFlagBrowsable	Visible in the Scene Navigator/Schematic View/Property View/Model View. Search for all occurrences
kFBFlagDetachable	Object can be "detached". Used by the apply manager contextual menu. Search for all occurrences
kFBFlagUndoable	Object can undo its actions and states. Search for all occurrences
kFBFlagKeyable	Object can Key his property. (System Camera can't) Search for all occurrences
kFBFlagAllocated	Object is allocated, so it must call 'delete this' on destroy. Search for all occurrences
kFBFlagStory	Object created/used by the Story tool. Useful flag for filtering Story objects. Search for all occurrences
kFBFlagStorable6	System/Obsolete. Search for all occurrences
kFBFlagStorableData6	System/Obsolete. Search for all occurrences
kFBFlagStorableBlindData	Used in FBX SDK native IO. Search for all occurrences
kFBFlagUniqueName	Object unique name can be added to the unique name list (at first, only RootNode have this flag) Search for all occurrences
kFBFlagNotSelectableNameSpace	The entity will not add the namespace of the object to his list of all the namespaces of the scene. Search for all occurrences
kFBFlagCustomNode	User custom class instances. Search for all occurrences

kFBStatusNone	No special status, default value. Search for all occurrences
kFBStatusCreating	Object is in creation operations. Search for all occurrences
kFBStatusStoring	Object is in storing operations. Search for all occurrences
kFBStatusRetrieving	Object is in retrieving operations. Search for all occurrences
kFBStatusMerging	Object is in Merging operations. Search for all occurrences
kFBStatusDestroying	Object is in destruction operations. Search for all occurrences
kFBStatusOwnedByUndo	Object is owned by undo framework. Search for all occurrences

kFBConcatNamespace	Use to add a namespace name to object. Search for all occurrences
kFBReplaceNamespace	Use to replace a define namespace. Search for all occurrences
kFBRemoveAllNamespace	Remove all the namespace name. Search for all occurrences

FBSDK_DLL FBVisualComponent* FBGetFBVisualComponent	(	HIKtView	pObject,
		bool	pAutoCreate = `true`
	)

pObject	Object to get SDK object for.
pAutoCreate	Create object if it doesn't exist? (default is true)

FBSDK_DLL FBComponent* FBGetFBComponent	(	HIObject	pObject,
		bool	pAutoCreate = `true`
	)

FBSDK_DLL FBPlug* FBGetFBPlug	(	HIObject	pObject,
		bool	pAutoCreate = `true`
	)

FBSDK_DLL bool FBObject_Register	(	char *	pGroupName,
		char *	pEntryName,
		char *	pDescription,
		kObjectCreatorFnc	pCreatorFnc,
		bool	pIsMultipleAllowed,
		char *	pIconFilename
	)

FBSDK_DLL bool FBObject_Unregister	(	char *	pGroupName,
		char *	pEntryName,
		int	nth = `0`
	)

FBSDK_DLL FBComponent* FBCreateObject	(	char *	pGroupName,
		char *	pEntryName,
		char *	pName,
		void *	pData = `NULL`,
		int	nth = `0`
	)

pGroupName	Set the name of the Group.
pEntryName	Set the name of the Entry.
pName	Set the name of the Object to create.
pData	Data to pass to object creator function.
nth	Set the occurence of the object to remove.

bool FBUnregisterObject	(	char *	pGroupName,
		char *	pEntryName,
		int	nth = `0`
	)		`[inline]`

fbcomponent.h File Reference

Classes

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

pGroupName	Set the Name of the Group from which unregister an object.
pEntryName	Set the name of the Object to unregister.
nth	Set the occurence of the object to remove.