This reference page is linked to from the following overview topics: MotionBuilder 2013, Your First Python Program, FBComponent - The Base Entity Class, FBModel - Transformation Data and the Scene Graph.

Basic system interaction. More...

#include
<kaydaradef.h>

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbdata.h>
#include <fbsdk/fbio.h>
#include <fbsdk/fbshader.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbevaluateinfo.h>
#include <fbsdk/fbaudio.h>
#include <fbsdk/fbvideo.h>
#include <fbsdk/fbdeck.h>
#include <fbsdk/fbassetmng.h>
#include <fbsdk/fbmanipulator.h>

Go to the source code of this file.

Classes
class	FBSystem
	Provides access to the underlying system, and the MotionBuilder scene. More...
class	FBTriggerManager
	Trigger engine management. More...
class	FBBatchOptions
	Option parameters for the batch process. More...
class	FBPlotOptions
	Option parameters for plotting. More...
class	FBAudioRenderOptions
	Audio Render Options structure. More...
class	FBApplication
	FBApplication is used mainly to manage files. More...
class	FBPlayerControl
	Player control. More...
class	FBEvaluateManager
class	FBKeyControl
	Key control. More...
class	FBPointCacheManager
	Point Cache Manager Interface to the point cache manager. More...
class	FBEventFileChange
	File change event class. More...
class	FBFileMonitoringManager
	File Change Monitornig Interface to the file change monitoring. More...
class	FBCriticalSection
	High priority critical section class. More...
class	FBFastLock
	FBFastLock. More...
class	FBReferenceTime
	Reference time class. More...
class	FBVisitDirectoryCallback
	Loop over directory content. More...
Defines
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
Typedefs
typedef FBVideoGrabOptions *	HFBVideoGrabOptions
	typedef FBVideoGrabOptions* HFBVideoGrabOptions;
typedef class FBSDK_DLL FBArrayTemplate< FBPickInfos >	FBPickInfosList
	typedef class FBSDK_DLL FBArrayTemplate<FBPickInfos> FBPickInfosList
typedef FBAudioRenderOptions *	HFBAudioRenderOptions
	typedef FBAudioRenderOptions* HFBAudioRenderOptions
typedef void(*	kFBEvaluationGlobalFunctionCallback )(FBEvaluateInfo *pEvaluteInfo)
Enumerations
enum	FBBatchProcessType { kFBBatchProcessTypeLoad, kFBBatchProcessTypeSave, kFBBatchProcessTypeConvert }
	Different process type for the batch. More...
enum	FBBatchFileFormat { kFBBatchFileFormatTRC, kFBBatchFileFormatC3D, kFBBatchFileFormatAMC, kFBBatchFileFormatBVH, kFBBatchFileFormatHTR, kFBBatchFileFormatFBX }
	Different file formats for the batch. More...
enum	FBBatchOnTakeExist { kFBBatchOnTakeExistOverwrite, kFBBatchOnTakeExistSkip }
	Different actions to perform when a take already exist while in a batch process. More...
enum	FBBatchOnContainsBatchTakes { kFBBatchOnContainsBatchTakesSaveBatchTakesOnly, kFBBatchOnContainsBatchTakesSaveAllTakes }
	Different actions to perform when a scene already contains batch takes while in a batch process. More...
enum	FBBatchStatus { kFBBatchStatusSuccess, kFBBatchStatusError, kFBBatchStatusCharacterNotSpecified, kFBBatchStatusCharacterNotCharacterized, kFBBatchStatusCharacterHasNoReference, kFBBatchStatusInputActorNotSpecified, kFBBatchStatusActorInputMarkersetNotSpecified, kFBBatchStatusActorInputMarkersetHasNoReferenceModel, kFBBatchStatusActorInputMarkersetNotCorrectlyAssociated, kFBBatchStatusInputCharacterNotCharacterized, kFBBatchStatusInputCharacterHasNoReference, kFBBatchStatusInputDirectoryNotValid, kFBBatchStatusAsfSkeletonFileNotSpecified, kFBBatchStatusCantOpenAsfSkeletonFile, kFBBatchStatusOutputDirectoryNotValid }
	Different return values of the Batch process. More...
enum	FBRotationFilter { kFBRotationFilterNone, kFBRotationFilterGimbleKiller, kFBRotationFilterUnroll }
	Rotation filters. More...
enum	FBViewerMode { kFBViewerModeOneWindow, kFBViewerModeTwoWindow, kFBViewerModeThreeWindow, kFBViewerModeFourWindow, kFBViewerModeSchematic }
	Different viewer modes for the 3D viewer. More...
enum	FBTransportMode { kFBTransportPlay, kFBTransportPlayPrepare, kFBTransportPlayReady, kFBTransportStop, kFBTransportStopPost, kFBTransportStopReady, kFBTransportShuttle, kFBTransportShuttlePrepare, kFBTransportShuttleReady, kFBTransportPlayReverse, kFBTransportPlayReversePrepare, kFBTransportPlayReverseReady, kFBTransportJog, kFBTransportJogPrepare, kFBTransportJogReady, kFBTransportGoto, kFBTransportGotoPrepare, kFBTransportGotoReady, kFBTransportStepForward, kFBTransportStepForwardPrepare, kFBTransportStepForwardReady, kFBTransportStepBackward, kFBTransportStepBackwardPrepare, kFBTransportStepBackwardReady }
	Transport modes. More...
enum	FBTransportTimeFormat { kFBTimeFormatTimecode, kFBTimeFormatFrame }
	Available transport control time display. More...
enum	FBTransportPlaySpeed { kFBSpeed_1_10x, kFBSpeed_1_5x, kFBSpeed_1_4x, kFBSpeed_1_3x, kFBSpeed_1_2x, kFBSpeed_1x, kFBSpeed_ALL_FR, kFBSpeed_2x, kFBSpeed_3x, kFBSpeed_4x, kFBSpeed_5x, kFBSpeed_10x }
	Available transport control play speed. More...
enum	FBTransportSnapMode { kFBTransportSnapModeNoSnap, kFBTransportSnapModeSnapOnFrames, kFBTransportSnapModePlayOnFrames, kFBTransportSnapModeSnapAndPlayOnFrames }
	Available snap methods for the transport control. More...
enum	FBParallelScheduleType { kFBParallelScheduleSerial, kFBParallelScheduleSimple, kFBParallelScheduleAdvanced }
	DEPRICATED use ParallelEvaluation on FBEvaluateManager insteadAvailable DAG parallel schedule algorithm More...
enum	FBGlobalEvalCallbackTiming { kFBGlobalEvalCallbackBeforeDAG, kFBGlobalEvalCallbackAfterDAG, kFBGlobalEvalCallbackAfterDeform }
	Global Evaluation callback timing. More...
enum	FBFileMonitoringType { kFBFileMonitoring_InvalidIndex, kFBFileMonitoring_MAINSCENE, kFBFileMonitoring_ANIMATIONCLIP }
	File Monitoring Type. More...
Functions
	FB_FORWARD (FBCharacter)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Take)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Renderer)
FBSDK_DLL HIObject	FBGetFBObject (HIObject pObject, bool pAutoCreate=false)
	Get the SDK object from an Internal Object.
template<class T >
T *	FBCast (HIObject pObject, bool pAutoCreate=false)
	Cast the SDK object using it's IObject interface into the proper class.
	__FB_FORWARD (FBSystem)
	__FB_FORWARD (FBTriggerManager)
	FB_FORWARD (FBBatchOptions)
	FB_DEFINE_ENUM (FBSDK_DLL, BatchProcessType)
	FB_DEFINE_ENUM (FBSDK_DLL, BatchFileFormat)
	FB_DEFINE_ENUM (FBSDK_DLL, BatchOnTakeExist)
	FB_DEFINE_ENUM (FBSDK_DLL, BatchOnContainsBatchTakes)
	FB_FORWARD (FBPlotOptions)
	FB_DEFINE_ENUM (FBSDK_DLL, RotationFilter)
	FB_FORWARD (FBAudioRenderOptions)
	__FB_FORWARD (FBApplication)
	__FB_FORWARD (FBCharacter)
	__FB_FORWARD (FBActor)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Character)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Actor)
	__FB_FORWARD (FBPlayerControl)
	FB_DEFINE_ENUM (FBSDK_DLL, TransportMode)
	FB_DEFINE_ENUM (FBSDK_DLL, TransportTimeFormat)
	FB_DEFINE_ENUM (FBSDK_DLL, TransportPlaySpeed)
	FB_DEFINE_ENUM (FBSDK_DLL, TransportSnapMode)
	FB_DEFINE_ENUM (FBSDK_DLL, ParallelScheduleType)
	__FB_FORWARD (FBEvaluateManager)
	Evaluate Manager.
	__FB_FORWARD (FBKeyControl)
	__FB_FORWARD (FBPointCacheManager)
	__FB_FORWARD (FBFileMonitoringManager)
	FB_DEFINE_ENUM (FBSDK_DLL, FileMonitoringType)
	__FB_FORWARD (FBEventFileChange)
	FB_FORWARD (FBCriticalSection)
	FB_FORWARD (FBFastLock)
	__FB_FORWARD (FBReferenceTime)
FBSDK_DLL FBModelList *	FBCreateModelList ()
	Create a FBModelList object.
FBSDK_DLL void	FBDestroyModelList (FBModelList *pModelList)
	Delete a FBModelList object.
FBSDK_DLL FBPickInfosList *	FBCreatePickInfosList ()
	Create a FBPickInfosList object.
FBSDK_DLL void	FBDestroyPickInfosList (FBPickInfosList *pPickInfosList)
	Delete a FBPickInfosList object.
FBSDK_DLL FBPlugList *	FBCreatePlugList ()
	Create a FBPlugList object.
FBSDK_DLL void	FBDestroyPlugList (FBPlugList *pPlugList)
	Delete a FBObjectList object.
FBSDK_DLL FBComponentList *	FBCreateComponentList ()
	Create a FBObjectList object.
FBSDK_DLL void	FBDestroyComponentList (FBComponentList *pObjectList)
	Delete a FBObjectList object.
FBSDK_DLL void	FBSleep (kULong MilliSeconds)
	Sleep function Puts system to sleep for specified time.
FBSDK_DLL void	FBSchedulingDependencyOutput (bool pEnable)
	Debug function for MT dependency debug.
K_DEPRECATED FBSDK_DLL FBModel *	FBFindModelByName (const char pModelName, FBModel pParent=NULL)
FBSDK_DLL FBModel *	FBFindModelByLabelName (const char *pModelLabelName)
	Find a model in the scene by its label name.
FBSDK_DLL FBModel *	FBFindModelByUniqueColorId (const FBColor &pColor)
	Find a model in the scene by its unique color id.
FBSDK_DLL FBModel *	FBLoadFbxPrimitivesModel (const char *pModelName)
	Load a model.
FBSDK_DLL void	FBFindModelsOfType (FBModelList &pList, int pTypeInfo, FBModel *pParent=NULL)
	Find all models of a certain type in the scene.
FBSDK_DLL void	FBGetSelectedModels (FBModelList &pList, FBModel *pParent=NULL, bool pSelected=true, bool pSortBySelectOrder=false)
	Find all models that are selected (if `pSelected` is true) Searches recursively from a root model for models that are selected, and adds them to a list of models.
FBSDK_DLL void	FBFindObjectsByName (const char *pNamePattern, FBComponentList &pList, bool pIncludeNamespace=true, bool pModelsOnly=false)
	FBFindObjectsByName.
FBSDK_DLL FBComponent *	FBFindObjectByFullName (const char *pObjectFullName)
	FBFindObjectByFullName.
FBSDK_DLL int	FBDeleteObjectsByName (const char pNamePattern, const char pNameSpace=NULL, const char *pGroupName=NULL)
	FBDeleteObjectsByName.
FBSDK_DLL void	FBBeginChangeAllModels ()
	Call begin change to all models (need to be closed).
FBSDK_DLL void	FBEndChangeAllModels ()
	Call end change to all models (should be first open).
FBSDK_DLL void	FBMergeTransactionBegin ()
	Call begin merge multiple files (need to be closed).
FBSDK_DLL void	FBMergeTransactionEnd ()
	Call end merge multiple files (should be first open).
FBSDK_DLL void	FBTrace (const char *pFormatString,...)
	This function prints useful debugging strings in the console.
FBSDK_DLL void	FBMakeFullPath (FBString &pFullPath, const char pRootPath, const char pFilePath)
	Get the given file's full path.
FBSDK_DLL bool	FBPopNormalTool (const char *pToolName, bool pSetFocus=true)
	This function is used to bring up a specific tool in the GUI.

Detailed Description

Basic system interaction.

The FBSystem file contains the necessary data structure to interface with the underlying system.

Definition in file fbsystem.h.

Define Documentation

#define FBSDK_DLL K_DLLIMPORT

kFBBatchProcessTypeLoad	Load the files and plot the character with every take. Search for all occurrences
kFBBatchProcessTypeSave	Save the takes in different files. Search for all occurrences
kFBBatchProcessTypeConvert	Does the load and save. Search for all occurrences

kFBBatchFileFormatTRC	File format for Motion Analysis TRC. Search for all occurrences
kFBBatchFileFormatC3D	File format for Vicon C3D. Search for all occurrences
kFBBatchFileFormatAMC	File format for Acclaim AMC. Search for all occurrences
kFBBatchFileFormatBVH	File format for Biovision BVH. Search for all occurrences
kFBBatchFileFormatHTR	File format for Motion Analysis HTR. Search for all occurrences
kFBBatchFileFormatFBX	File format for FBX (animation only). Search for all occurrences

kFBBatchOnTakeExistOverwrite	Overwrite the take. Search for all occurrences
kFBBatchOnTakeExistSkip	Skip the take. Search for all occurrences

kFBBatchOnContainsBatchTakesSaveBatchTakesOnly	Save only the batch takes. Search for all occurrences
kFBBatchOnContainsBatchTakesSaveAllTakes	Save all the takes. Search for all occurrences

kFBBatchStatusSuccess	Search for all occurrences
kFBBatchStatusError	Search for all occurrences
kFBBatchStatusCharacterNotSpecified	Search for all occurrences
kFBBatchStatusCharacterNotCharacterized	Search for all occurrences
kFBBatchStatusCharacterHasNoReference	Search for all occurrences
kFBBatchStatusInputActorNotSpecified	Search for all occurrences
kFBBatchStatusActorInputMarkersetNotSpecified	Search for all occurrences
kFBBatchStatusActorInputMarkersetHasNoReferenceModel	Search for all occurrences
kFBBatchStatusActorInputMarkersetNotCorrectlyAssociated	Search for all occurrences
kFBBatchStatusInputCharacterNotCharacterized	Search for all occurrences
kFBBatchStatusInputCharacterHasNoReference	Search for all occurrences
kFBBatchStatusInputDirectoryNotValid	Search for all occurrences
kFBBatchStatusAsfSkeletonFileNotSpecified	Search for all occurrences
kFBBatchStatusCantOpenAsfSkeletonFile	Search for all occurrences
kFBBatchStatusOutputDirectoryNotValid	Search for all occurrences

kFBRotationFilterNone	Search for all occurrences
kFBRotationFilterGimbleKiller	Search for all occurrences
kFBRotationFilterUnroll	Search for all occurrences

kFBViewerModeOneWindow	View one pane. Search for all occurrences
kFBViewerModeTwoWindow	View two panes. Search for all occurrences
kFBViewerModeThreeWindow	View three panes. Search for all occurrences
kFBViewerModeFourWindow	View four panes. Search for all occurrences
kFBViewerModeSchematic	Schematic view. Search for all occurrences

kFBTransportPlay	Search for all occurrences
kFBTransportPlayPrepare	!< Play mode Search for all occurrences
kFBTransportPlayReady	Search for all occurrences
kFBTransportStop	Search for all occurrences
kFBTransportStopPost	!< Stop mode Search for all occurrences
kFBTransportStopReady	Search for all occurrences
kFBTransportShuttle	Search for all occurrences
kFBTransportShuttlePrepare	!< Shuttle mode Search for all occurrences
kFBTransportShuttleReady	Search for all occurrences
kFBTransportPlayReverse	Search for all occurrences
kFBTransportPlayReversePrepare	!< Play reverse. Search for all occurrences
kFBTransportPlayReverseReady	Search for all occurrences
kFBTransportJog	Search for all occurrences
kFBTransportJogPrepare	!< Jog. Search for all occurrences
kFBTransportJogReady	Search for all occurrences
kFBTransportGoto	Search for all occurrences
kFBTransportGotoPrepare	!< Goto. Search for all occurrences
kFBTransportGotoReady	Search for all occurrences
kFBTransportStepForward	Search for all occurrences
kFBTransportStepForwardPrepare	!< Step forward Search for all occurrences
kFBTransportStepForwardReady	Search for all occurrences
kFBTransportStepBackward	Search for all occurrences
kFBTransportStepBackwardPrepare	!< Step backward. Search for all occurrences
kFBTransportStepBackwardReady	Search for all occurrences

kFBTimeFormatTimecode	Timecode time display mode. Search for all occurrences
kFBTimeFormatFrame	Frame time display mode. Search for all occurrences

kFBSpeed_1_10x	1/10x. Search for all occurrences
kFBSpeed_1_5x	1/5x Search for all occurrences
kFBSpeed_1_4x	1/4x Search for all occurrences
kFBSpeed_1_3x	1/3x Search for all occurrences
kFBSpeed_1_2x	1/2x Search for all occurrences
kFBSpeed_1x	1x Search for all occurrences
kFBSpeed_ALL_FR	All frames. Search for all occurrences
kFBSpeed_2x	2x Search for all occurrences
kFBSpeed_3x	3x Search for all occurrences
kFBSpeed_4x	4x Search for all occurrences
kFBSpeed_5x	5x Search for all occurrences
kFBSpeed_10x	10x Search for all occurrences

kFBParallelScheduleSerial	No parallel schedule, use sequential evaluation order instead. Search for all occurrences
kFBParallelScheduleSimple	Simple parallel schedule, mainly analyze the task dependency based on Motion Hierarchy (scene graph), but don't across active constraint. Search for all occurrences
kFBParallelScheduleAdvanced	Advanced parallel schedule, task dependency analyzation will be able to across ative constraint, and plus motion hierarchy. Search for all occurrences

kFBGlobalEvalCallbackBeforeDAG	The callback will be executed before any DAG (Transformation & Deformation) evaluation tasks. Search for all occurrences
kFBGlobalEvalCallbackAfterDAG	The callback will be executed after all DAG (Transformation & Deformation) evaluation tasks. Search for all occurrences
kFBGlobalEvalCallbackAfterDeform	The callback will be executed after all deformation tasks. Search for all occurrences

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

T* FBCast	(	HIObject	pObject,
		bool	pAutoCreate = `false`
	)		`[inline]`

kFBTransportSnapModeNoSnap	No snapping is applied. Search for all occurrences
kFBTransportSnapModeSnapOnFrames	Snaps to an exact frame when modifying the current time. Search for all occurrences
kFBTransportSnapModePlayOnFrames	When playing, plays to exact frames. Search for all occurrences
kFBTransportSnapModeSnapAndPlayOnFrames	Combines both Snap and Play on frames modes. Search for all occurrences

kFBFileMonitoring_InvalidIndex	Invalid value. Search for all occurrences
kFBFileMonitoring_MAINSCENE	Main Scene change monitoring. Search for all occurrences
kFBFileMonitoring_ANIMATIONCLIP	Animation clip change monitoring. Search for all occurrences

FBSDK_DLL HIObject FBGetFBObject	(	HIObject	pObject,
		bool	pAutoCreate = `false`
	)

K_DEPRECATED FBSDK_DLL FBModel* FBFindModelByName	(	const char *	pModelName,
		FBModel *	pParent = `NULL`
	)

pModelName	Name of model to search for. Could be "FullName", "LabelName" or "ObjectName".
pParent	Root model to search from (default=NULL(root)).

FBSDK_DLL void FBFindModelsOfType	(	FBModelList &	pList,
		int	pTypeInfo,
		FBModel *	pParent = `NULL`
	)

pTypeInfo	Model type to look for.
pParent	Root model to look from (default=NULL(root)).

FBSDK_DLL void FBGetSelectedModels	(	FBModelList &	pList,
		FBModel *	pParent = `NULL`,
		bool	pSelected = `true`,
		bool	pSortBySelectOrder = `false`
	)

pParent	Root model to look from (default=NULL(root)).
pSelected	true to find selected models, false to find unselected models(default=true).
pSortBySelectOrder	true to sort the result by selection order, first selected model in the first part of the list; false to sort the result by scene graph order

FBSDK_DLL void FBFindObjectsByName	(	const char *	pNamePattern,
		FBComponentList &	pList,
		bool	pIncludeNamespace = `true`,
		bool	pModelsOnly = `false`
	)

fbsystem.h File Reference

Classes

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

pNamePattern	Indicate the name pattern to search. This pattern can contain any amount of . (ex: trmodscene )
pList	List that contains the objects
pIncludeNamespace	Does the search use the complete name (with namespace)
pModelsOnly	Is the search on models or all types of objects

FBSDK_DLL int FBDeleteObjectsByName	(	const char *	pNamePattern,
		const char *	pNameSpace = `NULL`,
		const char *	pGroupName = `NULL`
	)

pNamePattern	if not NULL, indicate the name pattern to search. This pattern can contain any amount of . (ex: trmodscene ). if is NULL or Empty string, "*" will be used for match all.
pNameSpace	if not NULL, the objects must be inside the given namespace.
pGroupName	if not NULL, indicate the object group name (type).

FBSDK_DLL void FBMakeFullPath	(	FBString &	pFullPath,
		const char *	pRootPath,
		const char *	pFilePath
	)

FBSDK_DLL bool FBPopNormalTool	(	const char *	pToolName,
		bool	pSetFocus = `true`
	)

pToolName	The name of the tool as shown in the Open Reality menu.
pSetFocus	Indicate if the tool will have the focus.