Classes
class	FBAccessMode
	pyfbsdk More...

class	FBActionManager
	Action Manager class. More...

class	FBActor
	FBActor is used to link motion data to a character. More...

class	FBActorFace
	Used to plot actor face animation. More...

class	FBAlphaSource
	Shader transparency computation. More...

class	FBAnimationLayer
	Used to access animation layer properties and modify them. More...

class	FBAnimationLayerMergeOptions
	Merge option for animation layers. More...

class	FBAnimationNode
	See samples: CopyAnimation.py, ClearKeysOnSelectedModels.py, TraversingRelationConstraint.py, FCurveEditor.py. More...

class	FBAnimationNodeConnectorType
	Different types for the animation node connectors. More...

class	FBApplication
	FBApplication is used mainly to manage files. More...

class	FBArrangeMode
	Modes for arranging objects in schematic view. More...

class	FBArrowButton
	Creates a button which opens a layout to display content. More...

class	FBAssetFile
	Class representing a file stored in a version control database. More...

class	FBAssetFolder
	Class representing a folder stored in a version control database. More...

class	FBAssetItem
	Base class for all managed assets. More...

class	FBAssetMng
	Used to access asset manager functionity to get files locally or from a server. More...

class	FBAssetMngFileOptions
	Behavior of the application when working with managed files. More...

class	FBAssetMngMenuOptions
	Show or hide version control menu items. More...

class	FBAttachType
	Types of attachments between UI regions. More...

class	FBAttenuationType
	Light attenuation types. More...

class	FBAudioBitDepthMode
	Enum FBAudioBitDepthMode. More...

class	FBAudioChannelMode
	Enum FBAudioChannelMode. More...

class	FBAudioClip
	Used to play audio clips and access their properties. More...

class	FBAudioIn
	Audio In class. More...

class	FBAudioOut
	Audio Out class. More...

class	FBAudioOutputLocation
	Type of locations where the audio is rendered when rendering a scene using a video format. More...

class	FBAudioRateMode
	Enum FBAudioRateMode. More...

class	FBAudioRenderOptions
	Audio Render Options structure. More...

class	FBBatchFileFormat
	Different file formats for the batch. More...

class	FBBatchOnContainsBatchTakes
	Different actions to perform when a scene already contains batch takes while in a batch process. More...

class	FBBatchOnTakeExist
	Different actions to perform when a take already exist while in a batch process. More...

class	FBBatchOptions
	Option parameters for the batch process. More...

class	FBBatchProcessType
	Different process type for the batch. More...

class	FBBatchStatus
	Different return values of the Batch process. More...

class	FBBodyNodeId
	All body nodes. More...

class	FBBodyPartId
	Body part for character. More...

class	FBBorderStyle
	Different border types available. More...

class	FBBox
	A box is a fundamental building block in the application architecture. More...

class	FBBoxPlaceHolder
	Wrapper around a specific instance of a FBBox object. More...

class	FBBrowsingProperty
	Property browsing. More...

class	FBButton
	Used to create and manage buttons in a user interface. More...

class	FBButtonLook
	Button look. More...

class	FBButtonState
	Possible button states. More...

class	FBButtonStyle
	Style of buttons. More...

class	FBCamera
	Creates custom cameras and manages system cameras. More...

class	FBCameraAntiAliasingMethod
	Antialiasing methods. More...

class	FBCameraApertureMode
	Aperture modes. More...

class	FBCameraDistanceMode
	Camera plane distance modes. More...

class	FBCameraFilmBackType
	Filmback types. More...

class	FBCameraFocusDistanceSource
	Focus distance sources. More...

class	FBCameraFrameSizeMode
	Frame size modes. More...

class	FBCameraMatrixType
	Camera matrix types in OpenGL convention. More...

class	FBCameraResolutionMode
	Resolution modes. More...

class	FBCameraSafeAreaMode
	Safe area modes. More...

class	FBCameraSamplingType
	Antialiasing sampling types. More...

class	FBCameraStereo

class	FBCameraStereoType

class	FBCameraSwitcher
	Camera switcher. More...

class	FBCameraType
	Focus distance types. More...

class	FBCameraViewPlaneMode
	Camera plane viewing modes. More...

class	FBCellStyle
	Different styles of spreadsheet cell styles. More...

class	FBCharacter
	A character is the link between a motion source and a character model. More...

class	FBCharacterContactBehaviour
	Character Contact Behaviour. More...

class	FBCharacterExtension
	Objects Grouping class. More...

class	FBCharacterExtensionRetargetMode
	Character extension Retarget Mode More...

class	FBCharacterExtensionStancePoseMode
	Character Extension Stance Pose mode when the stance pose is activated on a character. More...

class	FBCharacterFace
	Animates a character face using an actor as input. More...

class	FBCharacterHipsTranslationMode
	Character Hips Translation modes. More...

class	FBCharacterInputType
	Character Input/Output types. More...

class	FBCharacterKeyingMode
	Character keying modes. More...

class	FBCharacterLoadAnimationMethod
	This enumeration is used to choose how to load an animation file on a character. More...

class	FBCharacterMarkerSet
	Character marker set class. More...

class	FBCharacterPlotWhere
	Where to plot a character. More...

class	FBCharacterPose
	Used to work with character poses. More...

class	FBCharacterPoseFlag
	Character Pose Options flags. More...

class	FBCharacterPoseKeyingMode
	Character Pose Keying Mode. More...

class	FBCharacterPoseOptions
	Stores options for operations on poses. More...

class	FBCharacterResetProperties
	Character Reset Properties Type. More...

class	FBCharacterRollSolver
	Character Roll Solver version. More...

class	FBCharacterSolver
	Constraint class. More...

class	FBClipEnd
	Clip end actions. More...

class	FBCluster
	Weighting interface for meshes. More...

class	FBClusterMode
	Different clustering modes. More...

class	FBColor
	Color vector. More...

class	FBColorAndAlpha
	Color and alpha vector. More...

class	FBCommPortType
	Communication port type. More...

class	FBCommType
	Communications type. More...

class	FBCommandState
	FBCommandState. More...

class	FBComponent
	MotionBuilder SDK base class. More...

class	FBConfigFile
	Interface to the application config files. More...

class	FBConnectionAction
	Possible actions when a notify plug event occurs. More...

class	FBConnectionType
	Connection types available between plugs. More...

class	FBConsoleChannelType
	Console channel types. More...

class	FBConstraint
	Base class for constraints. More...

class	FBConstraintInfo
	Constraint information class. More...

class	FBConstraintManager
	Constraint manager. More...

class	FBConstraintRelation
	ConstraintRelation class. More...

class	FBConstraintSolver
	Base class for constraint solver. More...

class	FBConstructionHistory
	Access to global construction history functionality. More...

class	FBConstructionHistoryState
	Construction history manager state. More...

class	FBConstructionOperation
	FBConstructionOperation is used to represent an operation in the construction history. More...

class	FBControlSet
	Control set class. More...

class	FBControlSetType
	Character ControlSet type. More...

class	FBControllerMode
	Controller modes for optical model. More...

class	FBCycleAnalysisNode
	Cycle Analysis class. More...

class	FBCycleCreator
	See sample: CycleCreator.py. More...

class	FBDataAsStringFlag
	FBDataAsStringFlag. More...

class	FBDeck
	Interface to a tape deck. More...

class	FBDeckTransportMode
	FBDeckTransportMode. More...

class	FBDeformer
	Base Model deformer class. More...

class	FBDeformerPointCache
	Base Model deformer class. More...

class	FBDeformerType
	Determine the deformer type. More...

class	FBDevice
	Base Device class. More...

class	FBDeviceInstrument
	Instrument abstraction layer. More...

class	FBDeviceKeyboardKey
	Keyboard keys (for input). More...

class	FBDeviceNotifyInfo
	Device Input and Output Notification information structure. More...

class	FBDeviceOptical
	Optical device class. More...

class	FBDeviceOpticalMarker
	Device optical marker. More...

class	FBDeviceSamplingMode
	Recording types. More...

class	FBDirMap

class	FBDisplayMode
	Model display options. More...

class	FBDisplayWhat
	Model display mask This mask determines what types of models are displayed by the renderer. More...

class	FBDragAndDropState
	State of Drag and Drop. More...

class	FBEdit
	Text edit box. More...

class	FBEditColor
	Color edit widget. More...

class	FBEditNumber
	Number edit box. More...

class	FBEditProperty
	Property editor widget. More...

class	FBEditPropertyModern
	Property editor widget. More...

class	FBEditTimeCode

class	FBEditVector
	Vector edit widget. More...

class	FBEffectorId
	All effector nodes. More...

class	FBEffectorSetID
	Effector ID identifier. More...

class	FBElementAction
	Enumeration that describe the different actions available on a scene element depending on the current context. More...

class	FBEvaluateInfo
	AnimationNodeNotify evaluation information. More...

class	FBEvaluateManager

class	FBEvent
	Base Event class. More...

class	FBEventActivate
	Activation event. More...

class	FBEventAnimationNodeType
	Event based on animation node. More...

class	FBEventClipChange

class	FBEventConnectionDataNotify
	Connection notify event class. More...

class	FBEventConnectionKeyingNotify

class	FBEventConnectionNotify
	Connection notify event class. More...

class	FBEventConnectionStateNotify
	Connection notify event class. More...

class	FBEventDblClick
	Input event class. More...

class	FBEventDragAndDrop
	Drag and drop interface.b>Event: Global Evaluation pipeline critical timing callback event. More...

class	FBEventEvalGlobalCallback

class	FBEventExpose
	Event sent when a control needs to be displayed. More...

class	FBEventFileChange
	File change event class. More...

class	FBEventInput
	Input event class. More...

class	FBEventMenu
	Menu event. More...

class	FBEventOverrideFileOpen
	Event that is called before a file open/merge. More...

class	FBEventPlayerControlChange

class	FBEventResize
	Event sent to a control that resizes. More...

class	FBEventSceneChange
	Select model event class. More...

class	FBEventShow
	Show event class. More...

class	FBEventSpread
	Spreadsheet event. More...

class	FBEventTakeChange
	Take change event class. More...

class	FBEventTransaction
	Transaction event. More...

class	FBEventTree
	FBTree node event. More...

class	FBEventTreeSelect
	FBTree selection event.b>Event: Video Frame offline Rendering Event. More...

class	FBEventVideoFrameRendering

class	FBExistingClipAction
	Action to perform, when preparing an Audio In object to record, when the action clip associated to the recording path is already in the scene. More...

class	FBExistingFileAction
	Action to perform, when preparing an Audio In object to record, when the action clip associated to the recording path already exists on disk and is not empty. More...

class	FBExtrapolationMode
	Modes for pre / post extrapolation. More...

class	FBFCurve
	FCurve class. More...

class	FBFCurveEditor
	FCurve editor. More...

class	FBFCurveEditorUtility
	FBFCurveEditor Utility class Utility class allowing different operations on a FBFCurveEditor or on the main FCurveEditor. More...

class	FBFCurveEvent
	This class is used when a modification is made on a FCurve. More...

class	FBFCurveEventManager
	FCurve Event Manager Interface to the FBFCurveEventManager. More...

class	FBFCurveEventType
	This enum indicates what modification was made to a tracked FCurve. More...

class	FBFCurveKey
	KeyFrame for an FCurve. More...

class	FBFbxOptions
	Customize file loading and saving. More...

class	FBFileFormatAndVersion

class	FBFileMonitoringManager
	File Change Monitoring Interface to the file change monitoring. More...

class	FBFileMonitoringType
	File Monitoring Type. More...

class	FBFilePopup
	File Popup (for open/save). More...

class	FBFilePopupStyle
	Different types of file popup windows. More...

class	FBFileReference
	Objects Containing class. More...

class	FBFilter
	Filters are used to modify motion capture data. More...

class	FBFilterManager
	Filter manager. More...

class	FBFilterType
	Filter types. More...

class	FBFloorContactID
	Floor contact for the given index. More...

class	FBFogMode
	Fog falloff modes. More...

class	FBFolder
	Folder class. More...

class	FBFolderPopup
	Folder Popup (for selecting a directory). More...

class	FBGapMode
	Gap interpolation modes. More...

class	FBGenerationMode
	Generation modes for optical model. More...

class	FBGenericMenu
	A GenericMenu class. More...

class	FBGenericMenuItem
	FBGenericMenuItem This class stores data for a single menu item. More...

class	FBGeometry
	Geometry class. More...

class	FBGeometryArrayElementType
	Type of data when requesting an array. More...

class	FBGeometryArrayID
	ID to use when requesting a specific array of data for a model. More...

class	FBGeometryMappingMode
	Determine how the element is mapped on a surface. More...

class	FBGeometryReferenceMode
	Determine how the mapping information is stored in the array of coordinate. More...

class	FBGlobalEvalCallbackTiming
	Global Evaluation callback timing. More...

class	FBGlobalLight
	Global light class. More...

class	FBGroup
	Objects Grouping class. More...

class	FBHUD
	Heads Up display. More...

class	FBHUDBloopSlateElement
	Heads Up display. More...

class	FBHUDElement
	Heads Up display. More...

class	FBHUDElementHAlignment

class	FBHUDElementVAlignment

class	FBHUDFlashElement
	Heads Up display. More...

class	FBHUDManager

class	FBHUDRectElement
	Heads Up display. More...

class	FBHUDTextElement
	Heads Up display. More...

class	FBHUDTextureElement
	Heads Up display. More...

class	FBHUDTimelineElement
	Heads Up display. More...

class	FBHandle
	FBHandle class exposes the Handle object of the application. More...

class	FBIconPosition
	Different icon positions possible. More...

class	FBImage
	Image class. More...

class	FBImageContainer
	Image. More...

class	FBImageFormat
	Image formats. More...

class	FBImageInterleaveType
	Image field interleave types. More...

class	FBImageInterpolationType
	Image interpolation types. More...

class	FBImageType
	Image types. More...

class	FBInputKey
	Keyboard inputs. More...

class	FBInputModifier
	Input Modifiers (Ctrl, Alt, Shift). More...

class	FBInputType
	Types of input events. More...

class	FBInsertSegmentMode
	Insert segment modes. More...

class	FBInterpolation
	Types of interpolation for an FCurve. More...

class	FBInterpolatorCurveType
	Types of interpolator for an FCurve. More...

class	FBKeyControl
	Key control. More...

class	FBKeyingGroup
	KeyingGroup class. More...

class	FBKeyingGroupType
	Keying group types. More...

class	FBLabel
	Text label. More...

class	FBLayerMode
	Layer mode. More...

class	FBLayerRotationMode
	Rotation mode for layer. More...

class	FBLayeredTexture
	LayeredTexture class. More...

class	FBLayout
	Used to build the user interface. More...

class	FBLayoutRegion
	Layout region. More...

class	FBLight
	Light class. More...

class	FBLightType
	Light types. More...

class	FBList
	List of items. More...

class	FBListStyle
	List style or direction. More...

class	FBManipulator
	Manipulator class. More...

class	FBManipulatorPickType
	Types of manipulator picking. More...

class	FBManipulatorTransformType
	Manipulator transform stles. More...

class	FBMarkerLook
	Look of the marker. More...

class	FBMarkerResolutionLevel
	Resolution of marker mesh sphere and capsule (Quality). More...

class	FBMarkerSet
	Marker set class. More...

class	FBMarkerType
	Type of the marker. More...

class	FBMaterial
	Material class. More...

class	FBMaterialTextureType
	Various Material texture channels' type. More...

class	FBMatrix
	Four x Four (double) Matrix. More...

class	FBMemo
	Multi-line text input. More...

class	FBMenuItemType
	Types of menu items available. More...

class	FBMenuManager
	The menu manager allows access to MotionBuilder menu bar. More...

class	FBMergeLayerMode
	Merge layer mode for animation layers. More...

class	FBMesh
	Mesh class. More...

class	FBMirrorPlaneType
	Mirror Plane Type. More...

class	FBModel
	Model class. More...

class	FBModelCube
	Cube model class. More...

class	FBModelCullingMode
	Model Culling Mode. More...

class	FBModelEvaluationTaskType

class	FBModelHiercharyTraverserType
	Types of hierarchy traverser search type. More...

class	FBModelMarker
	Model marker class. More...

class	FBModelMarkerOptical
	Optical model marker class. More...

class	FBModelNull
	Null object class. More...

class	FBModelOptical
	Optical model class. More...

class	FBModelOpticalAdvanced
	Advanced optical model information. More...

class	FBModelPath3D
	Path 3D model class. More...

class	FBModelPlaceHolder
	Wrapper around a specific instance of a FBModel object. More...

class	FBModelPlane
	Plane model class. More...

class	FBModelRoot
	Root object class. More...

class	FBModelRotationOrder
	Ways to apply Rotation. More...

class	FBModelSelection
	Different model selection available. More...

class	FBModelShadingMode
	Modes for model shading. More...

class	FBModelSkeleton
	Root object class. More...

class	FBModelTemplate
	Model template class. More...

class	FBModelTemplateStyle
	Model template styles When creating model templates, this parameter will affect the actual model created (associated with the model template). More...

class	FBModelTransformationType
	Types of transformation vector/matrices possible. More...

class	FBModelVertexData

class	FBMotionClip
	Motion class. More...

class	FBMotionFileOptions
	Customize motion file loading. More...

class	FBMultiLangManager
	Language manager. More...

class	FBNamespace
	Objects Containing class. More...

class	FBNamespaceAction
	Namespace flags. More...

class	FBNewKeyInterpolationType
	Key Interpolation Type to use when creating new keys. More...

class	FBNote
	Note class. More...

class	FBNurbType
	Surface types. More...

class	FBNurbs
	Nurbs class. More...

class	FBObjectFlag
	Available flags for any component. More...

class	FBObjectPose
	FBObjectPose class. More...

class	FBObjectPoseMirrorOptions
	FBObjectPoseMirrorOptions class. More...

class	FBObjectPoseMirrorOptionsFlag
	ObjectPoseMirrorOptions flags. More...

class	FBObjectPoseOptions
	FBObjectPoseOptions class. More...

class	FBObjectPoseOptionsFlag
	ObjectPoseOptions flags. More...

class	FBObjectStatus
	Available lifetime status for any component. More...

class	FBOneClickApplication
	Possible application for One-Click interop with MotionBuilder. More...

class	FBOpticalGap
	Optical Gap class. More...

class	FBOpticalSegment
	Optical segment class. More...

class	FBOrientation
	General directions for UI components.b> DEPRICATED use ParallelEvaluation on FBEvaluateManager insteadAvailable DAG parallel schedule algorithm. More...

class	FBParallelScheduleType

class	FBParity
	Parity modes. More...

class	FBPatch
	Patch class. More...

class	FBPhysicalProperties
	Base class for physical properties attach to a model. More...

class	FBPickingMode
	3D picking mode. More...

class	FBPlayMode
	Play modes. More...

class	FBPlayerControl
	Player control. More...

class	FBPlayerControlChangeType
	Types of player control change events. More...

class	FBPlotAllowed
	FBPlotAllowed More...

class	FBPlotOptions
	Option parameters for plotting. More...

class	FBPlotPopup
	Plot Popup (for setting options only). More...

class	FBPlotTangentMode
	The tangent mode for plotted curve. More...

class	FBPlug
	Connections Basic Open Reality SDK Element. More...

class	FBPlugModificationFlag

class	FBPlugStatusFlag

class	FBPointCacheFile
	Base Model deformer class. More...

class	FBPointCacheManager
	Point Cache Manager Interface to the point cache manager. More...

class	FBPopup
	Popup window. More...

class	FBPopupInputType
	User input types for a popup. More...

class	FBPose
	Pose class. More...

class	FBPoseTransformType
	Transform mode of pose. More...

class	FBPoseType
	Types of pose. More...

class	FBProfileTaskCycle
	FBProfileTaskCycle. More...

class	FBProfileTimeEvent
	FBProfileTimeEvent. More...

class	FBProfiler
	FBProfiler. More...

class	FBProfilingMode
	Available Profiling modes. More...

class	FBProgress
	Progress bar. b>Property: Base property class. More...

class	FBProperty
	b>Property: Action Action property to trigger function. More...

class	FBPropertyAction

class	FBPropertyAnimatable
	Animatable property base class. More...

class	FBPropertyComponents
	Property Components Bit Field (XYZ, RGB, RGBA, UV, XYZW, etc.). More...

class	FBPropertyConnectionEditor
	Property Connection Editor. More...

class	FBPropertyFlag
	Available flags for FBProperty objects. b>PropertyList: Actor. More...

class	FBPropertyListActor
	b>PropertyList: Actor face. More...

class	FBPropertyListActorFace

class	FBPropertyListAnimationNode
	List of animation nodes.b>List: AudioClip. More...

class	FBPropertyListAudioClip
	b>List: AudioIn More...

class	FBPropertyListAudioIn
	b>List: AudioOut More...

class	FBPropertyListAudioOut
	b>List: Box informations for constraint relation. More...

class	FBPropertyListBox
	b>PropertyList: Camera More...

class	FBPropertyListCamera
	b>PropertyList: Character. More...

class	FBPropertyListCharacter

class	FBPropertyListCharacterExtension
	Character extension property list. b>PropertyList: Character face. More...

class	FBPropertyListCharacterFace
	b>PropertyList: CharacterMarkerSet. More...

class	FBPropertyListCharacterMarkerSet
	b>PropertyList: CharacterPose. More...

class	FBPropertyListCharacterPose
	b>PropertyList: Concrete class for PropertyList of component More...

class	FBPropertyListComponent
	b>PropertyList: Contraint More...

class	FBPropertyListConstraint
	b>PropertyList: Constraint solver More...

class	FBPropertyListConstraintSolver
	b>PropertyList: MarkerSet. More...

class	FBPropertyListControlSet
	b>PropertyList: Deck More...

class	FBPropertyListDeck

class	FBPropertyListDeformer
	b>PropertyList: Device More...

class	FBPropertyListDevice

class	FBPropertyListDeviceInstrument
	List of instruments.b>PropertyList: Device optical marker. More...

class	FBPropertyListDeviceOpticalMarker

class	FBPropertyListFCurveKey
	List of FCurveKey.b>List: FileReference. More...

class	FBPropertyListFileReference
	b>PropertyList: Folder More...

class	FBPropertyListFolder
	b>List: Group More...

class	FBPropertyListGroup
	b>PropertyList: Handle. More...

class	FBPropertyListHUD
	b>PropertyList: Handle. More...

class	FBPropertyListHUDElement
	b>PropertyList: Handle. More...

class	FBPropertyListHandle
	b>PropertyList: KeyingGroup. More...

class	FBPropertyListKeyingGroup
	b>PropertyList: Light More...

class	FBPropertyListLight
	b>PropertyList: Manipulator. More...

class	FBPropertyListManipulator
	b>PropertyList: Device optical marker More...

class	FBPropertyListMarkerSegment
	b>PropertyList: MarkerSet. More...

class	FBPropertyListMarkerSet
	b>PropertyList: Material More...

class	FBPropertyListMaterial
	b>List: Model More...

class	FBPropertyListModel
	b>PropertyList: Device optical marker More...

class	FBPropertyListModelMarkerOptical
	b>PropertyList: ModelOptical. More...

class	FBPropertyListModelOptical
	b>PropertyList: ModelSkeleton. More...

class	FBPropertyListModelSkeleton
	b>PropertyList: ModelTemplate. More...

class	FBPropertyListModelTemplate
	b>PropertyList: ModelTemplateBinding. More...

class	FBPropertyListModelTemplateBinding
	b>List: MotionClip PropertyList: MotionClip More...

class	FBPropertyListMotionClip
	b>List: Namespace More...

class	FBPropertyListNamespace
	b>List: Note More...

class	FBPropertyListNote
	b>List of scene objects. More...

class	FBPropertyListObject
	b>PropertyList: ObjectPose. More...

class	FBPropertyListObjectPose
	b>PropertyList: Device optical marker More...

class	FBPropertyListOpticalGap
	b>PropertyList: Device optical marker More...

class	FBPropertyListOpticalSegment
	b>PropertyList: Physical properties More...

class	FBPropertyListPhysicalProperties
	b>List: Story Clip pivot models More...

class	FBPropertyListPivot
	b>List: Model More...

class	FBPropertyListPose
	b>PropertyList: Texture More...

class	FBPropertyListRendererCallback
	b>PropertyList: Device optical marker More...

class	FBPropertyListRigidBody
	b>PropertyList: Device optical marker More...

class	FBPropertyListRigidBodyMarkers
	b>List: Set More...

class	FBPropertyListSet
	b>PropertyList: Shader More...

class	FBPropertyListShader
	b>List: StoryClip More...

class	FBPropertyListStoryClip
	b>List: Story track Details More...

class	FBPropertyListStoryDetails
	b>List: StoryFolder More...

class	FBPropertyListStoryFolder
	b>List: StorySubTrack More...

class	FBPropertyListStorySubTrack
	b>List: StoryTrack More...

class	FBPropertyListStoryTrack
	b>List: Take More...

class	FBPropertyListTake
	b>PropertyList: Texture More...

class	FBPropertyListTexture

class	FBPropertyListTreeNode
	PropertyList of nodes in the tree view. b>PropertyList: UserObject. More...

class	FBPropertyListUserObject
	b>PropertyList: VideoClip More...

class	FBPropertyListVideoClip
	b>PropertyList: VideoIn More...

class	FBPropertyListVideoIn
	b>PropertyList: VideoOut More...

class	FBPropertyListVideoOut

class	FBPropertyManager
	Property Manager. More...

class	FBPropertyStateEvent
	This class is used when the state of a property tracked by the FBFCurveEventManager is changed. More...

class	FBPropertyStateEventType
	This enum indicates what modification was made to the animation of a tracked property.b>Property class: const char * (String). More...

class	FBPropertyString
	b>Property: StringList More...

class	FBPropertyStringList

class	FBPropertyType
	Property types. More...

class	FBPropertyViewDefinition
	FBProperty View. More...

class	FBPropertyViewList
	FBProperty View List. More...

class	FBPropertyViewManager
	FBProperty View Manager. More...

class	FBPropertyViewType
	Property view set type. More...

class	FBRSType
	RS type for serial port. More...

class	FBRecalcMarkerSetOffset
	Recalculate MarkerSet offset for? More...

class	FBReferenceTime
	Reference time class. More...

class	FBRenderOptions

class	FBRenderer
	Open Reality renderer interface. More...

class	FBRendererCallback
	Open Reality renderer callback interface. More...

class	FBRenderingPass
	Rendering Pass. More...

class	FBRigidBody
	Rigid body class. More...

class	FBRigidBodyMode
	Rigid body modes. More...

class	FBRootHMode

class	FBRootRMode

class	FBRootSpeedMode

class	FBRootXZMode

class	FBRotationFilter
	Rotation filters. More...

class	FBRotationOrder
	Specify the Euler rotation order. More...

class	FBSVector
	Three dimensional scaling vector. More...

class	FBScene
	Access to the MotionBuilder scene. More...

class	FBSceneChangeType
	Types of model selection events. More...

class	FBScrollBox
	Scroll Box This class provides a layout that will be automatically managed with a scrollbar according to the specified width and height. More...

class	FBSegmentMode
	Segment modes. More...

class	FBSet
	Objects Set class. More...

class	FBShader
	Shader class. More...

class	FBShaderLighted
	Lighted shader class. More...

class	FBShaderManager
	Shader manager. More...

class	FBShaderModelInfo

class	FBShaderShadowLive
	Shader Shadow Live class. More...

class	FBShadowFrameType
	Shadow calculation methods. More...

class	FBShadowType
	Shadow types. More...

class	FBSkeletonLook
	Look of the skeleton. More...

class	FBSkeletonNodeId
	All Skeleton nodes. More...

class	FBSkeletonResolutionLevel
	Resolution of skeleton sphere, capsule and stick (Quality). More...

class	FBSkeletonState

class	FBSlider
	Slider. More...

class	FBSpread
	Base spreadsheet class. More...

class	FBSpreadCell
	Spreadsheet cell. More...

class	FBSpreadColumn
	Spreadsheet column. More...

class	FBSpreadPart
	Spreadsheet part. More...

class	FBSpreadRow
	Spreadsheet row. More...

class	FBStereoDisplayMode

class	FBStory
	Story Management class. More...

class	FBStoryClip
	Story Clip class. More...

class	FBStoryClipAlignmentType
	Alignment Types when aligning clips. More...

class	FBStoryClipChangeType
	Types of clip change events, matching KEventClip.eType Expose only kFBStoryClipMoveClip and kFBStoryClipRemoved for now. More...

class	FBStoryClipCompMode
	Compensation Modes for story character clips. More...

class	FBStoryClipGhostTimeMode
	Time mode to display ghost. More...

class	FBStoryClipMatchingRotationType
	Matching Rotation Types, when matching clips to each other. More...

class	FBStoryClipMatchingTimeType
	Matching Time Types, when matching clips to each other. More...

class	FBStoryClipMatchingTranslationType
	Matching Translation, Types when matching clips to each other. More...

class	FBStoryClipMirrorPlane
	Several mirror planes to mirror animation. More...

class	FBStoryClipNodeFunction
	Node function. More...

class	FBStoryClipShowGhostMode
	Show Ghost Modes for story animation clips. More...

class	FBStoryClipSolveMode
	Solve Modes for story character clips. More...

class	FBStoryClipTimeWarpInterpolatorType
	Types of TimeWrap Interpolator for Story Clips. More...

class	FBStoryFolder
	Story Folder class. More...

class	FBStoryGroupClip
	Story Group Clip class. More...

class	FBStoryGroupClipAlignmentType
	Alignment Types when aligning groups. More...

class	FBStoryTrack
	Story Track class. More...

class	FBStoryTrackBodyPart
	Body Parts for story track character. More...

class	FBStoryTrackGhostShowMode
	Ghost Show Modes for story animation tracks. More...

class	FBStoryTrackRefMode
	References Modes for story animation tracks. More...

class	FBStoryTrackType
	Types for new story tracks. More...

class	FBStringList
	String list. More...

class	FBSurface
	Surface class. More...

class	FBSurfaceMode
	Surface modes. More...

class	FBSurfaceType
	Surface types. More...

class	FBSyncActivationAndVisibilityMode
	Sync mode for Constraints' Activeness and Models' visibility belonging to the Character Extension. More...

class	FBSystem
	Provides access to the underlying system, and the MotionBuilder scene. More...

class	FBTCPIPSocketType
	Types of TCP/IP Sockets. More...

class	FBTabPanel
	Tab panel. More...

class	FBTake
	A take is a container for animation in a scene. More...

class	FBTakeChangeType
	Types of take change events. More...

class	FBTakeSpanOnLoad
	This enumeration indicate the how to set the take start and end points on after a load. More...

class	FBTangentClampMode
	Different clamping modes for the tangents. More...

class	FBTangentConstantMode
	Different constant modes for the tangents. More...

class	FBTangentCustomIndex
	Custom tangent index for the tangents. More...

class	FBTangentMode
	Methods of tangent calculation. More...

class	FBTangentWeightMode
	Active tangent weight, no/one/both side are active on a key. More...

class	FBTextJustify
	Text justification styles. More...

class	FBTextStyle
	Text appearance styles. More...

class	FBTexture
	See samples: HUDElements.py, MaterialAndTexture.py, TextureAnimation.py, VideoInput.py, VideoMemory.py, DeleteUnusedMedia.py. More...

class	FBTextureBlendMode
	Texture blend modes. More...

class	FBTextureMapping
	Texture mapping modes. More...

class	FBTextureUseType
	Texture Use Type. More...

class	FBThermometer
	Thermometer. More...

class	FBTime
	Time data structure. More...

class	FBTimeCode
	TimeCode data structure. More...

class	FBTimeMarkAction
	Time (Global & Take) Mark assigned action. More...

class	FBTimeMode
	Different time modes available. More...

class	FBTimeReferential
	FBCommandState. More...

class	FBTimeSpan
	TimeSpan class. More...

class	FBTimeWarpManager
	Time Warp Manager Interface to the Time Warp Manager. More...

class	FBTool
	Tool class. More...

class	FBToolPossibleDockPosition

class	FBTransportLoopMode
	Available loop modes for the transport control. More...

class	FBTransportMode
	Transport modes. More...

class	FBTransportPlaySpeed
	Available transport control play speed. More...

class	FBTransportSnapMode
	Available snap methods for the transport control. More...

class	FBTransportTimeFormat
	Available transport control time display. More...

class	FBTree
	Tree list view. More...

class	FBTreeNode
	A node in the tree view. More...

class	FBTriggerStyle
	Audio clips' trigger styles. More...

class	FBUndoManager
	Access to global undo and redo functionality. More...

class	FBUseChnMode
	Use Channel modes. More...

class	FBUserObject

class	FBVideo
	Video media class. More...

class	FBVideoClip
	See sample: VideoClip.py. More...

class	FBVideoClipImage

class	FBVideoCodecManager
	Video Codec manager class. More...

class	FBVideoCodecMode
	Enum FBVideoRenderDepth. More...

class	FBVideoFormat
	Video color modes. More...

class	FBVideoGrabber
	Video Grabber class. More...

class	FBVideoIn
	Basic video input class, supporting webcam and DV device. More...

class	FBVideoInterlaceMode
	Video interlace modes. More...

class	FBVideoLiveType
	Video Live type. More...

class	FBVideoMemory
	FBVideoMemory allow external media source (which can't be supported by MoBu natively) User could create / update OGL texture (GL_TEXTURE_2D type) externally, and pass in GL texture object id to TextureOGLId property.See "Scripts/Samples/Video/VideoMemory.py" for usage example. More...

class	FBVideoOut
	Video media class. More...

class	FBVideoProxyMode
	Video proxy modes. More...

class	FBVideoRenderDepth
	Enum FBVideoRenderDepth. More...

class	FBVideoRenderFieldMode
	Enum FBVideoRenderFieldMode. More...

class	FBVideoRenderViewingMode
	Enum FBVideoRenderViewingMode. More...

class	FBVideoResolution
	Video Resolution (1D) More...

class	FBVideoStorageMode
	Video storage modes. More...

class	FBView
	Generic view. More...

class	FBViewerMode
	Different viewer modes for the 3D viewer. More...

class	FBViewingOptions
	Viewing options for rendering. More...

class	FBVisibilityState
	Visibility state. More...

class	FBVisualComponent
	Visual Component base class. More...

class	FBVisualContainer
	Used to create a container for a tool UI. More...

class	FBWebView
	Web viewer. More...

class	FBWidgetHolder
	Native Widget Holder (can be used to embed native Qt Widget inside MoBu UI elements) A Widget holder provides a bridge to instantiate a Native Qt widget into MB framework. More...

Functions
	FBAdd (FBTVector pResult, FBTVector pV1, FBTVector pV2)
	Add two vectors together (pResult = pV1 + pV2) More...

FBAudioFmt	FBAudioFmt_AppendFormat (FBAudioFmt pFormat, int pChannels, int pBits, int pRate)
	Append the rendering audio format using the specified settings. More...

FBAudioFmt	FBAudioFmt_AppendFormat (FBAudioFmt pFormat, FBAudioFmt pSrcFormat)
	Append the rendering audio format with another audio format. More...

FBAudioFmt	FBAudioFmt_ConvertBitDepthMode (FBAudioBitDepthMode pBitDepthMode)
	Converts an FBAudioBitDepthMode enum value to its FBAudioFmt object equivalent. More...

FBAudioFmt	FBAudioFmt_ConvertChannelMode (FBAudioChannelMode pChannelMode)
	Converts an FBAudioChannelMode enum value to its FBAudioFmt object equivalent. More...

FBAudioFmt	FBAudioFmt_ConvertRateMode (FBAudioRateMode pRateMode)
	Converts an FBAudioRateMode enum value to its FBAudioFmt object equivalent. More...

int	FBAudioFmt_GetBitsValue (FBAudioFmt pFormat)
	Get the bit depth value of the Audio format object. More...

int	FBAudioFmt_GetBytesValue (FBAudioFmt pFormat)
	Get the bytes value of the Audio format object. More...

int	FBAudioFmt_GetChannelValue (FBAudioFmt pFormat)
	Get the channel value of the Audio format object. More...

FBAudioFmt	FBAudioFmt_GetDefaultFormat ()
	Get default audio format. More...

int	FBAudioFmt_GetRateValue (FBAudioFmt pFormat)
	Get the rate value of the Audio format object. More...

FBAudioFmt	FBAudioFmt_RemoveFormat (FBAudioFmt pFormat, int pChannels, int pBits, int pRate)
	Remove channels, bit depth, or rate from the specified audio format object. More...

FBAudioFmt	FBAudioFmt_RemoveFormat (FBAudioFmt pFormat, FBAudioFmt pSrcFormat)
	Remove audio format from another audio format object. More...

bool	FBAudioFmt_TestFormat (FBAudioFmt pSrcFormat, int pChannels, int pBits, int pRate)
	Test if the given audio format object contains the channel, bit depth, and rate. More...

	FBBeginChangeAllModels ()
	Call begin change to all models (need to be closed). More...

float	FBClamp (float pV, float pL, float pH)
	Clamp value. More...

FBComponent	FBCreateObject (str pGroupName, str pEntryName, str pName, pData=None, int nth=0)
	FBCreateObject. More...

bool	FBDeleteCharacterPinningPreset (str pPresetName)
	Deletes a pinning preset from the Character Controls Tool. More...

int	FBDeleteObjectsByName (str pNamePattern, str pNameSpace=None, str pGroupName=None)
	FBDeleteObjectsByName. More...

float	FBDot (FBTVector pV1, FBTVector pV2)
	Calculate the dot product of two vectors. More...

	FBEndChangeAllModels ()
	Call end change to all models (should be first open). More...

FBModel	FBFindModelByLabelName (str pModelLabelName)
	Find a model in the scene by its label name. More...

FBModel	FBFindModelByUniqueColorId (FBColor pColor, int pSubItemIndex=None)
	Find a model in the scene by its unique color id. More...

FBComponent	FBFindObjectByFullName (str pObjectFullName)
	FBFindObjectByFullName. More...

	FBFindObjectsByName (str pNamePattern, FBComponentList pList, bool pIncludeNamespace=True, bool pModelsOnly=False)
	FBFindObjectsByName. More...

bool	FBGetActorMarkerSetVisibility ()
	Queries visibility of the marker set of the current actor. More...

int	FBGetCharacterExternalSolverCount ()
	Get character external solver count. More...

int	FBGetCharacterExternalSolverIndex (str pName)
	Get character external solver index. More...

str	FBGetCharacterExternalSolverName (int pIndex)
	Get character external solver name. More...

bool	FBGetCharacterFingerTipsVisibility ()
	Queries visibility of the finger-tips of the current character. More...

bool	FBGetCharacterFloorContactsVisibility ()
	Queries visibility of the floor contacts of the current character. More...

FBCharacterKeyingMode	FBGetCharactersKeyingMode ()
	return Character Manipulation/Keying Mode More...

	FBGetContinuousRotation (FBRVector pROut, FBRVector pR0, FBRVector pR1)
	Get a continuous rotation in Euler space. More...

FBEvaluateInfo	FBGetDisplayInfo ()
	Get the displays evaluation information structure. More...

FBBodyPartId	FBGetEffectorBodyPart (FBEffectorId pEffectorId)
	return BodyPart ID from Effector. More...

FBProfileTaskCycle	FBGetEvaluationTaskCycle ()
	Get evaluation task cycle. More...

	FBGetGlobalMatrix (FBMatrix pMatrix, FBMatrix pMatrixParent, FBMatrix pLocalMatrix)
	Get global matrix from parent and child matrices. More...

	FBGetLocalMatrix (FBMatrix pMatrix, FBMatrix pMatrixParent, FBMatrix pMatrixChild)
	Get local matrix from parent and child matrices. More...

FBProfileTaskCycle	FBGetMainThreadTaskCycle ()
	Get root task cycle. More...

str	FBGetMultiLangText (FBPlug pContext, str pKey, bool pFlagReturnKey=False)
	Name lookup in the context of an object. More...

str	FBGetMultiLangText (str pContext, str pKey, bool pFlagReturnKey=False)
	Name lookup in a user defined context context. More...

FBProfileTaskCycle	FBGetRenderingTaskCycle ()
	Get rendering task cycle. More...

	FBGetSelectedModels (FBModelList pList, FBModel pParent=None, 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. More...

	FBInterpolateRotation (FBRVector pROut, FBRVector pR0, FBRVector pR1, float pU)
	Interpolate a rotation in Euler space. More...

	FBInterpolateRotation (FBQuaternion pQOut, FBQuaternion pQ0, FBQuaternion pQ1, float pU)
	Interpolate a rotation in Quaternion. More...

float	FBLength (FBTVector pV)
	Get the length of a vector. More...

float	FBLength (FBVertex pV)
	Get the length of a vertex (from origin) More...

bool	FBLoadCharacterPinningPreset (str pPresetName)
	Loads a pinning preset in the Character Controls Tool. More...

FBModel	FBLoadFbxPrimitivesModel (str pModelName)
	Load a model. More...

	FBMatrixInverse (FBMatrix pMatrix, FBMatrix pSrc)
	Invert a matrix. More...

	FBMatrixMult (FBMatrix pMatrix, FBMatrix pA, FBMatrix pB)
	Multiply two matrices. More...

	FBMatrixOrthogonalize (FBMatrix pMatrix)
	Make sure that rotation vectors are orthogonal and normalized (fast way for removing scaling from matrix) More...

	FBMatrixToQuaternion (FBQuaternion pQuaternion, FBMatrix pMatrix)
	Get a quaternion from a matrix (potential ). More...

	FBMatrixToRotation (FBRVector pVector, FBMatrix pMatrix, FBRotationOrder pRotationOrder=kFBXYZ)
	Obtain rotation vector from a matrix. More...

	FBMatrixToRotationWithPrecision (FBRVector pVector, FBMatrix pMatrix, FBRotationOrder pRotationOrder, float pPrecision=FBMat2EulerDegenerateForPrecision10)
	Obtain rotation vector from a matrix. More...

	FBMatrixToScaling (FBSVector pVector, FBMatrix pMatrix)
	Obtain scaling vector from a matrix. More...

	FBMatrixToTQS (FBTVector pTVector, FBQuaternion pQuaternion, FBSVector pSVector, FBMatrix pMatrix)
	Obtain translation vector, rotation quaternion, and scaling vector from a matrix. More...

	FBMatrixToTRS (FBTVector pTVector, FBRVector pRVector, FBSVector pSVector, FBMatrix pMatrix)
	Obtain translation, rotation, and scaling vectors from a matrix. More...

	FBMatrixToTranslation (FBTVector pVector, FBMatrix pMatrix)
	Obtain translation vector from a matrix. More...

	FBMatrixTranspose (FBMatrix pMatrix, FBMatrix pSrc)
	Transpose a matrix. More...

	FBMergeTransactionBegin ()
	Call to begin the transaction for merging multiple files. More...

	FBMergeTransactionEnd ()
	Call to end the merge transaction. More...

	FBMergeTransactionFileRefEditBegin ()
	Call to begin the transaction for merging multiple files and applying File Reference edit at the same time. More...

	FBMergeTransactionFileRefEditEnd ()
	Call to end merge transaction with File Reference edit. More...

bool	FBMergeTransactionFileRefEditIsOn ()
	Call to tell if system is during File Reference Edit Merge transaction. More...

bool	FBMergeTransactionIsOn ()
	Call to tell if system is during Merge transaction. More...

int	FBMessageBox (str pBoxTitle, str pMessage, str pButton1Str, str pButton2Str=None, str pButton3Str=None, int pDefaultButton=0, int pScrolledMessage=0)
	Dialog popup box. More...

	FBModelTransactionBegin ()
	FBModelTransactionBegin. More...

	FBModelTransactionEnd ()
	FBModelTransactionEnd. More...

	FBMult (FBTVector pResult, FBTVector pV1, float pV2)
	Multiply pV2 from pV1 (pResult = pV1 * pV2) More...

	FBMult (FBTVector pResult, FBTVector pV1, FBTVector pV2)
	Calculate the cross product of two vectors. More...

	FBMult (FBMatrix pResult, FBMatrix pM, FBSVector pV)
	Calculate the cross product of a Matrix and Scale Vector. More...

unsigned int	FBObjectGetGlobalUniqueId ()
	Get the global static object unique ID counter. More...

unsigned int	FBObjectGetLivingCount ()
	Get current total living object count. More...

	FBObjectLifeLogEnable (bool pEnable)
	Enable object creation / deletion logging. More...

	FBObjectPrintLivings (unsigned int pStartUniqueId)
	Print those living objects created when logging is enabled. More...

int	FBObject_GetEntryCount (int pGroupIndex)

str	FBObject_GetEntryDLLName (int pGroupIndex, int pIndex, int nth=0)

str	FBObject_GetEntryDescription (int pGroupIndex, int pIndex, int nth=0)

str	FBObject_GetEntryName (int pGroupIndex, int pIndex)

int	FBObject_GetGroupCount ()
	A set of functions to query the registration table. More...

str	FBObject_GetGroupName (int pGroupIndex)

str	FBObject_GetIconName (int pGroupIndex, int pIndex, int nth=0)

bool	FBObject_GetMultiplicity (int pGroupIndex, int pIndex, int nth=0)

bool	FBPopNormalTool (str pToolName, bool pSetFocus=True)
	This function is used to bring up a specific tool in the GUI. More...

	FBPreventUIUpdateBegin ()
	Call to prevent UI updates when creating/deleting/renaming objects. More...

	FBPreventUIUpdateEnd ()
	Call to end blocking the UI updates. More...

bool	FBPreventUIUpdateIsOn ()
	Call to tell if UI updates are blocked. More...

	FBQAdd (FBQuaternion pResult, FBQuaternion pQ1, FBQuaternion pQ2)
	Add two quaternions together (pResult = pQ1 + pQ2) More...

float	FBQDot (FBQuaternion pQ1, FBQuaternion pQ2)
	Calculate the dot product of two quaternions. More...

float	FBQLength (FBQuaternion pQ)
	Get the length of a quaternion. More...

	FBQMult (FBQuaternion pResult, FBQuaternion pQ1, float pQ2)
	Multiply pQ2 from pQ1 (pResult = pQ1 * pQ2) More...

	FBQMult (FBQuaternion pResult, FBQuaternion pQ1, FBQuaternion pQ2)
	Calculate the cross product of two quaternions. More...

	FBQSub (FBQuaternion pResult, FBQuaternion pQ1, FBQuaternion pQ2)
	Subtract pQ2 from pQ1 (pResult = pQ1 - pQ2) More...

	FBQuaternionToMatrix (FBMatrix pMatrix, FBQuaternion pQuaternion)
	Get a rotation matrix from a quaternion vector. More...

	FBQuaternionToRotation (FBRVector pVector, FBQuaternion pQuaternion, FBRotationOrder pRotationOrder=kFBXYZ)
	Get a rotation vector from a quaternion vector. More...

	FBQuaternionToRotationWithPrecision (FBRVector pVector, FBQuaternion pQuaternion, FBRotationOrder pRotationOrder, float pPrecision=FBMat2EulerDegenerateForPrecision10)
	Get a rotation vector from a quaternion vector. More...

	FBRotationToMatrix (FBMatrix pMatrix, FBRVector pVector, FBRotationOrder pRotationOrder=kFBXYZ)
	Convert a rotation vector to a matrix. More...

	FBRotationToQuaternion (FBQuaternion pQuaternion, FBRVector pVector, FBRotationOrder pRotationOrder=kFBXYZ)
	Get a quaternion from a rotation vector. More...

bool	FBSaveCharacterPinningPreset (str pPresetName, bool pAllowOverwriting=False)
	Saves a pinning preset from the current pinning values in the Character Controls Tool. More...

	FBScalingToMatrix (FBMatrix pMatrix, FBSVector pVector)
	Convert a scaling vector to a matrix. More...

	FBSchedulingDependencyOutput (bool pEnable)
	Debug function for MT dependency debug. More...

bool	FBSetActorMarkerSetVisibility (bool pShow)
	Sets visibility of the marker set of the current actor. More...

	FBSetCharacterFingerTipsVisibility (bool pShow)
	Sets visibility of the finger-tips of the current character. More...

	FBSetCharacterFloorContactsVisibility (bool pShow)
	Sets visibility of the floor contacts of the current character. More...

	FBSleep (kULong MilliSeconds)
	Sleep function Puts system to sleep for specified time. More...

	FBSub (FBTVector pResult, FBTVector pV1, FBTVector pV2)
	Subtract pV2 from pV1 (pResult = pV1 - pV2) More...

	FBTQSToMatrix (FBMatrix pMatrix, FBTVector pTVector, FBQuaternion pQuaternion, FBSVector pSVector)
	Convert translation vector, rotation quaternion, and scaling vector to a matrix. More...

	FBTRSToMatrix (FBMatrix pMatrix, FBTVector pTVector, FBRVector pRVector, FBSVector pSVector)
	Convert translation, rotation, and scaling vectors to a matrix. More...

	FBTrace (str pFormatString,... p1)
	This function prints useful debugging strings in the console with kFBNORMAL_TRACE output detailed level. More...

unsigned int	FBTraceGetLevel ()
	Get Global Trace Detailed Level which affects all the output targets. More...

	FBTraceSetLevel (unsigned int pNewLevel)
	Set Global Trace Detailed Level which affects all the output targets. More...

	FBTraceWithLevel (unsigned int pLevel, str pFormatString,... p2)
	This function prints useful debugging strings in the console. More...

	FBTranslationToMatrix (FBMatrix pMatrix, FBTVector pVector)
	Convert a translation vector to a matrix. More...

	FBVectorMatrixMult (FBVector4d pOutVector, FBMatrix pMatrix, FBVector4d pVector)
	Multiply a vector by a matrix. More...

	FBVertexMatrixMult (FBVertex pOutVertex, FBMatrix pMatrix, FBVertex pVertex)
	Multiply a vertex by a matrix. More...

Function Documentation

◆ FBAdd()

FBAdd	(	FBTVector	pResult,
		FBTVector	pV1,
		FBTVector	pV2
	)

Add two vectors together (pResult = pV1 + pV2)

Parameters

pResult	Resulting vector.
pV1	1st vector.
pV2	2nd vector.

◆ FBAudioFmt_AppendFormat() [1/2]

FBAudioFmt FBAudioFmt_AppendFormat	(	FBAudioFmt	pFormat,
		int	pChannels,
		int	pBits,
		int	pRate
	)

Append the rendering audio format using the specified settings.

For example, to set audio format to 2 channels, 16 bit, 44100 rate, use the following function: AudioFormat = FBAudioFmt_AppendFormat(0, 2, 16, 44100) Python sample code:

from pyfbsdk import *
def printFormat( AudioFormat ):
    print "Audio Render Format: ", AudioFormat
    print "Audio Channels: ", FBAudioFmt_GetChannelValue( AudioFormat )
    print "Audio Bit Depth: ", FBAudioFmt_GetBitsValue( AudioFormat )
    print "Audio Rate: ", FBAudioFmt_GetRateValue( AudioFormat )
    print ""
# Given an AudioFormat, modify the rate from the old rate to 48000 while
# keeping the other settings intact
AudioFormat = FBAudioFmt_GetDefaultFormat()
print "Old Format:"
printFormat( AudioFormat )
oldrate = FBAudioFmt_GetRateValue( AudioFormat )
AudioFormat = FBAudioFmt_RemoveFormat(AudioFormat, 0, 0, oldrate)
print "Format after removing Audio Rate:"
printFormat( AudioFormat )
AudioFormat = FBAudioFmt_AppendFormat(AudioFormat, 0, 0, 48000)
print "New Format after modifying Audio Rate to 48000"
printFormat( AudioFormat )

Parameters

pFormat	Audio format to use. Set this to 0 if there is no audio format to be appended.
pChannels	Number of channels. Valid values are 0, 1, 2, 4, 8.
pBits	Bit depth. Valid values are 0, 8, 16, 24, 32.
pRate	Audio rate. Valid values are 0, 8000, 11025, 12000, 12500, 16000, 22050, 24000, 25000, 32000, 44100, 48000, 50000, 64000, 88200, 96000, 100000.

Returns: An audio format object with the specified format.

◆ FBAudioFmt_AppendFormat() [2/2]

FBAudioFmt FBAudioFmt_AppendFormat	(	FBAudioFmt	pFormat,
		FBAudioFmt	pSrcFormat
	)

Append the rendering audio format with another audio format.

Parameters

pFormat	Audio format to use.
pSrcFormat	Audio format to be appended.

Returns: An audio format object with the specified format.

◆ FBAudioFmt_ConvertBitDepthMode()

FBAudioFmt FBAudioFmt_ConvertBitDepthMode ( FBAudioBitDepthMode pBitDepthMode )

Converts an FBAudioBitDepthMode enum value to its FBAudioFmt object equivalent.

Parameters

pBitDepthMode The bit depth mode enum value.

Returns: The FBAudioFmt object equivalent to the input bit depth mode enum value.

◆ FBAudioFmt_ConvertChannelMode()

FBAudioFmt FBAudioFmt_ConvertChannelMode ( FBAudioChannelMode pChannelMode )

Converts an FBAudioChannelMode enum value to its FBAudioFmt object equivalent.

Parameters

pChannelMode The channel mode enum value.

Returns: The FBAudioFmt object equivalent to the input channel mode enum value.

◆ FBAudioFmt_ConvertRateMode()

FBAudioFmt FBAudioFmt_ConvertRateMode ( FBAudioRateMode pRateMode )

Converts an FBAudioRateMode enum value to its FBAudioFmt object equivalent.

Parameters

pRateMode The rate mode enum value.

Returns: The FBAudioFmt object equivalent to the input rate mode enum value.

◆ FBAudioFmt_GetBitsValue()

int FBAudioFmt_GetBitsValue ( FBAudioFmt pFormat )

Get the bit depth value of the Audio format object.

Parameters

pFormat Audio format to use.

Returns: Bit depth value as an integer value.

◆ FBAudioFmt_GetBytesValue()

int FBAudioFmt_GetBytesValue ( FBAudioFmt pFormat )

Get the bytes value of the Audio format object.

Parameters

pFormat Audio format to use.

Returns: Bytes value as an integer value.

◆ FBAudioFmt_GetChannelValue()

int FBAudioFmt_GetChannelValue ( FBAudioFmt pFormat )

Get the channel value of the Audio format object.

Parameters

pFormat Audio format to use.

Returns: Channel value as an integer value.

◆ FBAudioFmt_GetDefaultFormat()

FBAudioFmt FBAudioFmt_GetDefaultFormat ( )

Get default audio format.

Returns: An audio format object.

◆ FBAudioFmt_GetRateValue()

int FBAudioFmt_GetRateValue ( FBAudioFmt pFormat )

Get the rate value of the Audio format object.

Parameters

pFormat Audio format to use.

Returns: Audio rate value as an integer value.

◆ FBAudioFmt_RemoveFormat() [1/2]

FBAudioFmt FBAudioFmt_RemoveFormat	(	FBAudioFmt	pFormat,
		int	pChannels,
		int	pBits,
		int	pRate
	)

Remove channels, bit depth, or rate from the specified audio format object.

Please refer to python example in FBAudioFmt_AppendFormat.

Parameters

pFormat	Audio format to use.
pChannels	Number of channels to remove. Set this to 0 if you don't want to remove the channel.
pBits	Bit depth to remove. Set this to 0 if you don't want to remove bit depth.
pRate	Audio rate to remove. Set this to 0 if you don't want to remove audio rate.

Returns: An audio format object without the specified format settings passed in parameter.

◆ FBAudioFmt_RemoveFormat() [2/2]

FBAudioFmt FBAudioFmt_RemoveFormat	(	FBAudioFmt	pFormat,
		FBAudioFmt	pSrcFormat
	)

Remove audio format from another audio format object.

Parameters

pFormat	Audio format to use.
pSrcFormat	Audio format to remove.

Returns: An audio format object without the specified format settings passed in parameter.

◆ FBAudioFmt_TestFormat()

bool FBAudioFmt_TestFormat	(	FBAudioFmt	pSrcFormat,
		int	pChannels,
		int	pBits,
		int	pRate
	)

Test if the given audio format object contains the channel, bit depth, and rate.

Parameters

pSrcFormat	Audio format to test.
pChannels	Number of channels to test.
pBits	Bit depth to test.
pRate	Audio rate to test.

Returns: True if the given audio format object contains the channel, bit depth, and rate.

◆ FBBeginChangeAllModels()

FBBeginChangeAllModels ( )

Call begin change to all models (need to be closed).

Useful for selection of many models that can trigger many related callbacks)

◆ FBClamp()

float FBClamp	(	float	pV,
		float	pL,
		float	pH
	)

Clamp value.

Parameters

pV	Value to clamp.
pL	Low limit.
pH	High limit.

Returns: Clamped value.

◆ FBCreateObject()

FBComponent FBCreateObject	(	str	pGroupName,
		str	pEntryName,
		str	pName,
		pData	= `None`,
		int	nth = `0`
	)

FBCreateObject.

Parameters

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 occurrence of the object to remove.

See sample: ObjectCreation.py.

◆ FBDeleteCharacterPinningPreset()

bool FBDeleteCharacterPinningPreset ( str pPresetName )

Deletes a pinning preset from the Character Controls Tool.

Parameters

pPresetName The preset name to delete (not the file path nor the filename of the preset).

Returns: True if the operation is successful, false otherwise.

◆ FBDeleteObjectsByName()

int FBDeleteObjectsByName	(	str	pNamePattern,
		str	pNameSpace = `None`,
		str	pGroupName = `None`
	)

FBDeleteObjectsByName.

This function will query the system for objects fulfilling a particular name pattern and delete them. specify a namespace preferred, delete all objects with the group name without specified a namespace specified may lead to inconsistent in scene. Wrap multiple calls to FBDeleteObjectsByName() inside pair of FBPreventUIUpdateBegin() / FBPreventUIUpdateEnd() could improve application's performance.

Parameters

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).

Returns: the count of objects found and deleted.

◆ FBDot()

float FBDot	(	FBTVector	pV1,
		FBTVector	pV2
	)

Calculate the dot product of two vectors.

Parameters

pV1	1st vector.
pV2	2nd vector.

Returns: Dot product.

◆ FBEndChangeAllModels()

FBEndChangeAllModels ( )

Call end change to all models (should be first open).

◆ FBFindModelByLabelName()

FBModel FBFindModelByLabelName ( str pModelLabelName )

Find a model in the scene by its label name.

Searches the scene for a model, based on the model's label name. Label name is "NameSpaceName:ObjectName". also known as "PrefixName::ObjectName" Full name is "GroupName::NameSpaceName:ObjectName".

Parameters

pModelLabelName LabelName of model to search for. Specify it with schema like "NameSpaceName:ObjectName",or "ObjectName" if no NameSpaceName.

Returns: A handle onto the model with Label name matching, returns NULL if no model was found by the search.

See samples: CopyAnimation.py, 3dsMaxBipedTemplate.py, EnableGameModeOnSelectedCharacters_Z.py, ExportAnimationLibrary.py.

◆ FBFindModelByUniqueColorId()

FBModel FBFindModelByUniqueColorId	(	FBColor	pColor,
		int	pSubItemIndex = `None`
	)

Find a model in the scene by its unique color id.

A model could have a single unique ColorID, but SDK plugin user could request additional ColorID per model to support multi sub items picking. see FBModel::SetAdditionalUniqueColorIDCount().

Parameters

pColor	Color channel values are in range of [0,1] with precision 1.0/255
pSubItemIndex	Pass out SubImtem index value if not null. In pyfbsdk no such parameter.

Returns: A handle onto the model with unique color id matching, returns NULL if no model was found by the search. In pyfbsdk return tuple [model, subItemIndex]

◆ FBFindObjectByFullName()

FBComponent FBFindObjectByFullName ( str pObjectFullName )

FBFindObjectByFullName.

This function will query the system for an object with its FullName matching. Full name is "GroupName::NameSpaceName:ObjectName". Label name is "NameSpaceName:ObjectName". also known as "PrefixName::ObjectName"

Parameters

pObjectFullName Full Name of object to search for. Specify it with schema like "GroupName::NameSpaceName:ObjectName",or "GroupName::ObjectName" if no NameSpaceName.

Returns: A handle onto the object with Full name matching pObjectFullName, returns NULL if no object was found by the search.

◆ FBFindObjectsByName()

FBFindObjectsByName	(	str	pNamePattern,
		FBComponentList	pList,
		bool	pIncludeNamespace = `True`,
		bool	pModelsOnly = `False`
	)

FBFindObjectsByName.

This function will query the system for objects fulfilling a particular name pattern

Parameters

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

See sample: FindObjectsWithWildcard.py.

◆ FBGetActorMarkerSetVisibility()

bool FBGetActorMarkerSetVisibility ( )

Queries visibility of the marker set of the current actor.

Returns: True if the marker set of the current actor are visible, or false if it is hidden.

◆ FBGetCharacterExternalSolverCount()

int FBGetCharacterExternalSolverCount ( )

Get character external solver count.

Returns: Number of external character solver available.

◆ FBGetCharacterExternalSolverIndex()

int FBGetCharacterExternalSolverIndex ( str pName )

Get character external solver index.

Parameters

pName Name of external solver.

Returns: Index of external solver specified at the provided name.

◆ FBGetCharacterExternalSolverName()

str FBGetCharacterExternalSolverName ( int pIndex )

Get character external solver name.

Parameters

pIndex Index of external solver.

Returns: Name of the external solver specified at the provided index.

◆ FBGetCharacterFingerTipsVisibility()

bool FBGetCharacterFingerTipsVisibility ( )

Queries visibility of the finger-tips of the current character.

Returns: True if finger-tips of the current character are visible, or false if they are hidden.

◆ FBGetCharacterFloorContactsVisibility()

bool FBGetCharacterFloorContactsVisibility ( )

Queries visibility of the floor contacts of the current character.

Returns: True if floor contacts of the current character are visible, or false if they are hidden.

◆ FBGetCharactersKeyingMode()

FBCharacterKeyingMode FBGetCharactersKeyingMode ( )

return Character Manipulation/Keying Mode

Returns: Keying Mode

◆ FBGetContinuousRotation()

FBGetContinuousRotation	(	FBRVector	pROut,
		FBRVector	pR0,
		FBRVector	pR1
	)

Get a continuous rotation in Euler space.

This routine will help to avoid gimble locks due to interpolation.

Parameters

pROut	Successful continuous rotation (gimble-lock free).
pR0	Suggested next rotation.
pR1	Previous rotation.

◆ FBGetDisplayInfo()

FBEvaluateInfo FBGetDisplayInfo ( )

Get the displays evaluation information structure.

This function can be used in order to call real-time functions based on the current display evalution state.

Returns: The display evalution structure.

◆ FBGetEffectorBodyPart()

FBBodyPartId FBGetEffectorBodyPart ( FBEffectorId pEffectorId )

return BodyPart ID from Effector.

Parameters

pEffectorId Effector ID.

Returns: ID of the BodyPart the effector is in.

◆ FBGetEvaluationTaskCycle()

FBProfileTaskCycle FBGetEvaluationTaskCycle ( )

Get evaluation task cycle.

◆ FBGetGlobalMatrix()

FBGetGlobalMatrix	(	FBMatrix	pMatrix,
		FBMatrix	pMatrixParent,
		FBMatrix	pLocalMatrix
	)

Get global matrix from parent and child matrices.

From an input referential, this function will calculate the global matrix corresponding to the input local matrix (which is with respect to the parent matrix).

Parameters

pMatrix	Calculated local matrix.
pMatrixParent	Parent matrix.
pLocalMatrix	Local matrix.

◆ FBGetLocalMatrix()

FBGetLocalMatrix	(	FBMatrix	pMatrix,
		FBMatrix	pMatrixParent,
		FBMatrix	pMatrixChild
	)

Get local matrix from parent and child matrices.

Will calculate the local matrix from two global matrices. The resulting matrix will be a local matrix containing the local transformations to go from the parent referentialto the child referential.

Parameters

pMatrix	Calculated local matrix.
pMatrixParent	Parent matrix (new base referential).
pMatrixChild	Child matrix.

◆ FBGetMainThreadTaskCycle()

FBProfileTaskCycle FBGetMainThreadTaskCycle ( )

Get root task cycle.

◆ FBGetMultiLangText() [1/2]

str FBGetMultiLangText	(	FBPlug	pContext,
		str	pKey,
		bool	pFlagReturnKey = `False`
	)

Name lookup in the context of an object.

Most application objects have an internal name which differs from the name shown by the GUI. This will often be the case for the names of an object's properties.The way that support for multiple languages has been implemented is using conversion tables that will map the internal name to a localized name. Since the same internal name might mean different things for different objects, we can provide a context to help the lookup process.In this case, the context is a class object instance. When the lookup fails within a context, we sucessively try a lookup using the parent classes in the object hierarchy.It is important to note that for given property, it only knows about its internal name. The localized name is not attached to the property object itself as it resides elsewhere, in a lookup table. This is also the case for any other application object.The lookup table used to find the localized, or GUI name, of an object is dependent on the current language used. This information is available via the class FBMultiLangManager, which can indicate which language are availables and provides methode to query and change the current language.Python sample code:

from pyfbsdk import *
# Let's pick the first camera present in the system.
lCamera = FBSystem().Cameras[0]
# We know that cameras have a property named 'LockMode'.
lPropInternalName = lCamera.PropertyList.Find( 'LockMode' )
if lPropInternalName:
    print 'Actual property name, as defined internally: "%s"' % lPropInternalName.GetName()
    print 'Property name as shown by the GUI: "%s"' % FBGetMultiLangText( lCamera, lPropInternalName.GetName())
    lPropLocalizedName = lCamera.PropertyList.Find( FBGetMultiLangText( lCamera, lPropInternalName.GetName()))
    if lPropLocalizedName and lPropInternalName.GetName() == lPropLocalizedName.GetName():
        print 'Found the same property using both the internal (%s) and localized name (%s).' % (
            lPropLocalizedName.GetName(),
            FBGetMultiLangText( lCamera, lPropInternalName.GetName()))

C++ sample code:

// Let's pick the first camera present in the system.
FBCamera* lCamera = FBSystem().Cameras[0];
// We know that cameras have a property named 'LockMode'.
FBProperty* lPropInternalName = lCamera->PropertyList.Find( "LockMode" );
if( lPropInternalName )
{
    FBTrace( "Actual property name, as defined internally: '%s'\n", lPropInternalName->GetName());
    FBTrace( "Property name as shown by the GUI: '%s'\n", FBGetMultiLangText( lCamera, lPropInternalName->GetName()));
    FBProperty* lPropLocalizedName = lCamera->PropertyList.Find( FBGetMultiLangText( lCamera, lPropInternalName->GetName()));
    if( lPropLocalizedName && stricmp( lPropInternalName->GetName(), lPropLocalizedName->GetName()) == 0 )
    {
        FBTrace( "Found the same property using both the internal (%s) and localized name (%s).\n",
            lPropLocalizedName->GetName(),
            FBGetMultiLangText( lCamera, lPropInternalName->GetName()));
    }
}

Parameters

pContext	Object which dictates the context of the lookup.
pKey	String to look up.
pFlagReturnKey	Should the lookup fail, will return the key instead of an empty string.

Returns: The corresponding string if the lookup was succesfull. If not will return an empty string if pFlagReturnKey was false. Otherwise will return the key string.

◆ FBGetMultiLangText() [2/2]

str FBGetMultiLangText	(	str	pContext,
		str	pKey,
		bool	pFlagReturnKey = `False`
	)

Name lookup in a user defined context context.

This version of the function is a little less useful as the context string, if not empty, will usually refer to internal class names of objects which is not easily available to the outside world.As a general rule, an SDK object whose class is 'FBObject' will be wrapping an internal object of class 'KObject'. For example an 'FBCamera' is a wrapper around a 'KCamera' object. Similarily an 'FBConstraint' wll wrap a 'KConstraint'. This pattern is not universal and may differ at times, so it will not always be applicable. There are also cases where an 'FB' objects has no corresponding 'K' object, such as in the case of an 'FBSystem' object.On lookup there are potentially two searches made: a first one, using the context if one was provided. Should the first search fail, a second search will be done without using the context.Again the lookup result is dependant on the current language selected, as indicated by the class FBMultiLangManager.The following sample code shows 2 cases that do not use context, and 2 cases that are using a context which are internal class names.Python sample code:

from pyfbsdk import *
print FBGetMultiLangText( '', 'CharacterExtension' )            # Will return 'Character Extension'.
print FBGetMultiLangText( '', 'TranslationMax' )                # Will return 'Max Freedom'.
print FBGetMultiLangText( 'KConstraintUIName', 'Parent-Child' ) # Will return 'Parent/Child'.
print FBGetMultiLangText( 'KCamera', 'FieldOfView' )            # Will return 'Field Of View'.

C++ sample code:

// Will return 'Character Extension'.
FBTrace( "%s\n", FBGetMultiLangText( "", "CharacterExtension" ));
// Will return 'Max Freedom'.
FBTrace( "%s\n", FBGetMultiLangText( "", "TranslationMax" ));
// Will return 'Parent/Child'.
FBTrace( "%s\n", FBGetMultiLangText( "KConstraintUIName", "Parent-Child" ));
// Will return 'Field Of View'.
FBTrace( "%s\n", FBGetMultiLangText( "KCamera", "FieldOfView" ));

Parameters

pContext	String which dictates the context of the lookup.
pKey	String to look up.
pFlagReturnKey	Should the lookup fail, will return the key instead of an empty string.

Returns: The corresponding string if the lookup was succesfull. If not will return an empty string if pFlagReturnKey was false. Otherwise will return the key string.

◆ FBGetRenderingTaskCycle()

FBProfileTaskCycle FBGetRenderingTaskCycle ( )

Get rendering task cycle.

◆ FBGetSelectedModels()

FBGetSelectedModels	(	FBModelList	pList,
		FBModel	pParent = `None`,
		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.

Parameters

pList	List to add found models to.
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

See sample: FBGetSelectedModels.py.

◆ FBInterpolateRotation() [1/2]

FBInterpolateRotation	(	FBRVector	pROut,
		FBRVector	pR0,
		FBRVector	pR1,
		float	pU
	)

Interpolate a rotation in Euler space.

Parameters

pROut	Resulting, interpolated rotation.
pR0	1st rotation.
pR1	2nd rotation.
pU	Interpolation ratio.

◆ FBInterpolateRotation() [2/2]

FBInterpolateRotation	(	FBQuaternion	pQOut,
		FBQuaternion	pQ0,
		FBQuaternion	pQ1,
		float	pU
	)

Interpolate a rotation in Quaternion.

Parameters

pQOut	Resulting, interpolated rotation.
pQ0	1st rotation.
pQ1	2nd rotation.
pU	Interpolation ratio.

◆ FBLength() [1/2]

float FBLength ( FBTVector pV )

Get the length of a vector.

Parameters

pV	Vector to calculate length for.

Returns: Length of vector pV.

◆ FBLength() [2/2]

float FBLength ( FBVertex pV )

Get the length of a vertex (from origin)

Parameters

pV	Vertex for which length is to be measured.

Returns: Length of vertex (from origin).

◆ FBLoadCharacterPinningPreset()

bool FBLoadCharacterPinningPreset ( str pPresetName )

Loads a pinning preset in the Character Controls Tool.

Parameters

pPresetName The preset name to load (not the file path nor the filename of the preset).

Returns: True if the operation is successful, false otherwise.

◆ FBLoadFbxPrimitivesModel()

FBModel FBLoadFbxPrimitivesModel ( str pModelName )

Load a model.

Parameters

pModelName Name of primitive model to load.

Returns: A handle onto the model that was loaded, returns NULL if no model was found.

◆ FBMatrixInverse()

FBMatrixInverse	(	FBMatrix	pMatrix,
		FBMatrix	pSrc
	)

Invert a matrix.

Parameters

pMatrix	Calculated inverse matrix.
pSrc	Source matrix to invert.

◆ FBMatrixMult()

FBMatrixMult	(	FBMatrix	pMatrix,
		FBMatrix	pA,
		FBMatrix	pB
	)

Multiply two matrices.

Parameters

pMatrix	Calculated resulting matrix.
pA	1st matrix.
pB	2nd matrix.

◆ FBMatrixOrthogonalize()

FBMatrixOrthogonalize ( FBMatrix pMatrix )

Make sure that rotation vectors are orthogonal and normalized (fast way for removing scaling from matrix)

Parameters

pMatrix Rotation Matrix to Orthogonalize.

◆ FBMatrixToQuaternion()

FBMatrixToQuaternion	(	FBQuaternion	pQuaternion,
		FBMatrix	pMatrix
	)

Get a quaternion from a matrix (potential ).

Parameters

pQuaternion	Calculated quaternion.
pMatrix	Input matrix.

Warning: Matrix can contain scaling and/or translation, we orthogonalize matrix before.

◆ FBMatrixToRotation()

FBMatrixToRotation	(	FBRVector	pVector,
		FBMatrix	pMatrix,
		FBRotationOrder	pRotationOrder = `kFBXYZ`
	)

Obtain rotation vector from a matrix.

Parameters

pVector	Extracted rotation vector, ordered the same way as the rotation order specified by pRotationOrder.
pMatrix	Input matrix.
pRotationOrder	Rotation order.

◆ FBMatrixToRotationWithPrecision()

FBMatrixToRotationWithPrecision	(	FBRVector	pVector,
		FBMatrix	pMatrix,
		FBRotationOrder	pRotationOrder,
		float	pPrecision = `FBMat2EulerDegenerateForPrecision10`
	)

Obtain rotation vector from a matrix.

Parameters

pVector	Extracted rotation vector.
pMatrix	Input matrix.
pRotationOrder	Rotation Order.
pPrecision	Indicate the precision level (pow(10.0, -pPrecision)) used when calculating the threshold value for gimble lock.

Warning: Rotation is in EulerXYZ or EulerZYX only

◆ FBMatrixToScaling()

FBMatrixToScaling	(	FBSVector	pVector,
		FBMatrix	pMatrix
	)

Obtain scaling vector from a matrix.

Parameters

pVector	Extracted scaling vector.
pMatrix	Input matrix.

◆ FBMatrixToTQS()

FBMatrixToTQS	(	FBTVector	pTVector,
		FBQuaternion	pQuaternion,
		FBSVector	pSVector,
		FBMatrix	pMatrix
	)

Obtain translation vector, rotation quaternion, and scaling vector from a matrix.

Parameters

pTVector	Extracted translation vector.
pQuaternion	Extracted rotation quaternion.
pSVector	Extracted scaling vector.
pMatrix	Input matrix.

◆ FBMatrixToTranslation()

FBMatrixToTranslation	(	FBTVector	pVector,
		FBMatrix	pMatrix
	)

Obtain translation vector from a matrix.

Parameters

pVector	Extracted translation vector.
pMatrix	Input matrix.

◆ FBMatrixToTRS()

FBMatrixToTRS	(	FBTVector	pTVector,
		FBRVector	pRVector,
		FBSVector	pSVector,
		FBMatrix	pMatrix
	)

Obtain translation, rotation, and scaling vectors from a matrix.

Parameters

pTVector	Extracted translation vector.
pRVector	Extracted rotation vector.
pSVector	Extracted scaling vector.
pMatrix	Input matrix.

Warning: Rotation is in EulerXYZ

◆ FBMatrixTranspose()

FBMatrixTranspose	(	FBMatrix	pMatrix,
		FBMatrix	pSrc
	)

Transpose a matrix.

Parameters

pMatrix	Calculated transpose matrix.
pSrc	Source matrix to transpose.

◆ FBMergeTransactionBegin()

FBMergeTransactionBegin ( )

Call to begin the transaction for merging multiple files.

Useful to consecutively merge multiple files into scene.

Note: The transaction need to be closed by calling FBMergeTransactionEnd(). There is no need to call FBPreventUIUpdateBegin() with this function, since it already contains the same optimization.

◆ FBMergeTransactionEnd()

FBMergeTransactionEnd ( )

Call to end the merge transaction.

◆ FBMergeTransactionFileRefEditBegin()

FBMergeTransactionFileRefEditBegin ( )

Call to begin the transaction for merging multiple files and applying File Reference edit at the same time.

Useful to consecutively merge multiple files into scene with FileRef edit operation in between.

Note: The transaction need to be closed by calling FBMergeTransactionFileRefEditEnd().

◆ FBMergeTransactionFileRefEditEnd()

FBMergeTransactionFileRefEditEnd ( )

Call to end merge transaction with File Reference edit.

◆ FBMergeTransactionFileRefEditIsOn()

bool FBMergeTransactionFileRefEditIsOn ( )

Call to tell if system is during File Reference Edit Merge transaction.

◆ FBMergeTransactionIsOn()

bool FBMergeTransactionIsOn ( )

Call to tell if system is during Merge transaction.

◆ FBMessageBox()

int FBMessageBox	(	str	pBoxTitle,
		str	pMessage,
		str	pButton1Str,
		str	pButton2Str = `None`,
		str	pButton3Str = `None`,
		int	pDefaultButton = `0`,
		int	pScrolledMessage = `0`
	)

Dialog popup box.

Opens a message box containing a message and up to three buttons. Waits for the user to click a button.

Parameters

pBoxTitle	Title of message box.
pMessage	Message to place in box.
pButton1Str	String for first button (Cannot be NULL).
pButton2Str	String for second button (NULL will not create a button).
pButton3Str	String for third button (NULL will not create a button).
pDefaultButton	Indicates the default (pre-selected) button (default is 0).
pScrolledMessage	Scroll message (default is 0).

Returns: The number of the button selected.

See samples: GetUserValue.py, AssignRigidBody.py, BatchExportCharacterAnimationTool.py, EnableGameModeOnSelectedCharacters_Z.py, FBMessageBox.py, FBMessageBoxGetUserValue.py.

◆ FBModelTransactionBegin()

FBModelTransactionBegin ( )

FBModelTransactionBegin.

This set of functions speeds up the process of batch operations on models.

◆ FBModelTransactionEnd()

FBModelTransactionEnd ( )

FBModelTransactionEnd.

This set of functions speeds up the process of batch operations on models.

◆ FBMult() [1/3]

FBMult	(	FBTVector	pResult,
		FBTVector	pV1,
		float	pV2
	)

Multiply pV2 from pV1 (pResult = pV1 * pV2)

Parameters

pResult	Resulting vector.
pV1	1st vector.
pV2	2nd vector.

◆ FBMult() [2/3]

FBMult	(	FBTVector	pResult,
		FBTVector	pV1,
		FBTVector	pV2
	)

Calculate the cross product of two vectors.

Parameters

pResult	Resulting vector.
pV1	1st vector.
pV2	2nd vector.

◆ FBMult() [3/3]

FBMult	(	FBMatrix	pResult,
		FBMatrix	pM,
		FBSVector	pV
	)

Calculate the cross product of a Matrix and Scale Vector.

Parameters

pResult	Resulting Matrix.
pM	Matrix.
pV	vector.

◆ FBObject_GetEntryCount()

int FBObject_GetEntryCount ( int pGroupIndex )

◆ FBObject_GetEntryDescription()

str FBObject_GetEntryDescription	(	int	pGroupIndex,
		int	pIndex,
		int	nth = `0`
	)

◆ FBObject_GetEntryDLLName()

str FBObject_GetEntryDLLName	(	int	pGroupIndex,
		int	pIndex,
		int	nth = `0`
	)

◆ FBObject_GetEntryName()

str FBObject_GetEntryName	(	int	pGroupIndex,
		int	pIndex
	)

◆ FBObject_GetGroupCount()

int FBObject_GetGroupCount ( )

A set of functions to query the registration table.

◆ FBObject_GetGroupName()

str FBObject_GetGroupName ( int pGroupIndex )

◆ FBObject_GetIconName()

str FBObject_GetIconName	(	int	pGroupIndex,
		int	pIndex,
		int	nth = `0`
	)

◆ FBObject_GetMultiplicity()

bool FBObject_GetMultiplicity	(	int	pGroupIndex,
		int	pIndex,
		int	nth = `0`
	)

◆ FBObjectGetGlobalUniqueId()

unsigned int FBObjectGetGlobalUniqueId ( )

Get the global static object unique ID counter.

Each new created object will be assigned this global unique ID. Object.UniqueID = GlobalUniqueID++

◆ FBObjectGetLivingCount()

unsigned int FBObjectGetLivingCount ( )

Get current total living object count.

◆ FBObjectLifeLogEnable()

FBObjectLifeLogEnable ( bool pEnable )

Enable object creation / deletion logging.

Default logging if off This logging may hurt performance slightly. use it only for debug purpose.

Parameters

pEnable true to enable logging.

◆ FBObjectPrintLivings()

FBObjectPrintLivings ( unsigned int pStartUniqueId )

Print those living objects created when logging is enabled.

Parameters

pStartUniqueId Any living object has been logged and with its uniqueId no less than pStartUniqueId will be printed out.

◆ FBPopNormalTool()

bool FBPopNormalTool	(	str	pToolName,
		bool	pSetFocus = `True`
	)

This function is used to bring up a specific tool in the GUI.

Parameters

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

Returns: If the tool was brought up successfully.

◆ FBPreventUIUpdateBegin()

FBPreventUIUpdateBegin ( )

Call to prevent UI updates when creating/deleting/renaming objects.

Useful to speed up script operations. Previously, FBMergeTransactionBegin()/ FBMergeTransactionEnd() could be used to do this kind of optimization, even if no merge operations were done. However, using FBMergeTransactionBegin()/ FBMergeTransactionEnd() with non-merge operation could lead to issues, like objects with invalid namespaces. FBPreventUIUpdateBegin()/FBPreventUIUpdateEnd() fix this issue, while giving the same speed increase.

Note: The transaction need to be closed by calling FBPreventUIUpdateEnd(). There is no need to call this function when using FBMergeTransactionBegin(), since FBMergeTransactionBegin() already has the same optimization.

◆ FBPreventUIUpdateEnd()

FBPreventUIUpdateEnd ( )

Call to end blocking the UI updates.

◆ FBPreventUIUpdateIsOn()

bool FBPreventUIUpdateIsOn ( )

Call to tell if UI updates are blocked.

◆ FBQAdd()

FBQAdd	(	FBQuaternion	pResult,
		FBQuaternion	pQ1,
		FBQuaternion	pQ2
	)

Add two quaternions together (pResult = pQ1 + pQ2)

Parameters

pResult	Resulting quaternion.
pQ1	1st quaternion.
pQ2	2nd quaternion.

◆ FBQDot()

float FBQDot	(	FBQuaternion	pQ1,
		FBQuaternion	pQ2
	)

Calculate the dot product of two quaternions.

Parameters

pQ1	1st quaternion.
pQ2	2nd quaternion.

Returns: Dot product.

◆ FBQLength()

float FBQLength ( FBQuaternion pQ )

Get the length of a quaternion.

Parameters

pQ	Quaternion to calculate length for.

Returns: Length of quaternion pQ.

◆ FBQMult() [1/2]

FBQMult	(	FBQuaternion	pResult,
		FBQuaternion	pQ1,
		float	pQ2
	)

Multiply pQ2 from pQ1 (pResult = pQ1 * pQ2)

Parameters

pResult	Resulting quaternion.
pQ1	1st quaternion.
pQ2	2nd quaternion.

◆ FBQMult() [2/2]

FBQMult	(	FBQuaternion	pResult,
		FBQuaternion	pQ1,
		FBQuaternion	pQ2
	)

Calculate the cross product of two quaternions.

Parameters

pResult	Resulting quaternion.
pQ1	1st quaternion.
pQ2	2nd quaternion.

◆ FBQSub()

FBQSub	(	FBQuaternion	pResult,
		FBQuaternion	pQ1,
		FBQuaternion	pQ2
	)

Subtract pQ2 from pQ1 (pResult = pQ1 - pQ2)

Parameters

pResult	Resulting quaternion.
pQ1	1st quaternion.
pQ2	2nd quaternion.

◆ FBQuaternionToMatrix()

FBQuaternionToMatrix	(	FBMatrix	pMatrix,
		FBQuaternion	pQuaternion
	)

Get a rotation matrix from a quaternion vector.

Parameters

pMatrix	Calculated rotation matrix.
pQuaternion	Input quaternion.

◆ FBQuaternionToRotation()

FBQuaternionToRotation	(	FBRVector	pVector,
		FBQuaternion	pQuaternion,
		FBRotationOrder	pRotationOrder = `kFBXYZ`
	)

Get a rotation vector from a quaternion vector.

Parameters

pVector	Calculated rotation vector, ordered the same way as the rotation order specified by pRotationOrder.
pQuaternion	Input quaternion.
pRotationOrder	Rotation order.

Warning: Rotation is in EulerXYZ or kFBZYX only

◆ FBQuaternionToRotationWithPrecision()

FBQuaternionToRotationWithPrecision	(	FBRVector	pVector,
		FBQuaternion	pQuaternion,
		FBRotationOrder	pRotationOrder,
		float	pPrecision = `FBMat2EulerDegenerateForPrecision10`
	)

Get a rotation vector from a quaternion vector.

Parameters

pVector	Calculated rotation vector.
pQuaternion	Input quaternion.
pRotationOrder	Rotation order of the rotation vector.
pPrecision	Indicate the precision level (pow(10.0, -pPrecision)) used when calculating the threshold value for gimble lock.

Warning: Rotation is in EulerXYZ or kFBZYX only

◆ FBRotationToMatrix()

FBRotationToMatrix	(	FBMatrix	pMatrix,
		FBRVector	pVector,
		FBRotationOrder	pRotationOrder = `kFBXYZ`
	)

Convert a rotation vector to a matrix.

Parameters

pMatrix	Calculated resulting matrix.
pVector	Rotation vector, ordered the same way as the rotation order specified by pRotationOrder.
pRotationOrder	Rotation order.

◆ FBRotationToQuaternion()

FBRotationToQuaternion	(	FBQuaternion	pQuaternion,
		FBRVector	pVector,
		FBRotationOrder	pRotationOrder = `kFBXYZ`
	)

Get a quaternion from a rotation vector.

Parameters

pQuaternion	Calculated quaternion.
pVector	Input rotation vector, ordered the same way as the rotation order specified by pRotationOrder.
pRotationOrder	Rotation order.

◆ FBSaveCharacterPinningPreset()

bool FBSaveCharacterPinningPreset	(	str	pPresetName,
		bool	pAllowOverwriting = `False`
	)

Saves a pinning preset from the current pinning values in the Character Controls Tool.

Parameters

pPresetName	The preset name to save (not the file path nor the filename of the preset).
pAllowOverwriting	True to allow overwriting an existing preset having the same name as the one provided, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ FBScalingToMatrix()

FBScalingToMatrix	(	FBMatrix	pMatrix,
		FBSVector	pVector
	)

Convert a scaling vector to a matrix.

Parameters

pMatrix	Calculated resulting matrix.
pVector	Scaling vector.

◆ FBSchedulingDependencyOutput()

FBSchedulingDependencyOutput ( bool pEnable )

Debug function for MT dependency debug.

When enabled log file will be created and updated each time MultiThreaded scheduling is happening (scene rebuild)

Parameters

pEnable ON/OFF switch. This is not stored in config (should be changed only for debug purpose, because slow down rebuild process )

◆ FBSetActorMarkerSetVisibility()

bool FBSetActorMarkerSetVisibility ( bool pShow )

Sets visibility of the marker set of the current actor.

Parameters

pShow Specifies if the market of the current actor should be visible.

Returns: True if the operation is successful, false otherwise.

◆ FBSetCharacterFingerTipsVisibility()

FBSetCharacterFingerTipsVisibility ( bool pShow )

Sets visibility of the finger-tips of the current character.

Parameters

pShow Specifies if finger-tips of the current character should be visible.

◆ FBSetCharacterFloorContactsVisibility()

FBSetCharacterFloorContactsVisibility ( bool pShow )

Sets visibility of the floor contacts of the current character.

Parameters

pShow Specifies if floor contacts of the current character should be visible.

◆ FBSleep()

FBSleep ( kULong MilliSeconds )

Sleep function Puts system to sleep for specified time.

Parameters

MilliSeconds Time to sleep for.

See sample: FBProgress.py.

◆ FBSub()

FBSub	(	FBTVector	pResult,
		FBTVector	pV1,
		FBTVector	pV2
	)

Subtract pV2 from pV1 (pResult = pV1 - pV2)

Parameters

pResult	Resulting vector.
pV1	1st vector.
pV2	2nd vector.

◆ FBTQSToMatrix()

FBTQSToMatrix	(	FBMatrix	pMatrix,
		FBTVector	pTVector,
		FBQuaternion	pQuaternion,
		FBSVector	pSVector
	)

Convert translation vector, rotation quaternion, and scaling vector to a matrix.

Parameters

pMatrix	Calculated resulting matrix.
pTVector	Translation vector.
pQuaternion	Rotation quaternion.
pSVector	Scaling vector.

◆ FBTrace()

FBTrace	(	str	pFormatString,
			p1
	)

This function prints useful debugging strings in the console with kFBNORMAL_TRACE output detailed level.

Parameters

pFormatString A printf-style format string, to use the following arguments in the list.

Warning: There is currently a limitation which sets the maximum length of the resulting string to be limited to 2048 bytes.; Not thread safe, as an static array is used internally.

◆ FBTraceGetLevel()

unsigned int FBTraceGetLevel ( )

Get Global Trace Detailed Level which affects all the output targets.

Returns: Current global trace detailed level.

Note: Python console trace current output level could be queried via pythonidelib.GetTraceLevel().

◆ FBTraceSetLevel()

FBTraceSetLevel ( unsigned int pNewLevel )

Set Global Trace Detailed Level which affects all the output targets.

Parameters

pNewLevel Any trace message with detailed level higher than this new level will be ignored, valid value range [kFBNO_TRACE, kFBALL_TRACE]

Note: Python console trace current output level could be further adjusted via pythonidelib.SetTraceLevel().

◆ FBTraceWithLevel()

FBTraceWithLevel	(	unsigned int	pLevel,
		str	pFormatString,
			p2
	)

This function prints useful debugging strings in the console.

Parameters

pLevel	to control trace output detailed level, valid value range [kFBCRITICAL_TRACE, kFBALL_TRACE]
pFormatString	A printf-style format string, to use the following arguments in the list.

Warning: There is currently a limitation which sets the maximum length of the resulting string to be limited to 2048 bytes.; Not thread safe, as an static array is used internally.

◆ FBTranslationToMatrix()

FBTranslationToMatrix	(	FBMatrix	pMatrix,
		FBTVector	pVector
	)

Convert a translation vector to a matrix.

Parameters

pMatrix	Calculated resulting matrix.
pVector	Translation vector.

◆ FBTRSToMatrix()

FBTRSToMatrix	(	FBMatrix	pMatrix,
		FBTVector	pTVector,
		FBRVector	pRVector,
		FBSVector	pSVector
	)

Convert translation, rotation, and scaling vectors to a matrix.

Parameters

pMatrix	Calculated resulting matrix.
pTVector	Translation vector.
pRVector	Rotation vector.
pSVector	Scaling vector.

Warning: Rotation is in EulerXYZ

◆ FBVectorMatrixMult()

FBVectorMatrixMult	(	FBVector4d	pOutVector,
		FBMatrix	pMatrix,
		FBVector4d	pVector
	)

Multiply a vector by a matrix.

Parameters

pOutVector	Resulting vector.
pMatrix	Matrix to affect the vector with.
pVector	Source vector.

◆ FBVertexMatrixMult()

FBVertexMatrixMult	(	FBVertex	pOutVertex,
		FBMatrix	pMatrix,
		FBVertex	pVertex
	)

Multiply a vertex by a matrix.

Parameters

pOutVertex	Resulting vertex.
pMatrix	Matrix to affect the vertex with.
pVertex	Source vertex.

Classes

Functions

Function Documentation

◆ FBAdd()

◆ FBAudioFmt_AppendFormat() [1/2]

◆ FBAudioFmt_AppendFormat() [2/2]

◆ FBAudioFmt_ConvertBitDepthMode()

◆ FBAudioFmt_ConvertChannelMode()

◆ FBAudioFmt_ConvertRateMode()

◆ FBAudioFmt_GetBitsValue()

◆ FBAudioFmt_GetBytesValue()

◆ FBAudioFmt_GetChannelValue()

◆ FBAudioFmt_GetDefaultFormat()

◆ FBAudioFmt_GetRateValue()

◆ FBAudioFmt_RemoveFormat() [1/2]

◆ FBAudioFmt_RemoveFormat() [2/2]

◆ FBAudioFmt_TestFormat()

◆ FBBeginChangeAllModels()

◆ FBClamp()

◆ FBCreateObject()

◆ FBDeleteCharacterPinningPreset()

◆ FBDeleteObjectsByName()

◆ FBDot()

◆ FBEndChangeAllModels()

◆ FBFindModelByLabelName()

◆ FBFindModelByUniqueColorId()

◆ FBFindObjectByFullName()

◆ FBFindObjectsByName()

◆ FBGetActorMarkerSetVisibility()

◆ FBGetCharacterExternalSolverCount()

◆ FBGetCharacterExternalSolverIndex()

◆ FBGetCharacterExternalSolverName()

◆ FBGetCharacterFingerTipsVisibility()

◆ FBGetCharacterFloorContactsVisibility()

◆ FBGetCharactersKeyingMode()

◆ FBGetContinuousRotation()

◆ FBGetDisplayInfo()

◆ FBGetEffectorBodyPart()

◆ FBGetEvaluationTaskCycle()

◆ FBGetGlobalMatrix()

◆ FBGetLocalMatrix()

◆ FBGetMainThreadTaskCycle()

◆ FBGetMultiLangText() [1/2]

◆ FBGetMultiLangText() [2/2]

◆ FBGetRenderingTaskCycle()

◆ FBGetSelectedModels()

◆ FBInterpolateRotation() [1/2]

◆ FBInterpolateRotation() [2/2]

◆ FBLength() [1/2]

◆ FBLength() [2/2]

◆ FBLoadCharacterPinningPreset()

◆ FBLoadFbxPrimitivesModel()

◆ FBMatrixInverse()

◆ FBMatrixMult()

◆ FBMatrixOrthogonalize()

◆ FBMatrixToQuaternion()

◆ FBMatrixToRotation()

◆ FBMatrixToRotationWithPrecision()

◆ FBMatrixToScaling()

◆ FBMatrixToTQS()

◆ FBMatrixToTranslation()

◆ FBMatrixToTRS()

◆ FBMatrixTranspose()

◆ FBMergeTransactionBegin()

◆ FBMergeTransactionEnd()

◆ FBMergeTransactionFileRefEditBegin()

◆ FBMergeTransactionFileRefEditEnd()

◆ FBMergeTransactionFileRefEditIsOn()

◆ FBMergeTransactionIsOn()

◆ FBMessageBox()

◆ FBModelTransactionBegin()

◆ FBModelTransactionEnd()

◆ FBMult() [1/3]

◆ FBMult() [2/3]

◆ FBMult() [3/3]

◆ FBObject_GetEntryCount()

◆ FBObject_GetEntryDescription()

◆ FBObject_GetEntryDLLName()

◆ FBObject_GetEntryName()

◆ FBObject_GetGroupCount()