Classes | Functions | Variables

Module pyfbsdk

Classes

class   FBActor
  FBActor is used to link motion data to a character. More...
class   FBActorFace
  Used to plot actor face animation. More...
class   FBAnimationLayer
  Used to access animation layer properties and modify them. More...
class   FBAnimationNode
class   FBApplication
  FBApplication is used mainly to manage files. 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   FBAudioClip
  Used to play audio clips and access their properties. More...
class   FBAudioIn
  Audio In class. More...
class   FBAudioOut
  Audio Out class. 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   FBCamera
  Creates custom cameras and manages system cameras. More...
class   FBCameraStereo
class   FBCameraSwitcher
  Camera switcher. More...
class   FBCharacter
  A character is the link between a motion source and a character model. More...
class   FBCharacterExtension
  Objects Grouping class. More...
class   FBCharacterFace
  Animates a character face using an actor as input. More...
class   FBCharacterPose
  Used to work with character poses. More...
class   FBCharacterPoseOptions
  Stores options for operations on poses. More...
class   FBCluster
  Weighting interface for meshes. More...
class   FBComponent
  MotionBuilder SDK base class. More...
class   FBConfigFile
  Interface to the application config files. More...
class   FBConstraint
  Base class for constraints. More...
class   FBConstraintInfo
  Constraint information class. More...
class   FBConstraintManager
  Constraint manager. More...
class   FBConstraintSolver
  Base class for constraint solver. More...
class   FBContainer
  Used to create a container for a tool UI. More...
class   FBControlSet
  Control set class. More...
class   FBDeck
  Interface to a tape deck. More...
class   FBDeformer
  Base Model deformer class. More...
class   FBDeformerPointCache
  Base Model deformer class. More...
class   FBDevice
  Base Device class. More...
class   FBDeviceInstrument
  Instrument abstraction layer. More...
class   FBDeviceNotifyInfo
  Device Input and Output Notification information structure. More...
class   FBDeviceOptical
  Optical device class. More...
class   FBDeviceOpticalMarker
  Device optical marker. 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   FBEditVector
  Vector edit widget. More...
class   FBEvaluateInfo
  AnimationNodeNotify evaluation information. More...
class   FBEvaluateManager
class   FBEvent
  Base Event class. More...
class   FBEventActivate
  Activation event. More...
class   FBEventConnectionDataNotify
  Connection notify event class. More...
class   FBEventConnectionNotify
  Connection notify event class. More...
class   FBEventConnectionStateNotify
  Connection notify event class. More...
class   FBEventDblClick
  Input event class. More...
class   FBEventExpose
  Event sent when a control needs to be displayed. More...
class   FBEventInput
  Input event class. More...
class   FBEventMenu
  Menu event. More...
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. More...
class   FBFCurve
  FCurve class. More...
class   FBFCurveEditor
  FCurve editor. More...
class   FBFCurveKey
  KeyFrame for an FCurve. More...
class   FBFbxOptions
  Customize file loading and saving. More...
class   FBFilePopup
  File Popup (for open/save). More...
class   FBFilter
  Filters are used to modify motion capture data. More...
class   FBFilterManager
  Filter manager. More...
class   FBFolder
  Folder class. More...
class   FBFolderPopup
  Folder Popup (for selecting a directory). 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   FBGlobalLight
  Global light class. More...
class   FBGroup
  Objects Grouping class. More...
class   FBHandle
  FBHandle class. More...
class   FBImage
  Image class. More...
class   FBImageContainer
  Image. More...
class   FBKeyControl
  Key control. More...
class   FBKeyingGroup
  KeyingGroup class. More...
class   FBLabel
  Text label. 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   FBList
  List of items. More...
class   FBMarkerSet
  Marker set class. More...
class   FBMaterial
  Material class. More...
class   FBMemo
  Multi-line text input. More...
class   FBMenuManager
  The menu manager allows access to MotionBuilder menu bar. More...
class   FBMesh
  Mesh class. More...
class   FBModel
  Model class. More...
class   FBModelCube
  Cube model class. 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   FBModelSkeleton
  Root object class. More...
class   FBModelTemplate
  Model template class. More...
class   FBMotionClip
  Motion class. More...
class   FBMultiLangManager
  Language manager. More...
class   FBNote
  Note class. More...
class   FBNurbs
  Nurbs class. More...
class   FBObjectPose
  FBObjectPose class. More...
class   FBObjectPoseMirrorOptions
  FBObjectPoseMirrorOptions class. More...
class   FBObjectPoseOptions
  FBObjectPoseOptions class. More...
class   FBOpticalGap
  Optical Gap class. More...
class   FBOpticalSegment
  Optical segment class. More...
class   FBPatch
  Patch class. More...
class   FBPhysicalProperties
  Base class for physical properties attach to a model. More...
class   FBPlayerControl
  Player control. More...
class   FBPlotPopup
  Plot Popup (for setting options only). More...
class   FBPlug
  Connections Basic Open Reality SDK Element. More...
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   FBPose
  Pose class. More...
class   FBProfileTaskCycle
  FBProfileTaskCycle. More...
class   FBProfileTimeEvent
  FBProfileTimeEvent. More...
class   FBProfiler
  FBProfiler. More...
class   FBProgress
  Progress bar. More...
class   FBPropertyConnectionEditor
  Property Connection Editor. More...
class   FBPropertyListCharacterExtension
  Character extension property list. More...
class   FBPropertyListCharacterPose
  PropertyList: CharacterPose. More...
class   FBPropertyListConstraint
  PropertyList: Contraint. More...
class   FBPropertyListConstraintSolver
  PropertyList: Contraint solver. More...
class   FBPropertyListControlSet
  PropertyList: MarkerSet. More...
class   FBPropertyListDeformer
class   FBPropertyListFolder
  PropertyList: Folder. More...
class   FBPropertyListMotionClip
  List: MotionClip. More...
class   FBPropertyListObjectPose
  PropertyList: ObjectPose. More...
class   FBPropertyListPhysicalProperties
  PropertyList: Physical properties. More...
class   FBPropertyListVideoClip
  PropertyList: VideoClip. More...
class   FBPropertyManager
  Property Manager. More...
class   FBReferenceTime
  Reference time class. More...
class   FBRenderOptions
class   FBRenderer
  Open Reality renderer interface. More...
class   FBRigidBody
  Rigid body class. More...
class   FBSVector
  Three dimensional scaling vector. More...
class   FBScene
  Access to the MotionBuilder scene. More...
class   FBSet
  Objects Set class. More...
class   FBShader
  Shader class. More...
class   FBShaderLighted
  Lighted shader class. More...
class   FBShaderManager
  Shader manager. More...
class   FBShaderShadowLive
  Shader Shadow Live class. More...
class   FBSkeletonState
class   FBSlider
  Slider. More...
class   FBSpreadCell
  Spreadsheet cell. More...
class   FBSpreadColumn
  Spreadsheet column. More...
class   FBSpreadPart
  Spreadsheet part. More...
class   FBSpreadRow
  Spreadsheet row. More...
class   FBStory
  Story Management class. More...
class   FBStoryClip
  Story Clip class. More...
class   FBStoryFolder
  Story Folder class. More...
class   FBStoryTrack
  Story Track class. More...
class   FBStringList
  String list. More...
class   FBSurface
  Surface class. More...
class   FBTabPanel
  Tab panel. More...
class   FBTake
  A take is a container for animation in a scene. More...
class   FBTexture
  Texture class. More...
class   FBThermometer
  Thermometer. More...
class   FBTime
  Time data structure. More...
class   FBTimeCode
  TimeCode data structure. More...
class   FBTimeSpan
  TimeSpan class. More...
class   FBTimeWarpManager
  Time Warp Manager Interface to the Time Warp Manager. More...
class   FBTree
  Tree list view. More...
class   FBTreeNode
  A node in the tree view. More...
class   FBUndoManager
  Access to global undo and redo functionality. More...
class   FBUserObject
class   FBVideo
  Video media class. More...
class   FBVideoClip
class   FBVideoGrabber
  Video Grabber class. More...
class   FBVideoIn
  Basic video input class, supporting webcam and DV device. More...
class   FBVideoOut
  Video media class. More...
class   FBView
  Generic view. More...
class   FBViewerInfos
  Scene information display. More...
class   FBAssetMngMenuOptions
  Show or hide version control menu items. More...
class   FBAssetMngFileOptions
  Behavior of the application when working with managed files. More...
class   FBAccessMode
  Data access modes. More...
class   FBUseChnMode
  Use Channel modes. More...
class   FBTriggerStyle
  Audio clips' trigger styles. More...
class   FBSkeletonNodeId
  All Skeleton nodes. More...
class   FBBodyNodeId
  All body nodes. More...
class   FBEffectorId
  All effector nodes. More...
class   FBEffectorSetID
  Effector ID identifier. More...
class   FBFloorContactID
  Floor contact for the given index. More...
class   FBBodyPartId
  Body part for character. More...
class   FBCharacterInputType
  Character Input/Output types. More...
class   FBCharacterKeyingMode
  Character keying modes. More...
class   FBCharacterResetProperties
  Character Reset Properties Type. More...
class   FBCharacterPlotWhere
  Where to plot a character. More...
class   FBCharacterHipsTranslationMode
  Character Hips Translation modes. More...
class   FBCharacterRollSolver
  Character Roll Solver version. More...
class   FBCharacterContactBehaviour
  Character Contact Behaviour. More...
class   FBControlSetType
  Character ControlSet type. More...
class   FBRecalcMarkerSetOffset
  Recalculate MarkerSet offset for?. More...
class   FBPlotAllowed
  FBPlotAllowed. More...
class   FBCharacterPoseFlag
  Character Pose Options flags. More...
class   FBMirrorPlaneType
  Mirror Plane Type. More...
class   FBCharacterPoseKeyingMode
  Character Pose Keying Mode. More...
class   FBCommandState
  FBCommandState. More...
class   FBTimeReferential
  FBCommandState. More...
class   FBObjectFlag
  Available flags for any component. More...
class   FBObjectStatus
  Available lifetime status for any component. More...
class   FBNamespaceAction
  Namespace flags. More...
class   FBConsoleChannelType
  Console channel types. More...
class   FBOrientation
  General directions for UI components. More...
class   FBInputType
  Types of input events. More...
class   FBInputModifier
  Input Modifiers (Ctrl, Alt, Shift). More...
class   FBInputKey
  Keyboard inputs. More...
class   FBAttachType
  Types of attachments between UI regions. More...
class   FBBorderStyle
  Different border types available. More...
class   FBDragAndDropState
  State of Drag and Drop. More...
class   FBMenuItemType
  Types of menu items available. More...
class   FBButtonStyle
  Style of buttons. More...
class   FBButtonState
  Possible button states. More...
class   FBTextJustify
  Text justification styles. More...
class   FBTextStyle
  Text appearance styles. More...
class   FBButtonLook
  Button look. More...
class   FBListStyle
  List style or direction. More...
class   FBCellStyle
  Different styles of spreadsheet cell styles. More...
class   FBIconPosition
  Different icon positions possible. More...
class   FBFilePopupStyle
  Different types of file popup windows. More...
class   FBPopupInputType
  User input types for a popup. 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   FBDeviceSamplingMode
  Recording types. More...
class   FBCommType
  Communications type. More...
class   FBInterpolation
  Types of interpolation for an FCurve. More...
class   FBInterpolatorCurveType
  Types of interpolator for an FCurve. More...
class   FBTangentMode
  Methods of tangent calculation. More...
class   FBTangentClampMode
  Different clamping modes for the tangents. More...
class   FBTangentConstantMode
  Different constant modes for the tangents. More...
class   FBEventAnimationNodeType
  Event based on animation node. More...
class   FBLayerMode
  Layer mode. More...
class   FBLayerRotationMode
  Rotation mode for layer. More...
class   FBAnimationLayerMergeOptions
  Merge option for animation layers. More...
class   FBMergeLayerMode
  Merge layer mode for animation layers. More...
class   FBDeckTransportMode
  FBDeckTransportMode. More...
class   FBElementAction
  Enumeration that describe the different actions available on a scene element depending on the current context. More...
class   FBTakeSpanOnLoad
  This enumeration indicate the how to set the take start and end points on after a load. More...
class   FBCharacterLoadAnimationMethod
  This enumeration is used to choose how to load an animation file on a character. More...
class   FBFileFormatAndVersion
class   FBFilterType
  Filter types. More...
class   FBImageFormat
  Image formats. More...
class   FBImageType
  Image types. More...
class   FBImageInterleaveType
  Image field interleave types. More...
class   FBImageInterpolationType
  Image interpolation types. More...
class   FBParity
  Parity modes. More...
class   FBRSType
  RS type for serial port. More...
class   FBCommPortType
  Communication port type. More...
class   FBTCPIPSocketType
  Types of TCP/IP Sockets. More...
class   FBKeyingGroupType
  Keying group types. More...
class   FBManipulatorPickType
  Types of manipulator picking. More...
class   FBManipulatorTransformType
  Manipulator transform stles. More...
class   FBRotationOrder
  Specify the Euler rotation order. More...
class   FBModelTransformationMatrix
  Types of transformation vector/matrices possible. More...
class   FBModelShadingMode
  Modes for model shading. More...
class   FBModelRotationOrder
  Ways to apply Rotation. More...
class   FBMarkerResolutionLevel
  Resolution of marker mesh sphere and capsule (Quality). More...
class   FBMarkerLook
  Look of the marker. More...
class   FBMarkerType
  Type of the marker. More...
class   FBPathTangeantMode
  Tangeant modes available for path keys. More...
class   FBTextureUseType
  Texture Use Type. More...
class   FBTextureMapping
  Texture mapping modes. More...
class   FBTextureBlendMode
  Texture blend modes. More...
class   FBMaterialTextureType
  Ways to apply Rotation. More...
class   FBClusterMode
  Different clustering modes. More...
class   FBCameraFrameSizeMode
  Frame size modes. More...
class   FBCameraResolutionMode
  Resolution modes. More...
class   FBCameraApertureMode
  Aperture modes. More...
class   FBCameraFilmBackType
  Filmback types. More...
class   FBCameraViewPlaneMode
  Camera plane viewing modes. More...
class   FBCameraDistanceMode
  Camera plane distance modes. More...
class   FBCameraSafeAreaMode
  Safe area modes. More...
class   FBCameraAntiAliasingMethod
  Antialiasing methods. More...
class   FBCameraSamplingType
  Antialiasing sampling types. More...
class   FBCameraFocusDistanceSource
  Focus distance sources. More...
class   FBCameraType
  Focus distance types. More...
class   FBCameraMatrixType
  Camera matrix types. More...
class   FBCameraStereoType
class   FBFogMode
  Fog falloff modes. More...
class   FBLightType
  Light types. More...
class   FBAttenuationType
  Light attenuation types. More...
class   FBGeometryArrayID
  ID to use when requesting a specific array of data for a model. More...
class   FBGeometryArrayElementType
  Type of data when requesting an array. 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   FBSurfaceMode
  Surface modes. More...
class   FBSurfaceType
  Surface types. More...
class   FBNurbType
  Surface types. More...
class   FBDeformerType
  Determine the deformer type. More...
class   FBPoseTransformType
  Transform mode of pose. More...
class   FBObjectPoseOptionsFlag
  ObjectPoseOptions flags. More...
class   FBObjectPoseMirrorOptionsFlag
  ObjectPoseMirrorOptions flags. More...
class   FBGapMode
  Gap interpolation modes. More...
class   FBRigidBodyMode
  Rigid body modes. More...
class   FBGenerationMode
  Generation modes for optical model. More...
class   FBControllerMode
  Controller modes for optical model. More...
class   FBSegmentMode
  Segment modes. More...
class   FBInsertSegmentMode
  Insert segment modes. More...
class   FBConnectionAction
  Possible actions when a notify plug event occurs. More...
class   FBConnectionType
  Connection types available between plugs. More...
class   FBPoseType
  Types of pose. More...
class   FBProfilingMode
  Available Profiling modes. More...
class   FBPropertyType
  Property types. More...
class   FBPropertyFlag
  Available flags for FBProperty objects. More...
class   FBDisplayMode
  Model display options. More...
class   FBStereoDisplayMode
class   FBDisplayWhat
  Model display mask This mask determines what types of models are displayed by the renderer. More...
class   FBPickingMode
  3D picking mode. More...
class   FBDeviceKeyboardKey
  Keyboard keys (for input). More...
class   FBSceneChangeType
  Types of model selection events. More...
class   FBTakeChangeType
  Types of take change events. More...
class   FBRenderingPass
  Rendering Pass. More...
class   FBAlphaSource
  Shader transparency computation. More...
class   FBShadowType
  Shadow types. More...
class   FBShadowFrameType
  Shadow calculation methods. More...
class   FBStoryTrackType
  Types for new story tracks. More...
class   FBStoryTrackRefMode
  References Modes for story animation tracks. More...
class   FBStoryTrackBodyPart
  Body Parts for story track character. More...
class   FBStoryClipShowGhostMode
  Show Ghost Modes for story animation clips. More...
class   FBStoryClipSolveMode
  Solve Modes for story character clips. More...
class   FBStoryClipCompMode
  Compensation Modes for story character clips. More...
class   FBBatchProcessType
  Different process type for the batch. More...
class   FBBatchFileFormat
  Different file formats for the batch. More...
class   FBBatchOnTakeExist
  Different actions to perform when a take already exist while in a batch process. More...
class   FBBatchOnContainsBatchTakes
  Different actions to perform when a scene already contains batch takes while in a batch process. More...
class   FBBatchStatus
  Different return values of the Batch process. More...
class   FBRotationFilter
  Rotation filters. More...
class   FBViewerMode
  Different viewer modes for the 3D viewer. More...
class   FBTransportMode
  Transport modes. More...
class   FBTransportTimeFormat
  Available transport control time display. More...
class   FBTransportPlaySpeed
  Available transport control play speed. More...
class   FBTransportSnapMode
  Available snap methods for the transport control. More...
class   FBParallelScheduleType
  Available DAG parallel schedule algorithm. More...
class   FBTimeMode
  Different time modes available. More...
class   FBToolPossibleDockPosition
class   FBVideoProxyMode
  Video proxy modes. More...
class   FBVideoStorageMode
  Video storage modes. More...
class   FBVideoInterlaceMode
  Video interlace modes. More...
class   FBVideoFormat
  Video color modes. More...
class   FBVideoLiveType
  Video Live type. More...
class   FBClipEnd
  Clip end actions. More...
class   FBPlayMode
  Play modes. More...
class   FBVideoCodecMode
  Enum FBVideoRenderDepth. More...
class   FBVideoRenderViewingMode
  Enum FBVideoRenderViewingMode. More...
class   FBVideoRenderFieldMode
  Enum FBVideoRenderFieldMode. More...
class   FBVideoRenderDepth
  Enum FBVideoRenderDepth. More...
class   Enumeration
  Enumeration mapping. More...
class   FBVector2d
  Vector2d class. More...
class   FBVector3d
  Vector3d class. More...
class   FBVector4d
  Vector4d class. More...
class   FBColor
  FBColor class. More...
class   FBColorAndAlpha
  FBColorAndAlpha class. More...
class   FBMatrix
  FBMatrix class. More...
class   FBModelList
  FBModelList class. More...
class   FBPickInfosList
  FBPickInfosList class. More...
class   FBComponentList
  FBComponentList class. More...
class   FBVideoGrabOptions
  Video Grabbing Options. More...
class   FBViewingOptions
class   FBConstraintRelation
class   FBCallback
  This class is used for the internal callback framework and is not meant to be used by clients. More...
class   FBPythonWrapper
  Base class of FBPlug in Python. More...
class   FBAddRegionParam
  This class provide a placeholder to put values necessary to create a Region with FBLayout.AddRegion. More...
class   FBTool
class   FBProperty
  Generic application property. More...
class   FBCharacterSolver
class   FBBatchOptions
class   FBPlotOptions
class   FBSystem
class   FBEventDragAndDrop
class   FBVertex
  Vertex class. More...
class   FBSpread
class   FBSplitStyle
  Type of split style (sub-division) for layout. More...
class   FBEventName
  These events are used internally by the Python Callback mecanism. More...
class   FBVideoCodecManager
class   FBShaderModelInfo
class   FBScrollBox
class   FBVisualComponent
class   FBPropertyAction
class   FBPropertyBool
class   FBPropertyColor
  FBPropertyColor class. More...
class   FBPropertyColorAndAlpha
  FBPropertyColorAndAlpha class. More...
class   FBPropertyComponent
class   FBPropertyDouble
class   FBPropertyFloat
class   FBPropertyInt
class   FBPropertyString
class   FBPropertyTime
class   FBPropertyVector2d
class   FBPropertyVector3d
class   FBPropertyVector4d
class   FBPropertyEnum
  Enumeration property. More...
class   FBPropertyAnimatable
class   FBPropertyAnimatableAction
class   FBPropertyAnimatableBool
class   FBPropertyAnimatableColor
class   FBPropertyAnimatableColorAndAlpha
class   FBPropertyAnimatableDouble
class   FBPropertyAnimatableTime
class   FBPropertyAnimatableEnum
class   FBPropertyAnimatableInt
class   FBPropertyAnimatableVector2d
class   FBPropertyAnimatableVector3d
class   FBPropertyAnimatableVector4d
class   FBPropertyListObject
  List-like structure fo system elements. More...
class   FBPropertyList
  Tuple-like structure for system elements. More...
class   FBPropertyListActor
class   FBPropertyListActorFace
class   FBPropertyListAnimationNode
class   FBPropertyListAudioClip
class   FBPropertyListAudioIn
class   FBPropertyListAudioOut
class   FBPropertyListBox
class   FBPropertyListCamera
class   FBPropertyListCharacter
class   FBPropertyListCharacterFace
class   FBPropertyListComponent
class   FBPropertyStringList
class   FBPropertyListDeck
class   FBPropertyListDevice
class   FBPropertyListDeviceInstrument
class   FBPropertyListFCurveKey
class   FBPropertyListGroup
class   FBPropertyListHandle
class   FBPropertyListLight
class   FBPropertyListMarkerSet
class   FBPropertyListMaterial
class   FBPropertyListMaterialId
class   FBPropertyListMedia
class   FBPropertyListModel
class   FBPropertyListModelTemplate
class   FBPropertyListModelTemplateBinding
class   FBPropertyListNormalIndex
class   FBPropertyListNote
class   FBPropertyListPivot
class   FBPropertyListPose
class   FBPropertyListPrimitiveVertexCount
class   FBPropertyListScene
class   FBPropertyListSet
class   FBPropertyListShader
class   FBPropertyListStoryClip
class   FBPropertyListStoryDetails
class   FBPropertyListStoryFolder
class   FBPropertyListStorySubTrack
class   FBPropertyListStoryTrack
class   FBPropertyListTake
class   FBPropertyListTexture
class   FBPropertyListTextureId
class   FBPropertyListUVIndex
class   FBPropertyListUserObject
class   FBPropertyListVertexIndex
class   FBPropertyListVideo
class   FBPropertyListVideoIn
class   FBPropertyListVideoOut

Functions

  __FB_FORWARD (FBApplyManagerRule)
  FB_DEFINE_COMPONENT (K_DLLIMPORT, ApplyManagerRule)
  FBRealloc (memblock, int size)
  General allocation function, actually calling standard function "realloc".
  FBFree (memblock)
  General free function, actually calling standard function "free".
  __FB_FORWARD (FBAssetItem)
  __FB_FORWARD (FBAssetFile)
  __FB_FORWARD (FBAssetFolder)
  __FB_FORWARD (FBAssetMng)
  FB_DEFINE_COMPONENT (, AssetMng)
  __FB_FORWARD (FBAudioIn)
  __FB_FORWARD (FBAudioOut)
  __FB_FORWARD (FBAudioClip)
  FB_DEFINE_COMPONENT (, AudioIn)
  FB_DEFINE_COMPONENT (, AudioOut)
  FB_DEFINE_COMPONENT (, AudioClip)
  FB_DEFINE_ENUM (, AccessMode)
  FB_DEFINE_ENUM (, UseChnMode)
  FB_DEFINE_ENUM (, TriggerStyle)
HFBAudioOut  FBAudioOutGetDefault ()
  Get default audio output.
int  FBAudioFmt_GetDefaultFormat ()
int  FBAudioFmt_AppendFormat (int pFormat, int pChannels, int pBits, int pRate)
int  FBAudioFmt_AppendFormat (int pFormat, int pSrcFormat)
int  FBAudioFmt_RemoveFormat (int pFormat, int pChannels, int pBits, int pRate)
int  FBAudioFmt_RemoveFormat (int pFormat, int pSrcFormat)
int  FBAudioFmt_GetChannelValue (int pFormat)
int  FBAudioFmt_GetBitsValue (int pFormat)
int  FBAudioFmt_GetBytesValue (int pFormat)
int  FBAudioFmt_GetRateValue (int pFormat)
bool  FBAudioFmt_TestFormat (int pSrcFormat, int pChannels, int pBits, int pRate)
  FB_DEFINE_ENUM (, CharacterInputType)
  FB_DEFINE_ENUM (, CharacterKeyingMode)
  FB_DEFINE_ENUM (, CharacterPlotWhere)
  FB_DEFINE_ENUM (, CharacterHipsTranslationMode)
  FB_DEFINE_ENUM (, CharacterRollSolver)
  FB_DEFINE_ENUM (, CharacterContactBehaviour)
  FB_DEFINE_ENUM (, ControlSetType)
str  FBCharacterBodyNodeNameFromId (FBBodyNodeId pBodyNodeId)
  Get the UI name associated with a body node.
str  FBCharacterEffectorNameFromId (FBEffectorId pEffectorId)
  Get the UI name associated with an effector.
  __FB_FORWARD (FBMarkerSet)
  FB_DEFINE_COMPONENT (, MarkerSet)
  FB_FORWARD (FBModel)
  __FB_FORWARD (FBControlSet)
  FB_DEFINE_COMPONENT (, ControlSet)
  __FB_FORWARD (FBSkeletonState)
  Skeleton State class.
  __FB_FORWARD (FBActor)
  FB_DEFINE_COMPONENT (, Actor)
  FB_FORWARD (FBPlotOptions)
  __FB_FORWARD (FBCharacter)
  FB_DEFINE_COMPONENT (, Character)
  FB_FORWARD (FBPropertyListCharacter)
FBCharacterKeyingMode  FBGetCharactersKeyingMode ()
  return Character Manipulation/Keying Mode.
FBBodyPartId  FBGetEffectorBodyPart (FBEffectorId pEffectorId)
  return BodyPart ID from Effector.
FBBodyPartId  FBGetBodyNodeBodyPart (FBBodyNodeId pBodyNodeId)
  return BodyPart ID from Bones.
HFBCharacter  FBGetCharacterByAssociatedPart (HFBComponent pPart)
  Get character by its associated IK/FK Marker or Bone.
  __FB_FORWARD (FBCharacterExtension)
  FB_DEFINE_ENUM (, PlotAllowed)
  FB_DEFINE_COMPONENT (, CharacterExtension)
  FB_DEFINE_LIST (, CharacterExtension)
  __FB_FORWARD (FBActorFace)
  FB_DEFINE_COMPONENT (, ActorFace)
  __FB_FORWARD (FBCharacterFace)
  FB_DEFINE_COMPONENT (, CharacterManipulator)
  FB_DEFINE_COMPONENT (, CharacterManipulatorCtrlSet)
  __FB_FORWARD (FBCharacterManipulator)
  Used to translate, rotate or scale a character.
  __FB_FORWARD (FBCharacterManipulatorCtrlSet)
  FB_FORWARD (FBCharacterPoseOptions)
  __FB_FORWARD (FBCharacterPose)
  FB_DEFINE_COMPONENT (, CharacterSolver)
  __FB_FORWARD (FBCharacterSolver)
int  FBGetCharacterExternalSolverCount ()
  Get character external solver count.
str  FBGetCharacterExternalSolverName (int pIndex)
  Get character external solver name.
int  FBGetCharacterExternalSolverIndex (str pName)
  Get character external solver index.
FBCharacterSolver  FBInstanciateCharacterExternalSolver (int pIndex, str pSolverName=None)
  Instanciate the given external character solver.
  __FB_FORWARD (FBCommand)
  FB_DEFINE_ENUM (, CommandState)
  FB_DEFINE_ENUM (, TimeReferential)
  FB_DEFINE_COMPONENT (, Command)
  K_FORWARD (IRegister)
  forwarding.
  K_FORWARD (IError)
  K_FORWARD (IStore)
  K_FORWARD (IKtView)
  K_FORWARD (KEventBase)
  K_FORWARD (KGlobalNamedEvent)
  __FB_FORWARD (FBComponent)
  __FB_FORWARD (FBVisualComponent)
FBComponent  GetFBComponent (object Object)
  Get a handle to the FBComponent belonging to an HIObject.
FBVisualComponent  FBGetFBVisualComponent (HIKtView pObject, bool pAutoCreate=True)
  Get the FBComponent from an Internal Object.
FBComponent  FBGetFBComponent (object pObject, bool pAutoCreate=True)
  Get the FBComponent from an Internal Object.
FBPlug  FBGetFBPlug (object pObject, bool pAutoCreate=True)
  Get the FBPlug from an Internal Object.
tuple  FBGetComponentArray ()
  Get the Root FBComponent.
  FBSetStoreableCustomModelReigstered ()
bool  FBGetStoreableCustomModelReigstered ()
bool  FBObject_Register (str pGroupName, str pEntryName, str pDescription, function pCreatorFnc, bool pIsMultipleAllowed, str pIconFilename)
bool  FBObject_Unregister (str pGroupName, str pEntryName, int nth=0)
FBComponent  FBCreateObject (str pGroupName, str pEntryName, str pName, pData=None, int nth=0)
  FBCreateObject.
bool  FBUnregisterObject (str pGroupName, str pEntryName, int nth=0)
  FBUnregisterObject.
int  FBRegister_ClassId (str pClassName)
  FB_FORWARD (FBPropertyListComponent)
  FB_DEFINE_LIST (, Component)
  FB_FORWARD (FBFolder)
  FB_DEFINE_COMPONENT (, Folder)
  FB_DEFINE_ENUM (, ConnectionType)
  FB_DEFINE_ENUM (, ConnectionAction)
  FB_DEFINE_ENUM (, ObjectFlag)
  FB_FORWARD (FBPropertyListObject)
  __FB_FORWARD (FBEvent)
  __FB_FORWARD (FBEventConnectionNotify)
  __FB_FORWARD (FBEventConnectionDataNotify)
  __FB_FORWARD (FBEventConnectionStateNotify)
  __FB_FORWARD (FBCustomManager)
  FB_DEFINE_ENUM (, ConsoleChannelType)
  __FB_FORWARD (FBConsoleChannel)
  FB_DEFINE_ARRAY (, ConsoleChannel)
  __FB_FORWARD (FBConsole)
  FB_FORWARD (FBFbxObject)
  K_INTERFACE (IJLCooper, 100103033)
  __FB_FORWARD (FBJLCooper)
  FB_DEFINE_COMPONENT (, Constraint)
  FB_FORWARD (FBConstraintInfo)
  __FB_FORWARD (FBConstraint)
  __FB_FORWARD (FBBox)
  __FB_FORWARD (FBPropertyListBox)
  FB_DEFINE_LIST (, Box)
  FB_DEFINE_COMPONENT (, Box)
  __FB_FORWARD (FBBoxPlaceHolder)
  __FB_FORWARD (FBModelPlaceHolder)
  __FB_FORWARD (FBConstraintRelation)
  FB_DEFINE_COMPONENT (, ConstraintSolver)
  __FB_FORWARD (FBConstraintSolver)
  FB_FORWARD (FBPropertyListConstraintSolver)
  FB_DEFINE_COMPONENT (, PhysicalProperties)
  __FB_FORWARD (FBPhysicalProperties)
  FB_DEFINE_LIST (, PhysicalProperties)
  FB_FORWARD (FBPropertyListPhysicalProperties)
  __FB_FORWARD (FBConstraintManager)
  __FB_FORWARD (FBConstraintLayout)
  K_FORWARD (IKtLayoutRegion)
  K_FORWARD (IKtObject)
  FB_DEFINE_COMPONENT (, Layout)
  FB_DEFINE_COMPONENT (, VisualComponent)
  FB_DEFINE_COMPONENT (, View)
  FB_DEFINE_COMPONENT (, TreeNode)
  FB_DEFINE_ENUM (, Orientation)
  FB_DEFINE_ENUM (, InputType)
  FB_DEFINE_ENUM (, InputModifier)
  FB_DEFINE_ENUM (, InputKey)
  __FB_FORWARD (FBLayout)
  FB_FORWARD (FBStringList)
  FB_DEFINE_COMPONENT (, FBVisualComponent)
  FB_DEFINE_ENUM (, AttachType)
  FB_DEFINE_ENUM (, BorderStyle)
  __FB_FORWARD (FBEventInput)
  __FB_FORWARD (FBEventTransaction)
  __FB_FORWARD (FBEventDragAndDrop)
  FB_DEFINE_ENUM (, DragAndDropState)
  __FB_FORWARD (FBEventShow)
  __FB_FORWARD (FBEventActivate)
  __FB_FORWARD (FBEventExpose)
  __FB_FORWARD (FBEventResize)
  __FB_FORWARD (FBEventMenu)
  __FB_FORWARD (FBMenuItem)
  FB_DEFINE_ENUM (, MenuItemType)
  __FB_FORWARD (FBTabPanel)
  __FB_FORWARD (FBButton)
  FB_DEFINE_ENUM (, ButtonStyle)
  FB_DEFINE_ENUM (, TextJustify)
  FB_DEFINE_ENUM (, TextStyle)
  FB_DEFINE_ENUM (, ButtonLook)
  __FB_FORWARD (FBArrowButton)
  __FB_FORWARD (FBScrollBox)
  __FB_FORWARD (FBLabel)
  __FB_FORWARD (FBImageContainer)
  __FB_FORWARD (FBEdit)
  __FB_FORWARD (FBEditNumber)
  __FB_FORWARD (FBEditColor)
  __FB_FORWARD (FBEditVector)
  __FB_FORWARD (FBEventDblClick)
  __FB_FORWARD (FBList)
  FB_DEFINE_ENUM (, ListStyle)
  __FB_FORWARD (FBSlider)
  __FB_FORWARD (FBLayoutRegion)
  __FB_FORWARD (FBThermometer)
  __FB_FORWARD (FBSpread)
  FB_DEFINE_ENUM (, CellStyle)
  __FB_FORWARD (FBSpreadPart)
  __FB_FORWARD (FBSpreadCell)
  __FB_FORWARD (FBSpreadRow)
  __FB_FORWARD (FBSpreadColumn)
  __FB_FORWARD (FBEventSpread)
  __FB_FORWARD (FBContainer)
  FB_DEFINE_ENUM (, IconPosition)
  __FB_FORWARD (FBEditTimeCode)
  __FB_FORWARD (FBTreeNode)
  __FB_FORWARD (FBTree)
  __FB_FORWARD (FBEventTree)
  FB_DEFINE_ENUM (, EventTreeWhy)
  __FB_FORWARD (FBEventTreeSelect)
  __FB_FORWARD (FBView)
  __FB_FORWARD (FBProgress)
  __FB_FORWARD (FBPopup)
  __FB_FORWARD (FBFilePopup)
  FB_DEFINE_ENUM (, FilePopupStyle)
  __FB_FORWARD (FBFolderPopup)
int  FBMessageBox (str pBoxTitle, str pMessage, str pButton1Str, str pButton2Str=None, str pButton3Str=None, int pDefaultButton=0, int pScrolledMessage=0)
  Dialog popup box.
int  FBMessageBoxWithCheck (str pBoxTitle, str pMessage, str pButton1Str, str pButton2Str, str pButton3Str, str pCheckBoxStr, bool pCheckBoxValue, int pDefaultButton=0, int pScrolledMessage=0)
  Dialog popup box with a check box.
int  FBMessageBoxGetUserValue (str pBoxTitle, str pMessage, pValue, FBPopupInputType pValueType, str pButton1Str, str pButton2Str=None, str pButton3Str=None, int pDefaultButton=0, bool pLastButtonCancel=True)
  Dialog popup box to get user input.
  __FB_FORWARD (FBMemo)
  __FB_FORWARD (FBFCurveEditor)
  __FB_FORWARD (FBPropertyConnectionEditor)
  __FB_FORWARD (FBEditProperty)
  __FB_FORWARD (FBEditPropertyModern)
  __FB_FORWARD (FBBrowsingProperty)
  __FB_FORWARD (FBWidgetHolder)
  __FB_FORWARD (FBPlotPopup)
  FB_DEFINE_COMPONENT (, ModelTemplate)
  FB_DEFINE_COMPONENT (, Device)
  FB_DEFINE_COMPONENT (, Path3D)
  FB_DEFINE_COMPONENT (, Scene)
  FB_DEFINE_COMPONENT (, Model)
  __FB_FORWARD (FBHandle)
  FB_DEFINE_LIST (, Handle)
  FB_FORWARD (FBPropertyListHandle)
  __FB_FORWARD (FBModelTemplate)
  __FB_FORWARD (FBPropertyListModelTemplate)
  FB_DEFINE_LIST (, ModelTemplate)
  __FB_FORWARD (FBModelTemplateBinding)
  __FB_FORWARD (FBPropertyListModelTemplateBinding)
  __FB_FORWARD (FBDevice)
  __FB_FORWARD (FBPropertyListDevice)
  FB_FORWARD (FBDeviceNotifyInfo)
  __FB_FORWARD (FBDeviceInstrument)
  FB_DEFINE_COMPONENT (, DeviceInstrument)
  __FB_FORWARD (FBPropertyListDeviceInstrument)
  FB_DEFINE_LIST (, DeviceInstrument)
  FB_DEFINE_ENUM (, DeviceSamplingMode)
  __FB_FORWARD (FBDeviceGlove)
  K_FORWARD (IConnector)
  K_FORWARD (KFCurve)
  FB_FORWARD (FBEvaluateInfo)
  FB_DEFINE_ENUM (, Interpolation)
  FB_DEFINE_ENUM (, TangentMode)
  FB_DEFINE_ENUM (, TangentClampMode)
  FB_DEFINE_ENUM (, TangentConstantMode)
  FB_FORWARD (FBFCurve)
  __FB_FORWARD (FBFCurveKey)
  FB_FORWARD (FBPropertyListFCurveKey)
  FB_FORWARD (FBFCurveKey)
  __FB_FORWARD (FBFCurve)
  FB_DEFINE_COMPONENT (, FCurve)
  __FB_FORWARD (FBAnimationNode)
  __FB_FORWARD (FBPropertyListAnimationNode)
  FB_DEFINE_LIST (, AnimationNode)
  FB_DEFINE_COMPONENT (, AnimationNode)
  Animation node class.
  FB_DEFINE_ENUM (, EventAnimationNodeType)
  __FB_FORWARD (FBEventAnimationNode)
  FB_DEFINE_ENUM (, LayerMode)
  FB_DEFINE_ENUM (, LayerRotationMode)
  __FB_FORWARD (FBAnimationLayer)
  __FB_FORWARD (FBTake)
  FB_DEFINE_COMPONENT (, Take)
  __FB_FORWARD (FBTimeWarpManager)
  __FB_FORWARD (FBDeck)
  FB_DEFINE_ENUM (, DeckTransportMode)
  FB_DEFINE_COMPONENT (, Deck)
  __FB_FORWARD (FBDeckLayout)
  FB_FORWARD (FBDeviceCameraInstrument)
  FB_FORWARD (FBDeviceCamera)
  FB_FORWARD (FBDeviceOptical)
  __FB_FORWARD (FBDeviceLayout)
  __FB_FORWARD (FBDeviceOpticalLayout)
  __FB_FORWARD (FBDeviceCameraLayout)
HFBEvaluateInfo  FBGetDisplayInfo ()
  Get the displays evaluation information structure.
  FB_FORWARD (FBScene)
  FB_FORWARD (FBCharacter)
  __FB_FORWARD (FBFbxObject)
  __FB_FORWARD (FBModel)
  FB_DEFINE_ENUM (, ElementAction)
  FB_DEFINE_ENUM (, TakeSpanOnLoad)
  FB_DEFINE_ENUM (, CharacterLoadAnimationMethod)
  FB_DEFINE_ENUM (, FileFormatAndVersion)
  __FB_FORWARD (FBFbxOptions)
  __FB_FORWARD (FBFilter)
  __FB_FORWARD (FBPropertyListFilter)
  FB_DEFINE_COMPONENT (, Filter)
  FB_DEFINE_COMPONENT (, FilterLayout)
  FB_FORWARD (FBFilterManager)
  FB_FORWARD (FBFilter)
  __FB_FORWARD (FBFolder)
  __FB_FORWARD (FBGenericMenuItem)
  __FB_FORWARD (FBGenericMenu)
  __FB_FORWARD (FBMenuManager)
  FB_DEFINE_COMPONENT (, GenericMenuItem)
  FB_DEFINE_COMPONENT (, GenericMenu)
  FB_DEFINE_COMPONENT (, MenuManager)
  __FB_FORWARD (FBGroup)
  __FB_FORWARD (FBSet)
  FB_DEFINE_COMPONENT (, Group)
  FB_DEFINE_COMPONENT (, Set)
  FB_FORWARD (FBPropertyListGroup)
  FB_FORWARD (FBPropertyListSet)
  __FB_FORWARD (FBImage)
  FB_DEFINE_COMPONENT (, Image)
  FB_DEFINE_ENUM (, ImageFormat)
  FB_DEFINE_ENUM (, ImageType)
  FB_DEFINE_ENUM (, ImageInterleaveType)
  FB_DEFINE_ENUM (, ImageInterpolationType)
  FB_DEFINE_ENUM (, Parity)
  FB_DEFINE_ENUM (, RSType)
  FB_DEFINE_ENUM (, CommPortType)
  FB_DEFINE_COMPONENT (, CommPort)
  __FB_FORWARD (FBCommPort)
  __FB_FORWARD (FBPropertyListCommPort)
  __FB_FORWARD (FBTCPIP)
  __FB_FORWARD (FBKeyingGroup)
  FB_DEFINE_COMPONENT (, KeyingGroup)
  FB_DEFINE_LIST (, KeyingGroup)
  FB_DEFINE_COMPONENT (, Manipulator)
  FB_DEFINE_COMPONENT (, Camera)
  __FB_FORWARD (FBManipulator)
  FB_DEFINE_LIST (, Manipulator)
  __FB_FORWARD (FBManipulatorTransform)
  FB_DEFINE_COMPONENT (, ManipulatorTransform)
  FB_DEFINE_ENUM (, ManipulatorTransformType)
  __FB_FORWARD (FBManipulatorLayout)
  FB_DEFINE_ENUM (, RotationOrder)
  FBMatrixInverse (FBMatrix pMatrix, FBMatrix pSrc)
  Invert a matrix.
  FBMatrixTranspose (FBMatrix pMatrix, FBMatrix pSrc)
  Transpose a matrix.
  FBMatrixMult (FBMatrix pMatrix, FBMatrix pA, FBMatrix pB)
  Multiply two matrices.
  FBVertexMatrixMult (FBVector4 pOutVertex, FBMatrix pMatrix, FBVector4 pVertex)
  Multiply a vertex by a matrix.
  FBVectorMatrixMult (FBVector4 pOutVector, FBMatrix pMatrix, FBVector4 pVector)
  Multiply a vector by a matrix.
  FBTranslationToMatrix (FBMatrix pMatrix, FBVector4 pVector)
  Convert a translation vector to a matrix.
  FBRotationToMatrix (FBMatrix pMatrix, FBVector3 pVector, FBRotationOrder pRotationOrder=kFBXYZ)
  Convert a rotation vector to a matrix.
  FBScalingToMatrix (FBMatrix pMatrix, FBSVector pVector)
  Convert a scaling vector to a matrix.
  FBTRSToMatrix (FBMatrix pMatrix, FBVector4 pTVector, FBVector3 pRVector, FBSVector pSVector)
  Convert translation, rotation, and scaling vectors to a matrix.
  FBMatrixToTranslation (FBVector4 pVector, FBMatrix pMatrix)
  Obtain translation vector from a matrix.
  FBMatrixToRotation (FBVector3 pVector, FBMatrix pMatrix, FBRotationOrder pRotationOrder=kFBXYZ)
  Obtain rotation vector from a matrix.
  FBMatrixToScaling (FBSVector pVector, FBMatrix pMatrix)
  Obtain scaling vector from a matrix.
  FBMatrixToTRS (FBVector4 pTVector, FBVector3 pRVector, FBSVector pSVector, FBMatrix pMatrix)
  Obtain translation, rotation, and scaling vectors from a matrix.
  FBRotationToQuaternion (FBVector4 pQuaternion, FBVector3 pVector, FBRotationOrder pRotationOrder=kFBXYZ)
  Get a quaternion from a rotation vector.
  FBQuaternionToRotation (FBVector3 pVector, FBVector4 pQuaternion, FBRotationOrder pRotationOrder=kFBXYZ)
  Get a rotation vector from a quaternion vector.
  FBGetLocalMatrix (FBMatrix pMatrix, FBMatrix pMatrixParent, FBMatrix pMatrixChild)
  Get local matrix from parent and child matrices.
  FBGetGlobalMatrix (FBMatrix pMatrix, FBMatrix pMatrixParent, FBMatrix pLocalMatrix)
  Get global matrix from parent and child matrices.
  FBMatrixOrthogonalize (FBMatrix pMatrix)
  Get global matrix from parent and child matrices.
  FBAdd (FBVector4 pResult, FBVector4 pV1, FBVector4 pV2)
  Add two vectors together (pResult = pV1+pV2).
  FBSub (FBVector4 pResult, FBVector4 pV1, FBVector4 pV2)
  Subtract pV2 from pV1 (pResult = pV1-pV2).
  FBMult (FBVector4 pResult, FBVector4 pV1, float pV2)
  Multiply pV2 from pV1 (pResult = pV1*pV2).
  FBMult (FBVector4 pResult, FBVector4 pV1, FBVector4 pV2)
  Calculate the cross product of two vectors.
  FBMult (FBMatrix pResult, FBMatrix pM, FBSVector pV)
  Calculate the cross product of a Matrix and Scale Vector.
float  FBDot (FBVector4 pV1, FBVector4 pV2)
  Calculate the dot product of two vectors.
float  FBLength (FBVector4 pV)
  Get the length of a vector.
  FBQAdd (FBVector4 pResult, FBVector4 pQ1, FBVector4 pQ2)
  Add two quaternions together (pResult = pQ1+pQ2).
  FBQSub (FBVector4 pResult, FBVector4 pQ1, FBVector4 pQ2)
  Subtract pQ2 from pQ1 (pResult = pQ1-pQ2).
  FBQMult (FBVector4 pResult, FBVector4 pQ1, float pQ2)
  Multiply pQ2 from pQ1 (pResult = pQ1*pQ2).
  FBQMult (FBVector4 pResult, FBVector4 pQ1, FBVector4 pQ2)
  Calculate the cross product of two quaternions.
float  FBQDot (FBVector4 pQ1, FBVector4 pQ2)
  Calculate the dot product of two quaternions.
float  FBQLength (FBVector4 pQ)
  Get the length of a quaternion.
  FBInterpolateRotation (FBVector3 pROut, FBVector3 pR0, FBVector3 pR1, float pU)
  Interpolate a rotation in Euler space.
  FBInterpolateRotation (FBVector4 pQOut, FBVector4 pQ0, FBVector4 pQ1, float pU)
  Interpolate a rotation in Quaternion.
  FBGetContinuousRotation (FBVector3 pROut, FBVector3 pR0, FBVector3 pR1)
  Get a continuous rotation in Euler space.
float  FBClamp (float pV, float pL, float pH)
  Clamp value.
  FBBigEndianToNative (int pV)
  Change from big endian to native format.
  FBLittleEndianToNative (int pV)
  Change from little endian to native format.
  FB_DEFINE_COMPONENT (, CameraStereo)
  FB_DEFINE_COMPONENT (, Light)
  FB_DEFINE_COMPONENT (, Cluster)
  FB_DEFINE_COMPONENT (, Geometry)
  FB_DEFINE_COMPONENT (, Mesh)
  FB_DEFINE_COMPONENT (, ModelVertexData)
  FB_DEFINE_COMPONENT (, Video)
  FB_DEFINE_COMPONENT (, PointCacheFile)
  FBModelTransactionBegin ()
  FBModelTransactionBegin.
  FBModelTransactionEnd ()
  FBModelTransactionEnd.
  __FB_FORWARD (FBPropertyListModel)
  FB_DEFINE_LIST (, Model)
  __FB_FORWARD (FBMaterial)
  PropertyList: Material.
  __FB_FORWARD (FBTexture)
  PropertyList: Texture.
  __FB_FORWARD (FBDeformer)
  PropertyList: Texture.
  FB_DEFINE_ENUM (, ModelShadingMode)
  FB_DEFINE_ENUM (, ModelTransformationMatrix)
  FB_DEFINE_ENUM (, ModelRotationOrder)
  __FB_FORWARD (FBModelNull)
  __FB_FORWARD (FBModelRoot)
  __FB_FORWARD (FBModelMarker)
  FB_DEFINE_ENUM (, MarkerResolutionLevel)
  FB_DEFINE_ENUM (, MarkerLook)
  FB_DEFINE_ENUM (, MarkerType)
  __FB_FORWARD (FBModelSkeleton)
  __FB_FORWARD (FBModelCube)
  __FB_FORWARD (FBModelPlane)
  __FB_FORWARD (FBModelPath3D)
  FB_DEFINE_ENUM (, PathTangeantMode)
  FB_DEFINE_ENUM (, TextureUseType)
  FB_DEFINE_ENUM (, TextureMapping)
  FB_DEFINE_ENUM (, TextureBlendMode)
  __FB_FORWARD (FBLayeredTexture)
  FB_DEFINE_ENUM (, ClusterMode)
  __FB_FORWARD (FBCluster)
  __FB_FORWARD (FBCamera)
  FB_DEFINE_ENUM (, CameraType)
  FB_DEFINE_ENUM (, CameraApertureMode)
  FB_DEFINE_ENUM (, CameraFilmBackType)
  FB_DEFINE_ENUM (, CameraFrameSizeMode)
  FB_DEFINE_ENUM (, CameraResolutionMode)
  FB_DEFINE_ENUM (, CameraViewPlaneMode)
  FB_DEFINE_ENUM (, CameraDistanceMode)
  FB_DEFINE_ENUM (, CameraSafeAreaMode)
  FB_DEFINE_ENUM (, CameraAntiAliasingMethod)
  FB_DEFINE_ENUM (, CameraSamplingType)
  FB_DEFINE_ENUM (, CameraFocusDistanceSource)
  FB_DEFINE_ENUM (, CameraMatrixType)
  __FB_FORWARD (FBCameraStereo)
  FB_DEFINE_ENUM (, CameraStereoType)
  __FB_FORWARD (FBCameraSwitcher)
  __FB_FORWARD (FBGlobalLight)
  FB_DEFINE_ENUM (, FogMode)
  __FB_FORWARD (FBLight)
  FB_DEFINE_ENUM (, LightType)
  FB_DEFINE_ENUM (, AttenuationType)
  __FB_FORWARD (FBModelVertexData)
  __FB_FORWARD (FBGeometry)
  FB_DEFINE_ENUM (, GeometryMappingMode)
  FB_DEFINE_ENUM (, GeometryReferenceMode)
  __FB_FORWARD (FBMesh)
  __FB_FORWARD (FBSurface)
  FB_DEFINE_ENUM (, SurfaceMode)
  FB_DEFINE_ENUM (, SurfaceType)
  FB_DEFINE_ENUM (, NurbType)
  __FB_FORWARD (FBNurbs)
  __FB_FORWARD (FBPatch)
  FB_DEFINE_ENUM (, DeformerType)
  __FB_FORWARD (FBDeformerPointCache)
  __FB_FORWARD (FBPointCacheFile)
  __FB_FORWARD (FBMotionClip)
  FB_DEFINE_COMPONENT (, MotionClip)
  FB_FORWARD (FBPlug)
str  FBGetMultiLangText (FBPlug pContext, str pKey, bool pFlagReturnKey=False)
  Name lookup in the context of an object.
str  FBGetMultiLangText (str pContext, str pKey, bool pFlagReturnKey=False)
  Name lookup in a user defined context context.
  FB_FORWARD (FBMultiLangManager)
  __FB_FORWARD (FBNote)
  FB_DEFINE_COMPONENT (, Note)
  FB_DEFINE_LIST (, Note)
  FB_FORWARD (FBObjectPoseOptions)
  FB_FORWARD (FBObjectPoseMirrorOptions)
  __FB_FORWARD (FBObjectPose)
  GetPlaneEquation (FBVector4 pPlaneEquation, FBVector4 pPlaneNormalVector, FBVector4 pPointOnPlane)
  Get a plane equation from a normal vector and a point on the plane.
  GetPlaneEquation (FBVector4 pPlaneEquation, FBVector4 pPointOnPlane, FBMatrix pPlaneRM)
  Get a plane equation from a point on the plane and a rotation matrix relative to the plane XZ.
  GetPlaneRotation (FBMatrix pPlaneRM, FBVector4 pPlaneEquation)
  Get the plane rotation matrix from a plane equation.
  NormalizePlaneEquation (FBVector4 pNormalizedPlaneEquation, FBVector4 pPlaneEquation)
  Normalize a plane equation.
  MirrorTransform (FBVector4 pMirrorT, FBMatrix pMirrorRM, FBMatrix pMirrorSM, FBVector4 pT, FBMatrix pRM, FBMatrix pSM, FBVector4 pPlaneEquation)
  Mirror a transformation using the specified mirror plane.
  MirrorTransformT (FBVector4 pMirrorT, FBVector4 pT, FBVector4 pPlaneEquation)
  Mirror a translation using the specified mirror plane.
  MirrorTransformR (FBMatrix pMirrorRM, FBMatrix pRM, FBVector4 pPlaneEquation)
  Mirror a rotation using the specified mirror plane.
  __FB_FORWARD (FBModelOptical)
  FB_DEFINE_COMPONENT (, ModelOptical)
  FB_DEFINE_COMPONENT (, ModelMarkerOptical)
  FB_DEFINE_COMPONENT (, RigidBody)
  __FB_FORWARD (FBOpticalSegment)
  FB_DEFINE_COMPONENT (, OpticalSegment)
  FB_DEFINE_ARRAY (, OpticalSegment)
  FB_DEFINE_LIST (, OpticalSegment)
  FB_FORWARD (FBPropertyListMarkerSegment)
  FB_FORWARD (FBPropertyListOpticalSegment)
  FB_DEFINE_ENUM (, GapMode)
  __FB_FORWARD (FBOpticalGap)
  FB_DEFINE_COMPONENT (, OpticalGap)
  FB_DEFINE_ARRAY (, OpticalGap)
  FB_DEFINE_LIST (, OpticalGap)
  FB_FORWARD (FBPropertyListOpticalGap)
  __FB_FORWARD (FBModelMarkerOptical)
  FB_DEFINE_ARRAY (, ModelMarkerOptical)
  FB_DEFINE_LIST (, ModelMarkerOptical)
  FB_FORWARD (FBPropertyListModelMarkerOptical)
  FB_FORWARD (FBPropertyListRigidBodyMarkers)
  FB_DEFINE_ENUM (, RigidBodyMode)
  __FB_FORWARD (FBRigidBody)
  FB_DEFINE_ARRAY (, RigidBody)
  FB_DEFINE_LIST (, RigidBody)
  FB_FORWARD (FBPropertyListRigidBody)
  FB_DEFINE_ENUM (, GenerationMode)
  FB_DEFINE_ENUM (, ControllerMode)
  FB_DEFINE_ENUM (, SegmentMode)
  FB_DEFINE_ENUM (, InsertSegmentMode)
  __FB_FORWARD (FBModelOpticalAdvanced)
  __FB_FORWARD (FBDeviceOpticalMarker)
  FB_DEFINE_ARRAY (, DeviceOpticalMarker)
  FB_DEFINE_LIST (, DeviceOpticalMarker)
  FB_FORWARD (FBPropertyListDeviceOpticalMarker)
  __FB_FORWARD (FBDeviceOptical)
bool  FBConnect (FBPlug pSrc, FBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Request the connection two FBPlug objects.
bool  FBDisconnect (FBPlug pSrc, FBPlug pDst)
  Connect two FBPlug objects.
  FB_DEFINE_COMPONENT (, Pose)
  __FB_FORWARD (FBPose)
  FB_DEFINE_ENUM (, PoseType)
  __FB_FORWARD (FBPropertyListPose)
  __FB_FORWARD (FBProfiler)
  Forwarding of class and type declaration.
  FB_FORWARD (FBProfileTaskCycle)
  __FB_FORWARD (FBProfileTimeEvent)
  FB_FORWARD (FBProfilerHelper)
  FB_DEFINE_ENUM (, ProfilingMode)
HFBProfileTaskCycle  FBGetMainThreadTaskCycle ()
  Get root task cycle.
HFBProfileTaskCycle  FBGetRenderingTaskCycle ()
  Get rendering task cycle.
HFBProfileTaskCycle  FBGetEvaluationTaskCycle ()
  Get evaluation task cycle.
  K_FORWARD (KObject)
  K_FORWARD (KProperty)
  K_FORWARD (KEvaluationProperty)
  K_FORWARD (KDataType)
  K_FORWARD (IFBObject)
  FB_FORWARD (FBComponent)
  __FB_FORWARD (FBProperty)
  __FB_FORWARD (FBPropertyAnimatable)
  FB_FORWARD (FBBox)
  FB_FORWARD (FBAnimationNode)
  FB_FORWARD (FBTake)
  __FB_FORWARD (FBPropertyEvent)
  FB_FORWARD (FBPropertyStringList)
  __FB_FORWARD (FBPropertyManager)
  __FB_FORWARD (FBRenderer)
  FB_FORWARD (FBView)
  FB_DEFINE_COMPONENT (, Renderer)
  FB_FORWARD (FBViewingOptions)
  FB_DEFINE_ENUM (, DeviceKeyboardKey)
bool  operator== (FBPickInfos pLhs, FBPickInfos pRhs)
  __FB_FORWARD (FBViewerInfos)
  FB_DEFINE_COMPONENT (, ViewerInfos)
  FB_DEFINE_ENUM (, SceneChangeType)
  __FB_FORWARD (FBEventSceneChange)
  FB_DEFINE_ENUM (, TakeChangeType)
  __FB_FORWARD (FBEventTakeChange)
  FB_FORWARD (FBPropertyListScene)
  __FB_FORWARD (FBScene)
  FB_DEFINE_LIST (, Scene)
  FB_FORWARD (FBScriptWrapper)
  FB_FORWARD (FBWrapperHolder)
  K_FORWARD (KRenderOptions)
  K_FORWARD (KModelRenderInfo)
  K_FORWARD (IGraphicPrimitives)
  FB_FORWARD (FBShaderManager)
  FB_FORWARD (FBShader)
  FB_FORWARD (FBShaderModelInfo)
  FB_FORWARD (FBRenderOptions)
  FBRenderOptions.
  FB_DEFINE_ENUM (, RenderingPass)
  FB_FORWARD (FBRenderer)
  __FB_FORWARD (FBShader)
  FB_DEFINE_COMPONENT (, Shader)
  FB_DEFINE_LIST (, Shader)
  FB_FORWARD (FBShaderLighted)
  FB_DEFINE_COMPONENT (, ShaderLighted)
  FB_FORWARD (FBShaderShadowLive)
  FB_DEFINE_COMPONENT (, ShaderShadowLive)
  FB_DEFINE_ENUM (, ShadowType)
  FB_DEFINE_ENUM (, ShadowFrameType)
  __FB_FORWARD (FBShaderLayout)
  FB_DEFINE_COMPONENT (, ShaderLayout)
  __FB_FORWARD (FBStory)
  __FB_FORWARD (FBStoryFolder)
  __FB_FORWARD (FBStoryTrack)
  __FB_FORWARD (FBStoryClip)
  FB_DEFINE_COMPONENT (, Story)
  FB_DEFINE_COMPONENT (, StoryFolder)
  FB_DEFINE_COMPONENT (, StoryTrack)
  FB_DEFINE_COMPONENT (, StoryClip)
  FB_DEFINE_ENUM (, StoryTrackType)
  FB_DEFINE_ENUM (, StoryTrackRefMode)
  FB_DEFINE_ENUM (, StoryClipShowGhostMode)
  FB_DEFINE_ENUM (, StoryClipSolveMode)
  FB_DEFINE_ENUM (, StoryClipCompMode)
  FB_FORWARD (FBPropertyListStoryFolder)
  FB_FORWARD (FBPropertyListStoryTrack)
  FB_FORWARD (FBPropertyListStorySubTrack)
  FB_FORWARD (FBPropertyListStoryClip)
  FB_FORWARD (FBPropertyListStoryDetails)
  FB_FORWARD (FBPropertyListPivot)
  K_FORWARD (KStringList)
str  operator+ (str p1Str, str p2Str)
object  FBGetFBObject (object pObject, bool pAutoCreate=False)
  Get the SDK object from an Internal Object.
FBCast (object 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 (, BatchProcessType)
  FB_DEFINE_ENUM (, BatchFileFormat)
  FB_DEFINE_ENUM (, BatchOnTakeExist)
  FB_DEFINE_ENUM (, BatchOnContainsBatchTakes)
  FB_DEFINE_ENUM (, RotationFilter)
  __FB_FORWARD (FBApplication)
  __FB_FORWARD (FBPlayerControl)
  FB_DEFINE_ENUM (, TransportMode)
  FB_DEFINE_ENUM (, TransportTimeFormat)
  FB_DEFINE_ENUM (, TransportPlaySpeed)
  FB_DEFINE_ENUM (, TransportSnapMode)
  FB_DEFINE_ENUM (, ParallelScheduleType)
  __FB_FORWARD (FBEvaluateManager)
  Evaluate Manager.
  __FB_FORWARD (FBKeyControl)
  __FB_FORWARD (FBPointCacheManager)
  FB_FORWARD (FBCriticalSection)
  __FB_FORWARD (FBReferenceTime)
tuple  FBCreateModelList ()
  Create a FBModelList object.
  FBDestroyModelList (tuple pModelList)
  Delete a FBModelList object.
tuple  FBCreatePickInfosList ()
  Create a FBPickInfosList object.
  FBDestroyPickInfosList (tuple pPickInfosList)
  Delete a FBPickInfosList object.
tuple  FBCreateComponentList ()
  Create a FBObjectList object.
  FBDestroyComponentList (tuple pObjectList)
  Delete a FBObjectList object.
  FBSleep (long MilliSeconds)
  Sleep function Puts system to sleep for specified time.
FBModel  FBFindModelByName (str pModelName, FBModel pParent=None)
FBModel  FBFindModelByLabelName (str pModelLabelName)
  Find a model in the scene by its label name.
FBModel  FBLoadFbxPrimitivesModel (str pModelName)
  Load a model.
  FBFindModelsOfType (tuple pList, int pTypeInfo, FBModel pParent=None)
  Find all models of a certain type in the scene.
  FBGetSelectedModels (tuple 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.
  FBSelectObjectsByNamespace (str pNameSpaceName, bool pSelect, bool pSearchExclusive=True)
  FBSelectObjectsByNamespace.
  FBFindObjectsByName (str pNamePattern, tuple pList, bool pIncludeNamespace=True, bool pModelsOnly=False)
  FBFindObjectsByName.
HFBComponent  FBFindObjectByFullName (str pObjectFullName)
  FBFindObjectByFullName.
  FBFindObjectsByNamespace (str pNamePattern, tuple pList)
  FBFindObjectsByNamespace.
  FBBeginChangeAllModels ()
  Call begin change to all models (need to be closed).
  FBEndChangeAllModels ()
  Call end change to all models (should be first open).
  FBTrace (str pFormatString,)
  This function prints useful debugging strings in the console.
bool  FBPopNormalTool (str pToolName, bool pSetFocus=True)
  This function is used to bring up a specific tool in the GUI.
  FB_FORWARD (FBTime)
  FB_FORWARD (FBTimeCode)
  __FB_FORWARD (FBTool)
FBTimeMode  FBGetSyncTimeMode ()
  Returns the time mode for the current system sync.
  __FB_FORWARD (FBDeviceSyncPacket)
  __FB_FORWARD (FBDeviceSync)
  __FB_FORWARD (FBDeviceCameraPacket)
  FB_DEFINE_COMPONENT (, DeviceCameraPacket)
  __FB_FORWARD (FBDeviceCameraInstrument)
  __FB_FORWARD (FBDeviceCamera)
  __FB_FORWARD (FBTriggerGroup)
  __FB_FORWARD (FBTrigger)
  __FB_FORWARD (FBTriggerBranch)
  __FB_FORWARD (FBPropertyListTriggerGroup)
  __FB_FORWARD (FBPropertyListTrigger)
  __FB_FORWARD (FBPropertyListMotionClip)
  __FB_FORWARD (FBPropertyListTriggerBranch)
  FB_DEFINE_COMPONENT (, TriggerGroup)
  FB_DEFINE_COMPONENT (, Trigger)
  FB_DEFINE_COMPONENT (, TriggerBranch)
  FB_DEFINE_ENUM (, TriggerSource)
  FB_DEFINE_ENUM (, TriggerMode)
  FB_DEFINE_ENUM (, TriggerType)
  __FB_FORWARD (FBPropertyInspector)
  FB_FORWARD (FBUndoManager)
  FB_FORWARD (FBUndo)
  FB_DEFINE_ARRAY (, Plug)
  __FB_FORWARD (FBUserObject)
  FB_DEFINE_COMPONENT (, UserObject)
  FB_DEFINE_COMPONENT (, VideoIn)
  FB_DEFINE_COMPONENT (, VideoOut)
  FB_DEFINE_COMPONENT (, VideoClip)
  FB_DEFINE_COMPONENT (, VideoClipImage)
  FB_DEFINE_COMPONENT (, VideoSwitcher)
  __FB_FORWARD (FBVideo)
  __FB_FORWARD (FBVideoClip)
  FB_DEFINE_ENUM (, VideoProxyMode)
  FB_DEFINE_ENUM (, VideoStorageMode)
  FB_DEFINE_ENUM (, VideoInterlaceMode)
  FB_DEFINE_ENUM (, VideoFormat)
  __FB_FORWARD (FBVideoClipImage)
  __FB_FORWARD (FBVideoMemory)
  __FB_FORWARD (FBVideoIn)
  __FB_FORWARD (FBVideoOut)
  __FB_FORWARD (FBVideoSwitcher)
  __FB_FORWARD (FBEventVideoSwitcher)
  FB_DEFINE_ENUM (, ClipEnd)
  FB_DEFINE_ENUM (, PlayMode)
  __FB_FORWARD (FBVideoGrabber)
  FB_DEFINE_COMPONENT (, VideoGrabber)
  K_INTERFACE (ICallback, 2)
  K_FORWARD (IObject)
  forwarding.
int  strcpy_s (str dst, int bufsize, str src)
int  strcpy_s (function dst, str src)
int  strncpy_s (str dst, int bufsize, str src, int count)
int  strncpy_s (function dst, str src, int count)
int  vsprintf_s (str buffer, int bufsize, str format, va_list args)
int  vsprintf_s (function buffer, str format, va_list args)
int  sprintf_s (str buffer, int bufsize, str format,)
int  sprintf_s (function buffer, str format,)
int  strcat_s (str dst, int bufsize, str src)
int  strcat_s (function dst, str src)
str  _itoa (int pValue, str pString, int pRadix)
tuple< int, bool FBMessageBoxWithCheck (str pBoxTitle, str pMessage, str pButton1Str, str pButton2Str, str pButton3Str, str pCheckBoxStr, bool pCheckBoxValue, int pDefaultButton=0, bool pScrolledMessage=False)
  Dialog popup box with 'don't show again' option.
tuple< int, str FBMessageBoxGetUserValue (str pBoxTitle, str pMessage, object pValue, FBPopupInputType pValueType, str pButton1Str, str pButton2Str=None, str pButton3Str=None, int pDefaultButton=0)
  Dialog popup box to get user input.

Variables

int  kFBLastActorNodeId = ( kFBHeadNodeId + 1 )
  Last Actor NodeId.

Function Documentation

pyfbsdk.__FB_FORWARD ( FBApplyManagerRule  )
pyfbsdk.FB_DEFINE_COMPONENT ( K_DLLIMPORT  ,
ApplyManagerRule   
)
pyfbsdk.FBRealloc ( memblock  ,
int  size 
)

General allocation function, actually calling standard function "realloc".

Parameters:
memblock Memory block to reallocate.
size Size of block to allocate
Returns:
new allocated or resized block.
pyfbsdk.FBFree ( memblock  )

General free function, actually calling standard function "free".

Parameters:
memblock Memory block to free.
pyfbsdk.__FB_FORWARD ( FBAssetItem  )
pyfbsdk.__FB_FORWARD ( FBAssetFile  )
pyfbsdk.__FB_FORWARD ( FBAssetFolder  )
pyfbsdk.__FB_FORWARD ( FBAssetMng  )
pyfbsdk.FB_DEFINE_COMPONENT ( AssetMng  )
pyfbsdk.__FB_FORWARD ( FBAudioIn  )
pyfbsdk.__FB_FORWARD ( FBAudioOut  )
pyfbsdk.__FB_FORWARD ( FBAudioClip  )
pyfbsdk.FB_DEFINE_COMPONENT ( AudioIn  )
pyfbsdk.FB_DEFINE_COMPONENT ( AudioOut  )
FB_DEFINE_COMPONENT ( AudioClip  )
pyfbsdk.FB_DEFINE_ENUM ( AccessMode  )
pyfbsdk.FB_DEFINE_ENUM ( UseChnMode  )
pyfbsdk.FB_DEFINE_ENUM ( TriggerStyle  )
HFBAudioOut pyfbsdk.FBAudioOutGetDefault ( )

Get default audio output.

int pyfbsdk.FBAudioFmt_GetDefaultFormat ( )
int pyfbsdk.FBAudioFmt_AppendFormat ( int  pFormat,
int  pChannels,
int  pBits,
int  pRate 
)
int pyfbsdk.FBAudioFmt_AppendFormat ( int  pFormat,
int  pSrcFormat 
)
int pyfbsdk.FBAudioFmt_RemoveFormat ( int  pFormat,
int  pChannels,
int  pBits,
int  pRate 
)
int pyfbsdk.FBAudioFmt_RemoveFormat ( int  pFormat,
int  pSrcFormat 
)
int pyfbsdk.FBAudioFmt_GetChannelValue ( int  pFormat )
int pyfbsdk.FBAudioFmt_GetBitsValue ( int  pFormat )
int pyfbsdk.FBAudioFmt_GetBytesValue ( int  pFormat )
int pyfbsdk.FBAudioFmt_GetRateValue ( int  pFormat )
bool pyfbsdk.FBAudioFmt_TestFormat ( int  pSrcFormat,
int  pChannels,
int  pBits,
int  pRate 
)
pyfbsdk.FB_DEFINE_ENUM ( CharacterInputType  )
pyfbsdk.FB_DEFINE_ENUM ( CharacterKeyingMode  )
pyfbsdk.FB_DEFINE_ENUM ( CharacterPlotWhere  )
pyfbsdk.FB_DEFINE_ENUM ( CharacterHipsTranslationMode  )
pyfbsdk.FB_DEFINE_ENUM ( CharacterRollSolver  )
pyfbsdk.FB_DEFINE_ENUM ( CharacterContactBehaviour  )
pyfbsdk.FB_DEFINE_ENUM ( ControlSetType  )
str pyfbsdk.FBCharacterBodyNodeNameFromId ( FBBodyNodeId  pBodyNodeId )

Get the UI name associated with a body node.

Parameters:
pBodyNodeId The body node ID.
Returns:
The UI name for this body node.
str pyfbsdk.FBCharacterEffectorNameFromId ( FBEffectorId  pEffectorId )

Get the UI name associated with an effector.

Parameters:
pEffectorId The effector ID.
Returns:
The UI name for this effector.
pyfbsdk.__FB_FORWARD ( FBMarkerSet  )
pyfbsdk.FB_DEFINE_COMPONENT ( MarkerSet  )
FB_FORWARD ( FBModel  )
pyfbsdk.__FB_FORWARD ( FBControlSet  )
pyfbsdk.FB_DEFINE_COMPONENT ( ControlSet  )
pyfbsdk.__FB_FORWARD ( FBSkeletonState  )

Skeleton State class.

These classes are under development and may change dramatically between versions.

__FB_FORWARD ( FBActor  )
FB_DEFINE_COMPONENT ( Actor  )
FB_FORWARD ( FBPlotOptions  )
__FB_FORWARD ( FBCharacter  )
FB_DEFINE_COMPONENT ( Character  )
pyfbsdk.FB_FORWARD ( FBPropertyListCharacter  )
FBCharacterKeyingMode pyfbsdk.FBGetCharactersKeyingMode ( )

return Character Manipulation/Keying Mode.

Returns:
Keying Mode
FBBodyPartId pyfbsdk.FBGetEffectorBodyPart ( FBEffectorId  pEffectorId )

return BodyPart ID from Effector.

Parameters:
pEffectorId Effector ID.
Returns:
ID of the BodyPart the effector is in.
FBBodyPartId pyfbsdk.FBGetBodyNodeBodyPart ( FBBodyNodeId  pBodyNodeId )

return BodyPart ID from Bones.

Parameters:
pBodyNodeId Body Node ID.
Returns:
ID of the BodyPart the effector is in.
HFBCharacter pyfbsdk.FBGetCharacterByAssociatedPart ( HFBComponent  pPart )

Get character by its associated IK/FK Marker or Bone.

Parameters:
pPart associated IK/FK Marker or Bone
Returns:
character.
pyfbsdk.__FB_FORWARD ( FBCharacterExtension  )
pyfbsdk.FB_DEFINE_ENUM ( PlotAllowed  )
pyfbsdk.FB_DEFINE_COMPONENT ( CharacterExtension  )
pyfbsdk.FB_DEFINE_LIST ( CharacterExtension  )
pyfbsdk.__FB_FORWARD ( FBActorFace  )
pyfbsdk.FB_DEFINE_COMPONENT ( ActorFace  )
pyfbsdk.__FB_FORWARD ( FBCharacterFace  )
pyfbsdk.FB_DEFINE_COMPONENT ( CharacterManipulator  )
pyfbsdk.FB_DEFINE_COMPONENT ( CharacterManipulatorCtrlSet  )
pyfbsdk.__FB_FORWARD ( FBCharacterManipulator  )

Used to translate, rotate or scale a character.

These classes are under development and may change dramatically between versions. This class exposes part of the functionality associated with Character manipulation. This class is a pure virtual class, it defined the basic functions that a manipulator must implement to be useful. Here is an example of how a manipulator works (translation manipulator in this case): 1- After a model has been selected in the viewer, the manipulator is displayed. The function TranslationGet() is called to determnine the location of the manipulator. 2- The user select the manipualtor and start a manipulation. The function TranslationIsEditable() is called. Based on the returned value, the manipulation will continue or will be stopped (the manipulator will not moved). 3- If the manipulation continues, the function TranslationStartManipulation() will be called. This function is useful to setup internal state before the actual manipulation starts. Based on the returned value of TranslationStartManipulation(), the manipulation will continue or will be stopped. 4- If the manipulation continue, a TranslationSet() will be called. This function will contains a new value and information about the manipulation. Use this information to set the new TRS values of the manipulated model. 5- TranslationGet() and TranslationSet() will be called one after the other until the manipulation is done, to reposition the manipulator and to update the model location. 6- When the manipulation is finished, TranslationStopManipulation() is called.

pyfbsdk.__FB_FORWARD ( FBCharacterManipulatorCtrlSet  )
pyfbsdk.FB_FORWARD ( FBCharacterPoseOptions  )
pyfbsdk.__FB_FORWARD ( FBCharacterPose  )
pyfbsdk.FB_DEFINE_COMPONENT ( CharacterSolver  )
pyfbsdk.__FB_FORWARD ( FBCharacterSolver  )
int pyfbsdk.FBGetCharacterExternalSolverCount ( )

Get character external solver count.

Returns:
Number of external character solver available.
str pyfbsdk.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.
int pyfbsdk.FBGetCharacterExternalSolverIndex ( str  pName )

Get character external solver index.

Parameters:
pName Name of external solver.
Returns:
Index of external solver specified at the provided name.
FBCharacterSolver pyfbsdk.FBInstanciateCharacterExternalSolver ( int  pIndex,
str  pSolverName = None 
)

Instanciate the given external character solver.

Parameters:
pIndex Index of the registered external character solver.
pSolverName Name of external solver.
Returns:
Instance of the external character solver specified by the Index.
pyfbsdk.__FB_FORWARD ( FBCommand  )
pyfbsdk.FB_DEFINE_ENUM ( CommandState  )
pyfbsdk.FB_DEFINE_ENUM ( TimeReferential  )
pyfbsdk.FB_DEFINE_COMPONENT ( Command  )
K_FORWARD ( IRegister  )
pyfbsdk.K_FORWARD ( IError  )
pyfbsdk.K_FORWARD ( IStore  )
K_FORWARD ( IKtView  )
K_FORWARD ( KEventBase  )
pyfbsdk.K_FORWARD ( KGlobalNamedEvent  )
pyfbsdk.__FB_FORWARD ( FBComponent  )
__FB_FORWARD ( FBVisualComponent  )
FBComponent pyfbsdk.GetFBComponent ( object  Object )

Get a handle to the FBComponent belonging to an HIObject.

This will not create the internal SDK object, and will return NULL if the SDK object has not been initialized.

Parameters:
Object Internal object for which the FBComponent is required.
Returns:
Handle to FBComponent belonging to Object.
FBVisualComponent pyfbsdk.FBGetFBVisualComponent ( HIKtView  pObject,
bool  pAutoCreate = True 
)

Get the FBComponent from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default is true)
Returns:
FBComponent for pObject.
FBComponent pyfbsdk.FBGetFBComponent ( object  pObject,
bool  pAutoCreate = True 
)

Get the FBComponent from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default is true)
Returns:
FBComponent for pObject.
FBPlug pyfbsdk.FBGetFBPlug ( object  pObject,
bool  pAutoCreate = True 
)

Get the FBPlug from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default is true)
Returns:
FBComponent for pObject.
tuple pyfbsdk.FBGetComponentArray ( )
pyfbsdk.FBSetStoreableCustomModelReigstered ( )
bool pyfbsdk.FBGetStoreableCustomModelReigstered ( )
bool pyfbsdk.FBObject_Register ( str  pGroupName,
str  pEntryName,
str  pDescription,
function  pCreatorFnc,
bool  pIsMultipleAllowed,
str  pIconFilename 
)
bool pyfbsdk.FBObject_Unregister ( str  pGroupName,
str  pEntryName,
int  nth = 0 
)
FBComponent pyfbsdk.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 occurence of the object to remove.
Examples
BasicOperations/ObjectCreation.py
bool pyfbsdk.FBUnregisterObject ( str  pGroupName,
str  pEntryName,
int  nth = 0 
)

FBUnregisterObject.

Parameters:
pGroupName Set the Name of the Group from which unregister an object.
pEntryName Set the name of the Object to unregister.
nth Set the occurence of the object to remove.
int pyfbsdk.FBRegister_ClassId ( str  pClassName )
pyfbsdk.FB_FORWARD ( FBPropertyListComponent  )
pyfbsdk.FB_DEFINE_LIST ( Component  )
pyfbsdk.FB_FORWARD ( FBFolder  )
FB_DEFINE_COMPONENT ( Folder  )
pyfbsdk.FB_DEFINE_ENUM ( ConnectionType  )
pyfbsdk.FB_DEFINE_ENUM ( ConnectionAction  )
pyfbsdk.FB_DEFINE_ENUM ( ObjectFlag  )
pyfbsdk.FB_FORWARD ( FBPropertyListObject  )
pyfbsdk.__FB_FORWARD ( FBEvent  )
pyfbsdk.__FB_FORWARD ( FBEventConnectionNotify  )
pyfbsdk.__FB_FORWARD ( FBEventConnectionDataNotify  )
pyfbsdk.__FB_FORWARD ( FBEventConnectionStateNotify  )
pyfbsdk.__FB_FORWARD ( FBCustomManager  )
pyfbsdk.FB_DEFINE_ENUM ( ConsoleChannelType  )
pyfbsdk.__FB_FORWARD ( FBConsoleChannel  )
pyfbsdk.FB_DEFINE_ARRAY ( ConsoleChannel  )
pyfbsdk.__FB_FORWARD ( FBConsole  )
FB_FORWARD ( FBFbxObject  )
pyfbsdk.K_INTERFACE ( IJLCooper  ,
100103033   
)
pyfbsdk.__FB_FORWARD ( FBJLCooper  )
pyfbsdk.FB_DEFINE_COMPONENT ( Constraint  )
pyfbsdk.FB_FORWARD ( FBConstraintInfo  )
pyfbsdk.__FB_FORWARD ( FBConstraint  )
__FB_FORWARD ( FBBox  )
pyfbsdk.__FB_FORWARD ( FBPropertyListBox  )
pyfbsdk.FB_DEFINE_LIST ( Box  )
pyfbsdk.FB_DEFINE_COMPONENT ( Box  )
pyfbsdk.__FB_FORWARD ( FBBoxPlaceHolder  )
pyfbsdk.__FB_FORWARD ( FBModelPlaceHolder  )
pyfbsdk.__FB_FORWARD ( FBConstraintRelation  )
pyfbsdk.FB_DEFINE_COMPONENT ( ConstraintSolver  )
pyfbsdk.__FB_FORWARD ( FBConstraintSolver  )
pyfbsdk.FB_FORWARD ( FBPropertyListConstraintSolver  )
pyfbsdk.FB_DEFINE_COMPONENT ( PhysicalProperties  )
pyfbsdk.__FB_FORWARD ( FBPhysicalProperties  )
pyfbsdk.FB_DEFINE_LIST ( PhysicalProperties  )
pyfbsdk.FB_FORWARD ( FBPropertyListPhysicalProperties  )
pyfbsdk.__FB_FORWARD ( FBConstraintManager  )
pyfbsdk.__FB_FORWARD ( FBConstraintLayout  )
pyfbsdk.K_FORWARD ( IKtLayoutRegion  )
K_FORWARD ( IKtObject  )
pyfbsdk.FB_DEFINE_COMPONENT ( Layout  )
pyfbsdk.FB_DEFINE_COMPONENT ( VisualComponent  )
pyfbsdk.FB_DEFINE_COMPONENT ( View  )
pyfbsdk.FB_DEFINE_COMPONENT ( TreeNode  )
pyfbsdk.FB_DEFINE_ENUM ( Orientation  )
pyfbsdk.FB_DEFINE_ENUM ( InputType  )
pyfbsdk.FB_DEFINE_ENUM ( InputModifier  )
pyfbsdk.FB_DEFINE_ENUM ( InputKey  )
pyfbsdk.__FB_FORWARD ( FBLayout  )
pyfbsdk.FB_FORWARD ( FBStringList  )
pyfbsdk.FB_DEFINE_COMPONENT ( FBVisualComponent  )
pyfbsdk.FB_DEFINE_ENUM ( AttachType  )
pyfbsdk.FB_DEFINE_ENUM ( BorderStyle  )
pyfbsdk.__FB_FORWARD ( FBEventInput  )
pyfbsdk.__FB_FORWARD ( FBEventTransaction  )
pyfbsdk.__FB_FORWARD ( FBEventDragAndDrop  )
pyfbsdk.FB_DEFINE_ENUM ( DragAndDropState  )
pyfbsdk.__FB_FORWARD ( FBEventShow  )
pyfbsdk.__FB_FORWARD ( FBEventActivate  )
pyfbsdk.__FB_FORWARD ( FBEventExpose  )
pyfbsdk.__FB_FORWARD ( FBEventResize  )
pyfbsdk.__FB_FORWARD ( FBEventMenu  )
pyfbsdk.__FB_FORWARD ( FBMenuItem  )
pyfbsdk.FB_DEFINE_ENUM ( MenuItemType  )
pyfbsdk.__FB_FORWARD ( FBTabPanel  )
pyfbsdk.__FB_FORWARD ( FBButton  )
pyfbsdk.FB_DEFINE_ENUM ( ButtonStyle  )
pyfbsdk.FB_DEFINE_ENUM ( TextJustify  )
pyfbsdk.FB_DEFINE_ENUM ( TextStyle  )
pyfbsdk.FB_DEFINE_ENUM ( ButtonLook  )
pyfbsdk.__FB_FORWARD ( FBArrowButton  )
pyfbsdk.__FB_FORWARD ( FBScrollBox  )
pyfbsdk.__FB_FORWARD ( FBLabel  )
pyfbsdk.__FB_FORWARD ( FBImageContainer  )
pyfbsdk.__FB_FORWARD ( FBEdit  )
pyfbsdk.__FB_FORWARD ( FBEditNumber  )
pyfbsdk.__FB_FORWARD ( FBEditColor  )
pyfbsdk.__FB_FORWARD ( FBEditVector  )
pyfbsdk.__FB_FORWARD ( FBEventDblClick  )
pyfbsdk.__FB_FORWARD ( FBList  )
pyfbsdk.FB_DEFINE_ENUM ( ListStyle  )
pyfbsdk.__FB_FORWARD ( FBSlider  )
pyfbsdk.__FB_FORWARD ( FBLayoutRegion  )
pyfbsdk.__FB_FORWARD ( FBThermometer  )
pyfbsdk.__FB_FORWARD ( FBSpread  )
pyfbsdk.FB_DEFINE_ENUM ( CellStyle  )
pyfbsdk.__FB_FORWARD ( FBSpreadPart  )
pyfbsdk.__FB_FORWARD ( FBSpreadCell  )
pyfbsdk.__FB_FORWARD ( FBSpreadRow  )
pyfbsdk.__FB_FORWARD ( FBSpreadColumn  )
pyfbsdk.__FB_FORWARD ( FBEventSpread  )
pyfbsdk.__FB_FORWARD ( FBContainer  )
pyfbsdk.FB_DEFINE_ENUM ( IconPosition  )
pyfbsdk.__FB_FORWARD ( FBEditTimeCode  )
pyfbsdk.__FB_FORWARD ( FBTreeNode  )
pyfbsdk.__FB_FORWARD ( FBTree  )
pyfbsdk.__FB_FORWARD ( FBEventTree  )
pyfbsdk.FB_DEFINE_ENUM ( EventTreeWhy  )
pyfbsdk.__FB_FORWARD ( FBEventTreeSelect  )
pyfbsdk.__FB_FORWARD ( FBView  )
pyfbsdk.__FB_FORWARD ( FBProgress  )
pyfbsdk.__FB_FORWARD ( FBPopup  )
pyfbsdk.__FB_FORWARD ( FBFilePopup  )
pyfbsdk.FB_DEFINE_ENUM ( FilePopupStyle  )
pyfbsdk.__FB_FORWARD ( FBFolderPopup  )
int pyfbsdk.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.
Examples
UI/FBMessageBox.py, UI/FBMessageBoxGetUserValue.py, Tasks/AssignRigidBody.py, Tasks/BatchExportCharacterAnimationTool.py, Tasks/EnableGameModeOnSelectedCharacters_Z.py, BasicOperations/GetUserValue.py
int pyfbsdk.FBMessageBoxWithCheck ( str  pBoxTitle,
str  pMessage,
str  pButton1Str,
str  pButton2Str,
str  pButton3Str,
str  pCheckBoxStr,
bool  pCheckBoxValue,
int  pDefaultButton = 0,
int  pScrolledMessage = 0 
)

Dialog popup box with a check box.

Opens a message box containing a message, up to three buttons and a check box. 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).
pCheckBoxStr Check box string (Cannot be NULL).
Return values:
pCheckBoxValue Check box value.
Parameters:
pDefaultButton Indicates the default (pre-selected) button (default is 0).
pScrolledMessage Scroll message (default is 0).
Returns:
The number of the button selected.
int pyfbsdk.FBMessageBoxGetUserValue ( str  pBoxTitle,
str  pMessage,
pValue  ,
FBPopupInputType  pValueType,
str  pButton1Str,
str  pButton2Str = None,
str  pButton3Str = None,
int  pDefaultButton = 0,
bool  pLastButtonCancel = True 
)

Dialog popup box to get user input.

Opens a message box, with up to three buttons, asking the user to enter data. The type of data to be entered is specified by the pValue and pValueType parameters.

Parameters:
pBoxTitle Title of message box.
pMessage Message to place in box.
Return values:
pValue Value entered by user (must correspond with pValueType).
Parameters:
pValueType Type of pointer specified in pValue.
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=0).
pLastButtonCancel Indicates the last button is Cancel (if more than one button) so pValue won't be updated if the last button is clicked.
Returns:
The number of the button selected.
Examples
UI/FBMessageBoxGetUserValue.py, Tasks/RemoveSuffixFromNameOfSceneElements.py, BasicOperations/GetUserValue.py
pyfbsdk.__FB_FORWARD ( FBMemo  )
pyfbsdk.__FB_FORWARD ( FBFCurveEditor  )
pyfbsdk.__FB_FORWARD ( FBPropertyConnectionEditor  )
pyfbsdk.__FB_FORWARD ( FBEditProperty  )
pyfbsdk.__FB_FORWARD ( FBEditPropertyModern  )
pyfbsdk.__FB_FORWARD ( FBBrowsingProperty  )
pyfbsdk.__FB_FORWARD ( FBWidgetHolder  )
pyfbsdk.__FB_FORWARD ( FBPlotPopup  )
pyfbsdk.FB_DEFINE_COMPONENT ( ModelTemplate  )
pyfbsdk.FB_DEFINE_COMPONENT ( Device  )
pyfbsdk.FB_DEFINE_COMPONENT ( Path3D  )
FB_DEFINE_COMPONENT ( Scene  )
FB_DEFINE_COMPONENT ( Model  )
pyfbsdk.__FB_FORWARD ( FBHandle  )
pyfbsdk.FB_DEFINE_LIST ( Handle  )
pyfbsdk.FB_FORWARD ( FBPropertyListHandle  )
pyfbsdk.__FB_FORWARD ( FBModelTemplate  )
pyfbsdk.__FB_FORWARD ( FBPropertyListModelTemplate  )
pyfbsdk.FB_DEFINE_LIST ( ModelTemplate  )
pyfbsdk.__FB_FORWARD ( FBModelTemplateBinding  )
pyfbsdk.__FB_FORWARD ( FBPropertyListModelTemplateBinding  )
pyfbsdk.__FB_FORWARD ( FBDevice  )
pyfbsdk.__FB_FORWARD ( FBPropertyListDevice  )
pyfbsdk.FB_FORWARD ( FBDeviceNotifyInfo  )
pyfbsdk.__FB_FORWARD ( FBDeviceInstrument  )
pyfbsdk.FB_DEFINE_COMPONENT ( DeviceInstrument  )
pyfbsdk.__FB_FORWARD ( FBPropertyListDeviceInstrument  )
pyfbsdk.FB_DEFINE_LIST ( DeviceInstrument  )
pyfbsdk.FB_DEFINE_ENUM ( DeviceSamplingMode  )
pyfbsdk.__FB_FORWARD ( FBDeviceGlove  )
pyfbsdk.K_FORWARD ( IConnector  )
pyfbsdk.K_FORWARD ( KFCurve  )
FB_FORWARD ( FBEvaluateInfo  )
pyfbsdk.FB_DEFINE_ENUM ( Interpolation  )
pyfbsdk.FB_DEFINE_ENUM ( TangentMode  )
pyfbsdk.FB_DEFINE_ENUM ( TangentClampMode  )
pyfbsdk.FB_DEFINE_ENUM ( TangentConstantMode  )
pyfbsdk.FB_FORWARD ( FBFCurve  )
pyfbsdk.__FB_FORWARD ( FBFCurveKey  )
pyfbsdk.FB_FORWARD ( FBPropertyListFCurveKey  )
pyfbsdk.FB_FORWARD ( FBFCurveKey  )
pyfbsdk.__FB_FORWARD ( FBFCurve  )
pyfbsdk.FB_DEFINE_COMPONENT ( FCurve  )
pyfbsdk.__FB_FORWARD ( FBAnimationNode  )
pyfbsdk.__FB_FORWARD ( FBPropertyListAnimationNode  )
pyfbsdk.FB_DEFINE_LIST ( AnimationNode  )
FB_DEFINE_COMPONENT ( AnimationNode  )

Animation node class.

pyfbsdk.FB_DEFINE_ENUM ( EventAnimationNodeType  )
pyfbsdk.__FB_FORWARD ( FBEventAnimationNode  )
pyfbsdk.FB_DEFINE_ENUM ( LayerMode  )
pyfbsdk.FB_DEFINE_ENUM ( LayerRotationMode  )
pyfbsdk.__FB_FORWARD ( FBAnimationLayer  )
pyfbsdk.__FB_FORWARD ( FBTake  )
FB_DEFINE_COMPONENT ( Take  )
pyfbsdk.__FB_FORWARD ( FBTimeWarpManager  )
pyfbsdk.__FB_FORWARD ( FBDeck  )
pyfbsdk.FB_DEFINE_ENUM ( DeckTransportMode  )
pyfbsdk.FB_DEFINE_COMPONENT ( Deck  )
pyfbsdk.__FB_FORWARD ( FBDeckLayout  )
pyfbsdk.FB_FORWARD ( FBDeviceCameraInstrument  )
pyfbsdk.FB_FORWARD ( FBDeviceCamera  )
pyfbsdk.FB_FORWARD ( FBDeviceOptical  )
pyfbsdk.__FB_FORWARD ( FBDeviceLayout  )
pyfbsdk.__FB_FORWARD ( FBDeviceOpticalLayout  )
pyfbsdk.__FB_FORWARD ( FBDeviceCameraLayout  )
HFBEvaluateInfo pyfbsdk.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.
pyfbsdk.FB_FORWARD ( FBScene  )
FB_FORWARD ( FBCharacter  )
pyfbsdk.__FB_FORWARD ( FBFbxObject  )
__FB_FORWARD ( FBModel  )
pyfbsdk.FB_DEFINE_ENUM ( ElementAction  )
pyfbsdk.FB_DEFINE_ENUM ( TakeSpanOnLoad  )
pyfbsdk.FB_DEFINE_ENUM ( CharacterLoadAnimationMethod  )
pyfbsdk.FB_DEFINE_ENUM ( FileFormatAndVersion  )
pyfbsdk.__FB_FORWARD ( FBFbxOptions  )
pyfbsdk.__FB_FORWARD ( FBFilter  )
pyfbsdk.__FB_FORWARD ( FBPropertyListFilter  )
pyfbsdk.FB_DEFINE_COMPONENT ( Filter  )
pyfbsdk.FB_DEFINE_COMPONENT ( FilterLayout  )
pyfbsdk.FB_FORWARD ( FBFilterManager  )
pyfbsdk.FB_FORWARD ( FBFilter  )
pyfbsdk.__FB_FORWARD ( FBFolder  )
pyfbsdk.__FB_FORWARD ( FBGenericMenuItem  )
pyfbsdk.__FB_FORWARD ( FBGenericMenu  )
pyfbsdk.__FB_FORWARD ( FBMenuManager  )
pyfbsdk.FB_DEFINE_COMPONENT ( GenericMenuItem  )
pyfbsdk.FB_DEFINE_COMPONENT ( GenericMenu  )
pyfbsdk.FB_DEFINE_COMPONENT ( MenuManager  )
pyfbsdk.__FB_FORWARD ( FBGroup  )
pyfbsdk.__FB_FORWARD ( FBSet  )
pyfbsdk.FB_DEFINE_COMPONENT ( Group  )
pyfbsdk.FB_DEFINE_COMPONENT ( Set  )
pyfbsdk.FB_FORWARD ( FBPropertyListGroup  )
pyfbsdk.FB_FORWARD ( FBPropertyListSet  )
pyfbsdk.__FB_FORWARD ( FBImage  )
pyfbsdk.FB_DEFINE_COMPONENT ( Image  )
pyfbsdk.FB_DEFINE_ENUM ( ImageFormat  )
pyfbsdk.FB_DEFINE_ENUM ( ImageType  )
pyfbsdk.FB_DEFINE_ENUM ( ImageInterleaveType  )
pyfbsdk.FB_DEFINE_ENUM ( ImageInterpolationType  )
pyfbsdk.FB_DEFINE_ENUM ( Parity  )
pyfbsdk.FB_DEFINE_ENUM ( RSType  )
pyfbsdk.FB_DEFINE_ENUM ( CommPortType  )
pyfbsdk.FB_DEFINE_COMPONENT ( CommPort  )
pyfbsdk.__FB_FORWARD ( FBCommPort  )
pyfbsdk.__FB_FORWARD ( FBPropertyListCommPort  )
pyfbsdk.__FB_FORWARD ( FBTCPIP  )
pyfbsdk.__FB_FORWARD ( FBKeyingGroup  )
pyfbsdk.FB_DEFINE_COMPONENT ( KeyingGroup  )
pyfbsdk.FB_DEFINE_LIST ( KeyingGroup  )
pyfbsdk.FB_DEFINE_COMPONENT ( Manipulator  )
FB_DEFINE_COMPONENT ( Camera  )
pyfbsdk.__FB_FORWARD ( FBManipulator  )
pyfbsdk.FB_DEFINE_LIST ( Manipulator  )
pyfbsdk.__FB_FORWARD ( FBManipulatorTransform  )
pyfbsdk.FB_DEFINE_COMPONENT ( ManipulatorTransform  )
pyfbsdk.FB_DEFINE_ENUM ( ManipulatorTransformType  )
pyfbsdk.__FB_FORWARD ( FBManipulatorLayout  )
pyfbsdk.FB_DEFINE_ENUM ( RotationOrder  )
pyfbsdk.FBMatrixInverse ( FBMatrix  pMatrix,
FBMatrix  pSrc 
)

Invert a matrix.

Return values:
pMatrix Calculated inverse matrix.
Parameters:
pSrc Source matrix to invert.
pyfbsdk.FBMatrixTranspose ( FBMatrix  pMatrix,
FBMatrix  pSrc 
)

Transpose a matrix.

Return values:
pMatrix Calculated transpose matrix.
Parameters:
pSrc Source matrix to transpose.
pyfbsdk.FBMatrixMult ( FBMatrix  pMatrix,
FBMatrix  pA,
FBMatrix  pB 
)

Multiply two matrices.

Return values:
pMatrix Calculated resulting matrix.
Parameters:
pA 1st matrix.
pB 2nd matrix.
pyfbsdk.FBVertexMatrixMult ( FBVector4  pOutVertex,
FBMatrix  pMatrix,
FBVector4  pVertex 
)

Multiply a vertex by a matrix.

Return values:
pOutVertex Resulting vertex.
Parameters:
pMatrix Matrix to affect the vertex with.
pVertex Source vertex.
pyfbsdk.FBVectorMatrixMult ( FBVector4  pOutVector,
FBMatrix  pMatrix,
FBVector4  pVector 
)

Multiply a vector by a matrix.

Return values:
pOutVector Resulting vector.
Parameters:
pMatrix Matrix to affect the vector with.
pVector Source vector.
pyfbsdk.FBTranslationToMatrix ( FBMatrix  pMatrix,
FBVector4  pVector 
)

Convert a translation vector to a matrix.

Return values:
pMatrix Calculated resulting matrix.
Parameters:
pVector Translation vector.
pyfbsdk.FBRotationToMatrix ( FBMatrix  pMatrix,
FBVector3  pVector,
FBRotationOrder  pRotationOrder = kFBXYZ 
)

Convert a rotation vector to a matrix.

Return values:
pMatrix Calculated resulting matrix.
Parameters:
pVector Rotation vector.
pRotationOrder Rotation order
pyfbsdk.FBScalingToMatrix ( FBMatrix  pMatrix,
FBSVector  pVector 
)

Convert a scaling vector to a matrix.

Return values:
pMatrix Calculated resulting matrix.
Parameters:
pVector Scaling vector.
pyfbsdk.FBTRSToMatrix ( FBMatrix  pMatrix,
FBVector4  pTVector,
FBVector3  pRVector,
FBSVector  pSVector 
)

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

Return values:
pMatrix Calculated resulting matrix.
Parameters:
pTVector Translation vector.
pRVector Rotation vector.
pSVector Scaling vector.
Warning:
Rotation is in EulerXYZ
pyfbsdk.FBMatrixToTranslation ( FBVector4  pVector,
FBMatrix  pMatrix 
)

Obtain translation vector from a matrix.

Return values:
pVector Extracted translation vector.
Parameters:
pMatrix Input matrix.
pyfbsdk.FBMatrixToRotation ( FBVector3  pVector,
FBMatrix  pMatrix,
FBRotationOrder  pRotationOrder = kFBXYZ 
)

Obtain rotation vector from a matrix.

Return values:
pVector Extracted rotation vector.
Parameters:
pMatrix Input matrix.
pRotationOrder Rotation Order.
Warning:
Rotation is in EulerXYZ or EulerZYX only
pyfbsdk.FBMatrixToScaling ( FBSVector  pVector,
FBMatrix  pMatrix 
)

Obtain scaling vector from a matrix.

Return values:
pVector Extracted scaling vector.
Parameters:
pMatrix Input matrix.
pyfbsdk.FBMatrixToTRS ( FBVector4  pTVector,
FBVector3  pRVector,
FBSVector  pSVector,
FBMatrix  pMatrix 
)

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

Return values:
pTVector Extracted translation vector.
pRVector Extracted rotation vector.
pSVector Extracted scaling vector.
Parameters:
pMatrix Input matrix.
Warning:
Rotation is in EulerXYZ
pyfbsdk.FBRotationToQuaternion ( FBVector4  pQuaternion,
FBVector3  pVector,
FBRotationOrder  pRotationOrder = kFBXYZ 
)

Get a quaternion from a rotation vector.

Return values:
pQuaternion Calculated quaternion.
Parameters:
pVector Input rotation vector.
pRotationOrder Rotation order of the rotation vector.
pyfbsdk.FBQuaternionToRotation ( FBVector3  pVector,
FBVector4  pQuaternion,
FBRotationOrder  pRotationOrder = kFBXYZ 
)

Get a rotation vector from a quaternion vector.

Return values:
pVector Calculated rotation vector.
Parameters:
pQuaternion Input quaternion.
pRotationOrder Rotation order of the rotation vector.
Warning:
Rotation is in EulerXYZ or kFBZYX only
pyfbsdk.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.

Return values:
pMatrix Calculated local matrix.
Parameters:
pMatrixParent Parent matrix (new base referential).
pMatrixChild Child matrix.
pyfbsdk.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).

Return values:
pMatrix Calculated local matrix.
Parameters:
pMatrixParent Parent matrix.
pLocalMatrix Local matrix.
pyfbsdk.FBMatrixOrthogonalize ( FBMatrix  pMatrix )

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

Return values:
pMatrix Orthogonalized matrix.
Parameters:
pMatrix Rotation Matrix to Orthogonalize.
pyfbsdk.FBAdd ( FBVector4  pResult,
FBVector4  pV1,
FBVector4  pV2 
)

Add two vectors together (pResult = pV1+pV2).

Return values:
pResult Resulting vector.
Parameters:
pV1 1st vector.
pV2 2nd vector.
pyfbsdk.FBSub ( FBVector4  pResult,
FBVector4  pV1,
FBVector4  pV2 
)

Subtract pV2 from pV1 (pResult = pV1-pV2).

Return values:
pResult Resulting vector.
Parameters:
pV1 1st vector.
pV2 2nd vector.
pyfbsdk.FBMult ( FBVector4  pResult,
FBVector4  pV1,
float  pV2 
)

Multiply pV2 from pV1 (pResult = pV1*pV2).

Return values:
pResult Resulting vector.
Parameters:
pV1 1st vector.
pV2 2nd vector.
pyfbsdk.FBMult ( FBVector4  pResult,
FBVector4  pV1,
FBVector4  pV2 
)

Calculate the cross product of two vectors.

Return values:
pResult Resulting vector.
Parameters:
pV1 1st vector.
pV2 2nd vector.
pyfbsdk.FBMult ( FBMatrix  pResult,
FBMatrix  pM,
FBSVector  pV 
)

Calculate the cross product of a Matrix and Scale Vector.

Return values:
pResult Resulting Matrix.
Parameters:
pM Matrix.
pV vector.
float pyfbsdk.FBDot ( FBVector4  pV1,
FBVector4  pV2 
)

Calculate the dot product of two vectors.

Parameters:
pV1 1st vector.
pV2 2nd vector.
Returns:
Dot product.
float FBLength ( FBVector4  pV )

Get the length of a vector.

Get the length of a vertex (from origin).

Parameters:
pV Vector to calculate length for.
Returns:
Length of vector pV.
Parameters:
pV Vertex for which length is to be measured.
Returns:
Length of vertex (from origin).
pyfbsdk.FBQAdd ( FBVector4  pResult,
FBVector4  pQ1,
FBVector4  pQ2 
)

Add two quaternions together (pResult = pQ1+pQ2).

Return values:
pResult Resulting quaternion.
Parameters:
pQ1 1st quaternion.
pQ2 2nd quaternion.
pyfbsdk.FBQSub ( FBVector4  pResult,
FBVector4  pQ1,
FBVector4  pQ2 
)

Subtract pQ2 from pQ1 (pResult = pQ1-pQ2).

Return values:
pResult Resulting quaternion.
Parameters:
pQ1 1st quaternion.
pQ2 2nd quaternion.
pyfbsdk.FBQMult ( FBVector4  pResult,
FBVector4  pQ1,
float  pQ2 
)

Multiply pQ2 from pQ1 (pResult = pQ1*pQ2).

Return values:
pResult Resulting quaternion.
Parameters:
pQ1 1st quaternion.
pQ2 2nd quaternion.
pyfbsdk.FBQMult ( FBVector4  pResult,
FBVector4  pQ1,
FBVector4  pQ2 
)

Calculate the cross product of two quaternions.

Return values:
pResult Resulting quaternion.
Parameters:
pQ1 1st quaternion.
pQ2 2nd quaternion.
float pyfbsdk.FBQDot ( FBVector4  pQ1,
FBVector4  pQ2 
)

Calculate the dot product of two quaternions.

Parameters:
pQ1 1st quaternion.
pQ2 2nd quaternion.
Returns:
Dot product.
float pyfbsdk.FBQLength ( FBVector4  pQ )

Get the length of a quaternion.

Parameters:
pQ Quaternion to calculate length for.
Returns:
Length of quaternion pQ.
pyfbsdk.FBInterpolateRotation ( FBVector3  pROut,
FBVector3  pR0,
FBVector3  pR1,
float  pU 
)

Interpolate a rotation in Euler space.

Return values:
pROut Resulting, interpolated rotation.
Parameters:
pR0 1st rotation.
pR1 2nd rotation.
pU Interpolation ratio.
pyfbsdk.FBInterpolateRotation ( FBVector4  pQOut,
FBVector4  pQ0,
FBVector4  pQ1,
float  pU 
)

Interpolate a rotation in Quaternion.

Return values:
pQOut Resulting, interpolated rotation.
Parameters:
pQ0 1st rotation.
pQ1 2nd rotation.
pU Interpolation ratio.
pyfbsdk.FBGetContinuousRotation ( FBVector3  pROut,
FBVector3  pR0,
FBVector3  pR1 
)

Get a continuous rotation in Euler space.

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

Return values:
pROut Successful continuous rotation (gimble-lock free).
Parameters:
pR0 Suggested next rotation.
pR1 Previous rotation.
float pyfbsdk.FBClamp ( float  pV,
float  pL,
float  pH 
)

Clamp value.

Parameters:
pV Value to clamp.
pL Low limit.
pH High limit.
Returns:
Clamped value.
pyfbsdk.FBBigEndianToNative ( int  pV )

Change from big endian to native format.

Parameters:
pV Value to modify.
pyfbsdk.FBLittleEndianToNative ( int  pV )

Change from little endian to native format.

Parameters:
pV Value to modify.
pyfbsdk.FB_DEFINE_COMPONENT ( CameraStereo  )
pyfbsdk.FB_DEFINE_COMPONENT ( Light  )
pyfbsdk.FB_DEFINE_COMPONENT ( Cluster  )
pyfbsdk.FB_DEFINE_COMPONENT ( Geometry  )
pyfbsdk.FB_DEFINE_COMPONENT ( Mesh  )
pyfbsdk.FB_DEFINE_COMPONENT ( ModelVertexData  )
FB_DEFINE_COMPONENT ( Video  )
pyfbsdk.FB_DEFINE_COMPONENT ( PointCacheFile  )
pyfbsdk.FBModelTransactionBegin ( )

FBModelTransactionBegin.

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

pyfbsdk.FBModelTransactionEnd ( )

FBModelTransactionEnd.

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

pyfbsdk.__FB_FORWARD ( FBPropertyListModel  )
pyfbsdk.FB_DEFINE_LIST ( Model  )
pyfbsdk.__FB_FORWARD ( FBMaterial  )

PropertyList: Material.

pyfbsdk.__FB_FORWARD ( FBTexture  )

PropertyList: Texture.

pyfbsdk.__FB_FORWARD ( FBDeformer  )

PropertyList: Texture.

pyfbsdk.FB_DEFINE_ENUM ( ModelShadingMode  )
pyfbsdk.FB_DEFINE_ENUM ( ModelTransformationMatrix  )
pyfbsdk.FB_DEFINE_ENUM ( ModelRotationOrder  )
pyfbsdk.__FB_FORWARD ( FBModelNull  )
pyfbsdk.__FB_FORWARD ( FBModelRoot  )
pyfbsdk.__FB_FORWARD ( FBModelMarker  )
pyfbsdk.FB_DEFINE_ENUM ( MarkerResolutionLevel  )
pyfbsdk.FB_DEFINE_ENUM ( MarkerLook  )
pyfbsdk.FB_DEFINE_ENUM ( MarkerType  )
pyfbsdk.__FB_FORWARD ( FBModelSkeleton  )
pyfbsdk.__FB_FORWARD ( FBModelCube  )
pyfbsdk.__FB_FORWARD ( FBModelPlane  )
pyfbsdk.__FB_FORWARD ( FBModelPath3D  )
pyfbsdk.FB_DEFINE_ENUM ( PathTangeantMode  )
pyfbsdk.FB_DEFINE_ENUM ( TextureUseType  )
pyfbsdk.FB_DEFINE_ENUM ( TextureMapping  )
pyfbsdk.FB_DEFINE_ENUM ( TextureBlendMode  )
pyfbsdk.__FB_FORWARD ( FBLayeredTexture  )
pyfbsdk.FB_DEFINE_ENUM ( ClusterMode  )
pyfbsdk.__FB_FORWARD ( FBCluster  )
pyfbsdk.__FB_FORWARD ( FBCamera  )
pyfbsdk.FB_DEFINE_ENUM ( CameraType  )
pyfbsdk.FB_DEFINE_ENUM ( CameraApertureMode  )
pyfbsdk.FB_DEFINE_ENUM ( CameraFilmBackType  )
pyfbsdk.FB_DEFINE_ENUM ( CameraFrameSizeMode  )
pyfbsdk.FB_DEFINE_ENUM ( CameraResolutionMode  )
pyfbsdk.FB_DEFINE_ENUM ( CameraViewPlaneMode  )
pyfbsdk.FB_DEFINE_ENUM ( CameraDistanceMode  )
pyfbsdk.FB_DEFINE_ENUM ( CameraSafeAreaMode  )
pyfbsdk.FB_DEFINE_ENUM ( CameraAntiAliasingMethod  )
pyfbsdk.FB_DEFINE_ENUM ( CameraSamplingType  )
pyfbsdk.FB_DEFINE_ENUM ( CameraFocusDistanceSource  )
pyfbsdk.FB_DEFINE_ENUM ( CameraMatrixType  )
pyfbsdk.__FB_FORWARD ( FBCameraStereo  )
pyfbsdk.FB_DEFINE_ENUM ( CameraStereoType  )
pyfbsdk.__FB_FORWARD ( FBCameraSwitcher  )
pyfbsdk.__FB_FORWARD ( FBGlobalLight  )
pyfbsdk.FB_DEFINE_ENUM ( FogMode  )
pyfbsdk.__FB_FORWARD ( FBLight  )
pyfbsdk.FB_DEFINE_ENUM ( LightType  )
pyfbsdk.FB_DEFINE_ENUM ( AttenuationType  )
pyfbsdk.__FB_FORWARD ( FBModelVertexData  )
pyfbsdk.__FB_FORWARD ( FBGeometry  )
pyfbsdk.FB_DEFINE_ENUM ( GeometryMappingMode  )
pyfbsdk.FB_DEFINE_ENUM ( GeometryReferenceMode  )
pyfbsdk.__FB_FORWARD ( FBMesh  )
pyfbsdk.__FB_FORWARD ( FBSurface  )
pyfbsdk.FB_DEFINE_ENUM ( SurfaceMode  )
pyfbsdk.FB_DEFINE_ENUM ( SurfaceType  )
pyfbsdk.FB_DEFINE_ENUM ( NurbType  )
pyfbsdk.__FB_FORWARD ( FBNurbs  )
pyfbsdk.__FB_FORWARD ( FBPatch  )
pyfbsdk.FB_DEFINE_ENUM ( DeformerType  )
pyfbsdk.__FB_FORWARD ( FBDeformerPointCache  )
pyfbsdk.__FB_FORWARD ( FBPointCacheFile  )
__FB_FORWARD ( FBMotionClip  )
FB_DEFINE_COMPONENT ( MotionClip  )
FB_FORWARD ( FBPlug  )
str pyfbsdk.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.

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.

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.
    HFBCamera lCamera = FBSystem().Cameras[0];

    // We know that cameras have a property named 'LockMode'.
    HFBProperty 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()));
    
        HFBProperty 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()));
        }
    }
str pyfbsdk.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.

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.

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" ));
pyfbsdk.FB_FORWARD ( FBMultiLangManager  )
pyfbsdk.__FB_FORWARD ( FBNote  )
pyfbsdk.FB_DEFINE_COMPONENT ( Note  )
pyfbsdk.FB_DEFINE_LIST ( Note  )
pyfbsdk.FB_FORWARD ( FBObjectPoseOptions  )
pyfbsdk.FB_FORWARD ( FBObjectPoseMirrorOptions  )
pyfbsdk.__FB_FORWARD ( FBObjectPose  )
pyfbsdk.GetPlaneEquation ( FBVector4  pPlaneEquation,
FBVector4  pPlaneNormalVector,
FBVector4  pPointOnPlane 
)

Get a plane equation from a normal vector and a point on the plane.

Parameters:
pPlaneEquation Out: The plane equation computed.
pPlaneNormalVector Normal vector to the plane.
pPointOnPlane A point on the plane.
pyfbsdk.GetPlaneEquation ( FBVector4  pPlaneEquation,
FBVector4  pPointOnPlane,
FBMatrix  pPlaneRM 
)

Get a plane equation from a point on the plane and a rotation matrix relative to the plane XZ.

Parameters:
pPlaneEquation Out: The plane equation computed.
pPointOnPlane A point on the plane.
pPlaneRM Rotation matrix of the plane, identity being the plane XZ.
pyfbsdk.GetPlaneRotation ( FBMatrix  pPlaneRM,
FBVector4  pPlaneEquation 
)

Get the plane rotation matrix from a plane equation.

Parameters:
pPlaneRM Out: Rotation matrix of the plane, identity being the plane XZ.
pPlaneEquation The equation of the plane.
pyfbsdk.NormalizePlaneEquation ( FBVector4  pNormalizedPlaneEquation,
FBVector4  pPlaneEquation 
)

Normalize a plane equation.

Parameters:
pNormalizedPlaneEquation Out: Plane equation normalized.
pPlaneEquation Plane equation to normalized.
pyfbsdk.MirrorTransform ( FBVector4  pMirrorT,
FBMatrix  pMirrorRM,
FBMatrix  pMirrorSM,
FBVector4  pT,
FBMatrix  pRM,
FBMatrix  pSM,
FBVector4  pPlaneEquation 
)

Mirror a transformation using the specified mirror plane.

Parameters:
pMirrorT Out: Mirrored translation.
pMirrorRM Out: Mirrored rotation.
pMirrorSM Out: Mirrored scaling.
pT Translation to mirror.
pRM Rotation to mirror.
pSM Scaling to mirror.
pPlaneEquation The equation of the mirror plane.
pyfbsdk.MirrorTransformT ( FBVector4  pMirrorT,
FBVector4  pT,
FBVector4  pPlaneEquation 
)

Mirror a translation using the specified mirror plane.

Parameters:
pMirrorT Out: Mirrored translation.
pT Translation to mirror.
pPlaneEquation The equation of the mirror plane.
pyfbsdk.MirrorTransformR ( FBMatrix  pMirrorRM,
FBMatrix  pRM,
FBVector4  pPlaneEquation 
)

Mirror a rotation using the specified mirror plane.

Parameters:
pMirrorRM Out: Mirrored rotation.
pRM Rotation to mirror.
pPlaneEquation The equation of the mirror plane.
pyfbsdk.__FB_FORWARD ( FBModelOptical  )
pyfbsdk.FB_DEFINE_COMPONENT ( ModelOptical  )
pyfbsdk.FB_DEFINE_COMPONENT ( ModelMarkerOptical  )
pyfbsdk.FB_DEFINE_COMPONENT ( RigidBody  )
pyfbsdk.__FB_FORWARD ( FBOpticalSegment  )
pyfbsdk.FB_DEFINE_COMPONENT ( OpticalSegment  )
pyfbsdk.FB_DEFINE_ARRAY ( OpticalSegment  )
pyfbsdk.FB_DEFINE_LIST ( OpticalSegment  )
pyfbsdk.FB_FORWARD ( FBPropertyListMarkerSegment  )
pyfbsdk.FB_FORWARD ( FBPropertyListOpticalSegment  )
pyfbsdk.FB_DEFINE_ENUM ( GapMode  )
pyfbsdk.__FB_FORWARD ( FBOpticalGap  )
pyfbsdk.FB_DEFINE_COMPONENT ( OpticalGap  )
pyfbsdk.FB_DEFINE_ARRAY ( OpticalGap  )
pyfbsdk.FB_DEFINE_LIST ( OpticalGap  )
pyfbsdk.FB_FORWARD ( FBPropertyListOpticalGap  )
pyfbsdk.__FB_FORWARD ( FBModelMarkerOptical  )
pyfbsdk.FB_DEFINE_ARRAY ( ModelMarkerOptical  )
pyfbsdk.FB_DEFINE_LIST ( ModelMarkerOptical  )
pyfbsdk.FB_FORWARD ( FBPropertyListModelMarkerOptical  )
pyfbsdk.FB_FORWARD ( FBPropertyListRigidBodyMarkers  )
pyfbsdk.FB_DEFINE_ENUM ( RigidBodyMode  )
pyfbsdk.__FB_FORWARD ( FBRigidBody  )
pyfbsdk.FB_DEFINE_ARRAY ( RigidBody  )
pyfbsdk.FB_DEFINE_LIST ( RigidBody  )
pyfbsdk.FB_FORWARD ( FBPropertyListRigidBody  )
pyfbsdk.FB_DEFINE_ENUM ( GenerationMode  )
pyfbsdk.FB_DEFINE_ENUM ( ControllerMode  )
pyfbsdk.FB_DEFINE_ENUM ( SegmentMode  )
pyfbsdk.FB_DEFINE_ENUM ( InsertSegmentMode  )
pyfbsdk.__FB_FORWARD ( FBModelOpticalAdvanced  )
pyfbsdk.__FB_FORWARD ( FBDeviceOpticalMarker  )
pyfbsdk.FB_DEFINE_ARRAY ( DeviceOpticalMarker  )
pyfbsdk.FB_DEFINE_LIST ( DeviceOpticalMarker  )
pyfbsdk.FB_FORWARD ( FBPropertyListDeviceOpticalMarker  )
pyfbsdk.__FB_FORWARD ( FBDeviceOptical  )
bool FBConnect ( FBPlug  pSrc,
FBPlug  pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
)

Request the connection two FBPlug objects.

Parameters:
pSrc Source plug.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This global function is used primarily to connect connectors in a FBConstraintRelation.
Examples
Tasks/CreateAndPopulateAConstraintRelation.py
Parameters:
pSrc Source plug.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This global function is used primarily to connect connectors in a FBConstraintRelation.
bool FBDisconnect ( FBPlug  pSrc,
FBPlug  pDst 
)

Connect two FBPlug objects.

Parameters:
pSrc Source plug.
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This global function is used primarily to disconnect connectors in a FBConstraintRelation.
pyfbsdk.FB_DEFINE_COMPONENT ( Pose  )
pyfbsdk.__FB_FORWARD ( FBPose  )
pyfbsdk.FB_DEFINE_ENUM ( PoseType  )
pyfbsdk.__FB_FORWARD ( FBPropertyListPose  )
pyfbsdk.__FB_FORWARD ( FBProfiler  )

Forwarding of class and type declaration.

pyfbsdk.FB_FORWARD ( FBProfileTaskCycle  )
pyfbsdk.__FB_FORWARD ( FBProfileTimeEvent  )
pyfbsdk.FB_FORWARD ( FBProfilerHelper  )
pyfbsdk.FB_DEFINE_ENUM ( ProfilingMode  )
HFBProfileTaskCycle pyfbsdk.FBGetMainThreadTaskCycle ( )

Get root task cycle.

HFBProfileTaskCycle pyfbsdk.FBGetRenderingTaskCycle ( )

Get rendering task cycle.

HFBProfileTaskCycle pyfbsdk.FBGetEvaluationTaskCycle ( )

Get evaluation task cycle.

pyfbsdk.K_FORWARD ( KObject  )
pyfbsdk.K_FORWARD ( KProperty  )
pyfbsdk.K_FORWARD ( KEvaluationProperty  )
pyfbsdk.K_FORWARD ( KDataType  )
pyfbsdk.K_FORWARD ( IFBObject  )
pyfbsdk.FB_FORWARD ( FBComponent  )
pyfbsdk.__FB_FORWARD ( FBProperty  )
pyfbsdk.__FB_FORWARD ( FBPropertyAnimatable  )
pyfbsdk.FB_FORWARD ( FBBox  )
pyfbsdk.FB_FORWARD ( FBAnimationNode  )
pyfbsdk.FB_FORWARD ( FBTake  )
pyfbsdk.__FB_FORWARD ( FBPropertyEvent  )
pyfbsdk.FB_FORWARD ( FBPropertyStringList  )
pyfbsdk.__FB_FORWARD ( FBPropertyManager  )
pyfbsdk.__FB_FORWARD ( FBRenderer  )
pyfbsdk.FB_FORWARD ( FBView  )
FB_DEFINE_COMPONENT ( Renderer  )
pyfbsdk.FB_FORWARD ( FBViewingOptions  )
pyfbsdk.FB_DEFINE_ENUM ( DeviceKeyboardKey  )
bool pyfbsdk.operator== ( FBPickInfos  pLhs,
FBPickInfos  pRhs 
)
pyfbsdk.__FB_FORWARD ( FBViewerInfos  )
pyfbsdk.FB_DEFINE_COMPONENT ( ViewerInfos  )
pyfbsdk.FB_DEFINE_ENUM ( SceneChangeType  )
pyfbsdk.__FB_FORWARD ( FBEventSceneChange  )
pyfbsdk.FB_DEFINE_ENUM ( TakeChangeType  )
pyfbsdk.__FB_FORWARD ( FBEventTakeChange  )
pyfbsdk.FB_FORWARD ( FBPropertyListScene  )
pyfbsdk.__FB_FORWARD ( FBScene  )
pyfbsdk.FB_DEFINE_LIST ( Scene  )
pyfbsdk.FB_FORWARD ( FBScriptWrapper  )
pyfbsdk.FB_FORWARD ( FBWrapperHolder  )
pyfbsdk.K_FORWARD ( KRenderOptions  )
pyfbsdk.K_FORWARD ( KModelRenderInfo  )
pyfbsdk.K_FORWARD ( IGraphicPrimitives  )
pyfbsdk.FB_FORWARD ( FBShaderManager  )
pyfbsdk.FB_FORWARD ( FBShader  )
pyfbsdk.FB_FORWARD ( FBShaderModelInfo  )
pyfbsdk.FB_FORWARD ( FBRenderOptions  )
pyfbsdk.FB_DEFINE_ENUM ( RenderingPass  )
pyfbsdk.FB_FORWARD ( FBRenderer  )
pyfbsdk.__FB_FORWARD ( FBShader  )
pyfbsdk.FB_DEFINE_COMPONENT ( Shader  )
pyfbsdk.FB_DEFINE_LIST ( Shader  )
pyfbsdk.FB_FORWARD ( FBShaderLighted  )
pyfbsdk.FB_DEFINE_COMPONENT ( ShaderLighted  )
pyfbsdk.FB_FORWARD ( FBShaderShadowLive  )
pyfbsdk.FB_DEFINE_COMPONENT ( ShaderShadowLive  )
pyfbsdk.FB_DEFINE_ENUM ( ShadowType  )
pyfbsdk.FB_DEFINE_ENUM ( ShadowFrameType  )
pyfbsdk.__FB_FORWARD ( FBShaderLayout  )
pyfbsdk.FB_DEFINE_COMPONENT ( ShaderLayout  )
pyfbsdk.__FB_FORWARD ( FBStory  )
pyfbsdk.__FB_FORWARD ( FBStoryFolder  )
pyfbsdk.__FB_FORWARD ( FBStoryTrack  )
pyfbsdk.__FB_FORWARD ( FBStoryClip  )
pyfbsdk.FB_DEFINE_COMPONENT ( Story  )
pyfbsdk.FB_DEFINE_COMPONENT ( StoryFolder  )
pyfbsdk.FB_DEFINE_COMPONENT ( StoryTrack  )
pyfbsdk.FB_DEFINE_COMPONENT ( StoryClip  )
pyfbsdk.FB_DEFINE_ENUM ( StoryTrackType  )
pyfbsdk.FB_DEFINE_ENUM ( StoryTrackRefMode  )
pyfbsdk.FB_DEFINE_ENUM ( StoryClipShowGhostMode  )
pyfbsdk.FB_DEFINE_ENUM ( StoryClipSolveMode  )
pyfbsdk.FB_DEFINE_ENUM ( StoryClipCompMode  )
pyfbsdk.FB_FORWARD ( FBPropertyListStoryFolder  )
pyfbsdk.FB_FORWARD ( FBPropertyListStoryTrack  )
pyfbsdk.FB_FORWARD ( FBPropertyListStorySubTrack  )
pyfbsdk.FB_FORWARD ( FBPropertyListStoryClip  )
pyfbsdk.FB_FORWARD ( FBPropertyListStoryDetails  )
pyfbsdk.FB_FORWARD ( FBPropertyListPivot  )
pyfbsdk.K_FORWARD ( KStringList  )
str pyfbsdk.operator+ ( str  p1Str,
str  p2Str 
)
object pyfbsdk.FBGetFBObject ( object  pObject,
bool  pAutoCreate = False 
)

Get the SDK object from an Internal Object.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default = false)
Returns:
SDK object for pObject.
T pyfbsdk.FBCast ( object  pObject,
bool  pAutoCreate = False 
)

Cast the SDK object using it's IObject interface into the proper class.

Parameters:
pObject Object to get SDK object for.
pAutoCreate Create object if it doesn't exist? (default = false)
Returns:
SDK object for pObject.
pyfbsdk.__FB_FORWARD ( FBSystem  )
pyfbsdk.__FB_FORWARD ( FBTriggerManager  )
pyfbsdk.FB_FORWARD ( FBBatchOptions  )
pyfbsdk.FB_DEFINE_ENUM ( BatchProcessType  )
pyfbsdk.FB_DEFINE_ENUM ( BatchFileFormat  )
pyfbsdk.FB_DEFINE_ENUM ( BatchOnTakeExist  )
pyfbsdk.FB_DEFINE_ENUM ( BatchOnContainsBatchTakes  )
pyfbsdk.FB_DEFINE_ENUM ( RotationFilter  )
pyfbsdk.__FB_FORWARD ( FBApplication  )
pyfbsdk.__FB_FORWARD ( FBPlayerControl  )
pyfbsdk.FB_DEFINE_ENUM ( TransportMode  )
pyfbsdk.FB_DEFINE_ENUM ( TransportTimeFormat  )
pyfbsdk.FB_DEFINE_ENUM ( TransportPlaySpeed  )
pyfbsdk.FB_DEFINE_ENUM ( TransportSnapMode  )
pyfbsdk.FB_DEFINE_ENUM ( ParallelScheduleType  )
pyfbsdk.__FB_FORWARD ( FBEvaluateManager  )

Evaluate Manager.

Interface to scheudle the DAG (Directed Acyclic Graph) tasks to multi-core/CPU (or GPU) to accerlerate evaluate process.

pyfbsdk.__FB_FORWARD ( FBKeyControl  )
pyfbsdk.__FB_FORWARD ( FBPointCacheManager  )
pyfbsdk.FB_FORWARD ( FBCriticalSection  )
pyfbsdk.__FB_FORWARD ( FBReferenceTime  )
tuple pyfbsdk.FBCreateModelList ( )

Create a FBModelList object.

This is to get around memory management issues when mixing debug and release runtime libraties on Windows. By using the FBCreateModelList/FBDestroyModelList duo of functions, you ensure that the memory used in the array is allocated, reallocated and freed in the same memory pool.

pyfbsdk.FBDestroyModelList ( tuple  pModelList )

Delete a FBModelList object.

Parameters:
pModelList pointer to the object created with a call to FBCreateModelList().
tuple pyfbsdk.FBCreatePickInfosList ( )

Create a FBPickInfosList object.

This is to get around memory management issues when mixing debug and release runtime libraties on Windows. By using the FBCreatePickInfosList/FBDestroyPickInfosList duo of functions, you ensure that the memory used in the array is allocated, reallocated and freed in the same memory pool.

pyfbsdk.FBDestroyPickInfosList ( tuple  pPickInfosList )

Delete a FBPickInfosList object.

Parameters:
pPickInfosList pointer to the object created with a call to FBCreatePickInfosList().
tuple pyfbsdk.FBCreateComponentList ( )

Create a FBObjectList object.

This is to get around memory management issues when mixing debug and release runtime libraties on Windows. By using the FBCreateObjectList/FBDestroyObjectList duo of functions, you ensure that the memory used in the array is allocated, reallocated and freed in the same memory pool.

pyfbsdk.FBDestroyComponentList ( tuple  pObjectList )

Delete a FBObjectList object.

Parameters:
pObjectList pointer to the object created with a call to FBCreateObjectList().
pyfbsdk.FBSleep ( long  MilliSeconds )

Sleep function Puts system to sleep for specified time.

Parameters:
MilliSeconds Time to sleep for.
Examples
UI/FBProgress.py
FBModel pyfbsdk.FBFindModelByName ( str  pModelName,
FBModel  pParent = None 
)
Deprecated:
Use FBFindModelByLabelName instead.

Find a model in the hierarchy. Searches the scene for a model, based on the model's name. The wrong model may be returned if there is more than one model in the scene with the same object name but with different namespace.

Parameters:
pModelName Name of model to search for. Could be "FullName", "LabelName" or "ObjectName".
pParent Root model to search from (default=NULL(root)).
Returns:
A handle to the model with any one of the "FullName", "LabelName" or "ObjectName" matching the pModelName, returns NULL if no model was found by the search.
Examples
Tasks/3dsMaxBipedTemplate.py, Tasks/EnableGameModeOnSelectedCharacters_Z.py, Tasks/ExportAnimationLibrary.py, Samples/FCurve/CopyAnimation.py, BasicOperations/FBComponent.py
FBModel pyfbsdk.FBFindModelByLabelName ( str  pModelLabelName )

Find a model in the scene by its label name.

It is faster than FBFindModelByName. 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.
FBModel pyfbsdk.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.
pyfbsdk.FBFindModelsOfType ( tuple  pList,
int  pTypeInfo,
FBModel  pParent = None 
)

Find all models of a certain type in the scene.

Searches recursively from a root model for models of a certain type, and adds them to a list of models.

Return values:
pList List to add found models to.
Parameters:
pTypeInfo Model type to look for.
pParent Root model to look from (default=NULL(root)).
pyfbsdk.FBGetSelectedModels ( tuple  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.

Return values:
pList List to add found models to.
Parameters:
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
Examples
Samples/Utilities/FBGetSelectedModels.py
pyfbsdk.FBSelectObjectsByNamespace ( str  pNameSpaceName,
bool  pSelect,
bool  pSearchExclusive = True 
)

FBSelectObjectsByNamespace.

This function will select objects in the current scene according to the parameters you provide

Parameters:
pNameSpaceName Indicate the name to search for selection/deselection.
pSelect Indicate if we select or unselect the objects
pSearchExclusive "true" will select object that are exclusive to that namespace(pNameSpaceName), "false" will select object that could be part of that namespace as well as others namespace.
Examples
BasicOperations/DeletingObjectBasedOnNameSpace.py
pyfbsdk.FBFindObjectsByName ( str  pNamePattern,
tuple  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: *tr*mod*scene )
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
Examples
BasicOperations/FindObjectsWithWildcard.py
HFBComponent pyfbsdk.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.
pyfbsdk.FBFindObjectsByNamespace ( str  pNamePattern,
tuple  pList 
)

FBFindObjectsByNamespace.

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

Parameters:
pNamePattern Indicate the name pattern to search. This pattern can contain any amount of *. (ex: *tr*mod*scene )
pList List that contains the objects
Examples
BasicOperations/FindObjectsWithWildcard.py
pyfbsdk.FBBeginChangeAllModels ( )

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

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

pyfbsdk.FBEndChangeAllModels ( )

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

pyfbsdk.FBTrace ( str  pFormatString )

This function prints useful debugging strings in the console.

By passing the argument "-console" when launching MotionBuilder, it is possible to print formatted messages, as a printf would. On Mac OSX, the strings are simply sent to stderr.

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.
Examples
Tasks/ViewerInfosList.py
bool pyfbsdk.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.
pyfbsdk.FB_FORWARD ( FBTime  )
pyfbsdk.FB_FORWARD ( FBTimeCode  )
pyfbsdk.__FB_FORWARD ( FBTool  )
FBTimeMode pyfbsdk.FBGetSyncTimeMode ( )

Returns the time mode for the current system sync.

pyfbsdk.__FB_FORWARD ( FBDeviceSyncPacket  )
pyfbsdk.__FB_FORWARD ( FBDeviceSync  )
pyfbsdk.__FB_FORWARD ( FBDeviceCameraPacket  )
pyfbsdk.FB_DEFINE_COMPONENT ( DeviceCameraPacket  )
pyfbsdk.__FB_FORWARD ( FBDeviceCameraInstrument  )
pyfbsdk.__FB_FORWARD ( FBDeviceCamera  )
pyfbsdk.__FB_FORWARD ( FBTriggerGroup  )
pyfbsdk.__FB_FORWARD ( FBTrigger  )
pyfbsdk.__FB_FORWARD ( FBTriggerBranch  )
pyfbsdk.__FB_FORWARD ( FBPropertyListTriggerGroup  )
pyfbsdk.__FB_FORWARD ( FBPropertyListTrigger  )
pyfbsdk.__FB_FORWARD ( FBPropertyListMotionClip  )
pyfbsdk.__FB_FORWARD ( FBPropertyListTriggerBranch  )
pyfbsdk.FB_DEFINE_COMPONENT ( TriggerGroup  )
pyfbsdk.FB_DEFINE_COMPONENT ( Trigger  )
pyfbsdk.FB_DEFINE_COMPONENT ( TriggerBranch  )
pyfbsdk.FB_DEFINE_ENUM ( TriggerSource  )
pyfbsdk.FB_DEFINE_ENUM ( TriggerMode  )
pyfbsdk.FB_DEFINE_ENUM ( TriggerType  )
pyfbsdk.__FB_FORWARD ( FBPropertyInspector  )
pyfbsdk.FB_FORWARD ( FBUndoManager  )
pyfbsdk.FB_FORWARD ( FBUndo  )
pyfbsdk.FB_DEFINE_ARRAY ( Plug  )
pyfbsdk.__FB_FORWARD ( FBUserObject  )
pyfbsdk.FB_DEFINE_COMPONENT ( UserObject  )
pyfbsdk.FB_DEFINE_COMPONENT ( VideoIn  )
pyfbsdk.FB_DEFINE_COMPONENT ( VideoOut  )
pyfbsdk.FB_DEFINE_COMPONENT ( VideoClip  )
pyfbsdk.FB_DEFINE_COMPONENT ( VideoClipImage  )
pyfbsdk.FB_DEFINE_COMPONENT ( VideoSwitcher  )
pyfbsdk.__FB_FORWARD ( FBVideo  )
pyfbsdk.__FB_FORWARD ( FBVideoClip  )
pyfbsdk.FB_DEFINE_ENUM ( VideoProxyMode  )
pyfbsdk.FB_DEFINE_ENUM ( VideoStorageMode  )
pyfbsdk.FB_DEFINE_ENUM ( VideoInterlaceMode  )
pyfbsdk.FB_DEFINE_ENUM ( VideoFormat  )
pyfbsdk.__FB_FORWARD ( FBVideoClipImage  )
pyfbsdk.__FB_FORWARD ( FBVideoMemory  )
pyfbsdk.__FB_FORWARD ( FBVideoIn  )
pyfbsdk.__FB_FORWARD ( FBVideoOut  )
pyfbsdk.__FB_FORWARD ( FBVideoSwitcher  )
pyfbsdk.__FB_FORWARD ( FBEventVideoSwitcher  )
pyfbsdk.FB_DEFINE_ENUM ( ClipEnd  )
pyfbsdk.FB_DEFINE_ENUM ( PlayMode  )
pyfbsdk.__FB_FORWARD ( FBVideoGrabber  )
pyfbsdk.FB_DEFINE_COMPONENT ( VideoGrabber  )
pyfbsdk.K_INTERFACE ( ICallback  ,
 
)
pyfbsdk.K_FORWARD ( IObject  )
int pyfbsdk.strcpy_s ( str  dst,
int  bufsize,
str  src 
)
int pyfbsdk.strcpy_s ( function  dst,
str  src 
)
int pyfbsdk.strncpy_s ( str  dst,
int  bufsize,
str  src,
int  count 
)
int pyfbsdk.strncpy_s ( function  dst,
str  src,
int  count 
)
int pyfbsdk.vsprintf_s ( str  buffer,
int  bufsize,
str  format,
va_list  args 
)
int pyfbsdk.vsprintf_s ( function  buffer,
str  format,
va_list  args 
)
int pyfbsdk.sprintf_s ( str  buffer,
int  bufsize,
str  format 
)
int pyfbsdk.sprintf_s ( function  buffer,
str  format 
)
int pyfbsdk.strcat_s ( str  dst,
int  bufsize,
str  src 
)
int pyfbsdk.strcat_s ( function  dst,
str  src 
)
str pyfbsdk._itoa ( int  pValue,
str  pString,
int  pRadix 
)
tuple<int,bool> pyfbsdk.FBMessageBoxWithCheck ( str  pBoxTitle,
str  pMessage,
str  pButton1Str,
str  pButton2Str,
str  pButton3Str,
str  pCheckBoxStr,
bool  pCheckBoxValue,
int  pDefaultButton = 0,
bool  pScrolledMessage = False 
)

Dialog popup box with 'don't show again' option.

Opens a message box containing a message and up to three buttons. Waits for the user to click a button. This dialog also gives the user the option of never showing the dialog again.

Parameters:
pBoxTitle Title of message box.
pMessage Message to place in box.
pButton1Str String for first button (Cannot be None).
pButton2Str String for second button (None will not create a button).
pButton3Str String for third button (None will not create a button).
pCheckBoxStr Check box string (Cannot be None).
pCheckBoxValue Check box value.
pDefaultButton Indicates the default (pre-selected) button (default is 0).
pScrolledMessage Scroll message (default is False).
Returns:
A tuple containing the index of the button selected and the boolean value of the check box.
tuple<int,str> pyfbsdk.FBMessageBoxGetUserValue ( str  pBoxTitle,
str  pMessage,
object  pValue,
FBPopupInputType  pValueType,
str  pButton1Str,
str  pButton2Str = None,
str  pButton3Str = None,
int  pDefaultButton = 0 
)

Dialog popup box to get user input.

Opens a message box, with up to three buttons, asking the user to enter data. The type of data to be entered is specified by the pValue and pValueType parameters.

Parameters:
pBoxTitle Title of message box.
pMessage Message to place in box.
pValue Value entered by user (must correspond with pValueType).
pValueType Type of pointer specified in pValue.
pButton1Str String for first button (Cannot be None).
pButton2Str String for second button (None will not create a button).
pButton3Str String for third button (None will not create a button).
pDefaultButton Indicates the default (pre-selected) button(default=0).
Returns:
A tuple containing the index of the button selected and the value entered by the user, if any.

Variable Documentation

int kFBLastActorNodeId = ( kFBHeadNodeId + 1 )

Last Actor NodeId.