pyfbsdk Namespace Reference

Detailed Description

Python module pyfbsk.

This module contains all the Python bindings that MotionBuilder provides for version 2009 of the Open Reality SDK.


Classes
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
	Viewing options for rendering. More...
class	FBConstraintRelation
	ConstraintRelation class. More...
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
	Tool class. More...
class	FBProperty
	Generic application property. More...
class	FBCharacterSolver
	Constraint class. More...
class	FBBatchOptions
	Option parameters for the batch process. More...
class	FBPlotOptions
	Option parameters for plotting. More...
class	FBSystem
	Provides access to the underlying system, and the MotionBuilder scene. More...
class	FBEventDragAndDrop
	Drag and drop interface. More...
class	FBVertex
	Vertex class. More...
class	FBSpread
	Base spreadsheet class. More...
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
	Video Codec manager class. More...
class	FBShaderModelInfo
class	FBScrollBox
	Scroll Box. More...
class	FBVisualComponent
	Visual Component base class. More...
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
	Animatable property base class. More...
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
	List of animation nodes. More...
class	FBPropertyListAudioClip
class	FBPropertyListAudioIn
class	FBPropertyListAudioOut
class	FBPropertyListBox
class	FBPropertyListCamera
class	FBPropertyListCharacter
class	FBPropertyListCharacterFace
class	FBPropertyListComponent
	# Supported list protocol methods: len(propertyListComponent) component= propertyListComponent[0] propertyListComponent[0] = my_component if my_component in propertyListComponent: print "it is contained!" del propertyListComponent[0] More...
class	FBPropertyStringList
	# Supported list protocol methods: len(propertyStringList) component= propertyStringList[0] propertyStringList[0] = my_string if my_string in propertyStringList: print "it is contained!" del propertyStringList[0] More...
class	FBPropertyListDeck
class	FBPropertyListDevice
class	FBPropertyListDeviceInstrument
	List of instruments. More...
class	FBPropertyListFCurveKey
	List of FCurveKey. More...
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
class	FBAccessMode
	pyfbsdk More...
class	FBActor
	Actor class. More...
class	FBActorFace
	ActorFace class. More...
class	FBAlphaSource
	Shader transparency computation. More...
class	FBAnimationLayer
	Animation Layer class. More...
class	FBAnimationNode
	See samples: CopyAnimation.py, ClearKeysOnSelectedModels.py, FCurveEditor.py. More...
class	FBApplication
	FBApplication is used mainly to manage files. More...
class	FBArrowButton
	Arrow Button. 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
	The FBAssetMng class. More...
class	FBAssetMngFileOptions
	Behavior of the application when working with managed files. More...
class	FBAssetMngMenuOptions
	Show or hide version control menu items. More...
class	FBAttachType
	Types of attachments between UI regions. More...
class	FBAttenuationType
	Light attenuation types. More...
class	FBAudioClip
	Audio Clip class. More...
class	FBAudioIn
	Audio In class. More...
class	FBAudioOut
	Audio Out class. More...
class	FBBatchFileFormat
	Different file formats for the batch. More...
class	FBBatchOnContainsBatchTakes
	Different actions to perform when a scene already contains batch takes while in a batch process. More...
class	FBBatchOnTakeExist
	Different actions to perform when a take already exist while in a batch process. More...
class	FBBatchProcessType
	Different process type for the batch. More...
class	FBBatchStatus
	Different return values of the Batch process. More...
class	FBBodyNodeId
	All body nodes. More...
class	FBBodyPartId
	Body part for character. More...
class	FBBorderStyle
	Different border types available. More...
class	FBBox
	Box class. More...
class	FBBoxPlaceHolder
	Wrapper around a specific instance of a FBBox object. More...
class	FBBrowsingProperty
	Property browsing. More...
class	FBButton
	Used to create and manage buttons in a user interface. More...
class	FBButtonLook
	Button look. More...
class	FBButtonState
	Possible button states. More...
class	FBButtonStyle
	Style of buttons. More...
class	FBCamera
	Creates custom cameras and manages system cameras. More...
class	FBCameraAntiAliasingMethod
	Antialiasing methods. More...
class	FBCameraApertureMode
	Aperture modes. More...
class	FBCameraDistanceMode
	Camera plane distance modes. More...
class	FBCameraFilmBackType
	Filmback types. More...
class	FBCameraFocusDistanceSource
	Focus distance sources. More...
class	FBCameraFrameSizeMode
	Frame size modes. More...
class	FBCameraMatrixType
	Camera matrix types. More...
class	FBCameraResolutionMode
	Resolution modes. More...
class	FBCameraSafeAreaMode
	Safe area modes. More...
class	FBCameraSamplingType
	Antialiasing sampling types. More...
class	FBCameraSwitcher
	Camera switcher. More...
class	FBCameraType
	Focus distance types. More...
class	FBCameraViewPlaneMode
	Camera plane viewing modes. More...
class	FBCellStyle
	Different styles of spreadsheet cell styles. More...
class	FBCharacter
	Character class. More...
class	FBCharacterContactBehaviour
	Character Contact Behaviour. More...
class	FBCharacterExtension
	Objects Grouping class. More...
class	FBCharacterFace
	Character class. More...
class	FBCharacterHipsTranslationMode
	Character Hips Translation modes. More...
class	FBCharacterInputType
	Character Input/Output types. More...
class	FBCharacterKeyingMode
	Character keying modes. More...
class	FBCharacterPlotWhere
	Where to plot a character. More...
class	FBCharacterPose
	FBCharacterPose class. More...
class	FBCharacterPoseFlag
	Character Pose Options flags. More...
class	FBCharacterPoseKeyingMode
	Character Pose Keying Mode. More...
class	FBCharacterPoseOptions
	FBCharacterPoseOptions class. More...
class	FBCharacterResetProperties
	Character Reset Properties Type. More...
class	FBCharacterRollSolver
	Character Roll Solver version. More...
class	FBClipEnd
	Clip end actions. More...
class	FBCluster
	Cluster. More...
class	FBClusterMode
	Different clustering modes. More...
class	FBCommPortType
	Communication port type. More...
class	FBCommType
	Communications type. More...
class	FBCommandState
	FBCommandState. More...
class	FBComponent
	MotionBuilder SDK base class. More...
class	FBConfigFile
	Interface to the application config files. More...
class	FBConnectionAction
	Possible actions when a notify plug event occurs. More...
class	FBConnectionType
	Connection types available between plugs. More...
class	FBConsoleChannelType
	Console channel types. More...
class	FBConstraint
	Constraint class. More...
class	FBConstraintInfo
	Constraint information class. More...
class	FBConstraintManager
	Constraint manager. More...
class	FBConstraintSolver
	Base class for constraint solver. More...
class	FBContainer
	Container. More...
class	FBControlSet
	Control set class. More...
class	FBControlSetType
	Character ControlSet type. More...
class	FBControllerMode
	Controller modes for optical model. More...
class	FBDeck
	Deck class. More...
class	FBDeckTransportMode
	FBDeckTransportMode. More...
class	FBDeformer
	Base Model deformer class. More...
class	FBDevice
	Base Device class. More...
class	FBDeviceInstrument
	Instrument abstraction layer. More...
class	FBDeviceKeyboardKey
	Keyboard keys (for input). More...
class	FBDeviceNotifyInfo
	Device Input and Output Notification information structure. More...
class	FBDeviceSamplingMode
	Recording types. More...
class	FBDisplayMode
	Model display options. More...
class	FBDisplayWhat
	Model display mask This mask determines what types of models are displayed by the renderer. More...
class	FBDragAndDropState
	State of Drag and Drop. More...
class	FBEdit
	Text edit box. More...
class	FBEditColor
	Color edit widget. More...
class	FBEditNumber
	Number edit box. More...
class	FBEditProperty
	Property editor widget. More...
class	FBEditPropertyModern
	Property editor widget. More...
class	FBEditVector
	Vector edit widget. More...
class	FBEffectorId
	All effector nodes. More...
class	FBEffectorSetID
	Effector ID identifier. More...
class	FBElementAction
	Enumeration that describe the different actions available on a scene element depending on the current context. More...
class	FBEvaluateInfo
	AnimationNodeNotify evaluation information. More...
class	FBEvent
	Base Event class. More...
class	FBEventActivate
	Activation event. More...
class	FBEventAnimationNodeType
	Event based on animation node. 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	FBFbxManager
	FBX interface for loading/saving files into the application. More...
class	FBFbxManagerLoadAnimationMethod
	This enumeration is used to choose how to load an animation file on a character. More...
class	FBFbxManagerState
	This enumeration indicate the current state of the FBFbxManager. More...
class	FBFbxOptions
	See samples: FBFbxOptions.py, ImportWithNamespace.py. More...
class	FBFbxTake
	Take class for Fbx import. More...
class	FBFilePopup
	File Popup (for open/save). More...
class	FBFilePopupStyle
	Different types of file popup windows. More...
class	FBFilter
	Filter class. More...
class	FBFilterManager
	Filter manager. More...
class	FBFilterType
	Filter types. More...
class	FBFloorContactID
	Floor contact for the given index. More...
class	FBFogMode
	Fog falloff modes. More...
class	FBFolder
	Folder class. More...
class	FBFolderPopup
	Folder Popup (for selecting a directory). More...
class	FBGapMode
	Gap interpolation modes. More...
class	FBGenerationMode
	Generation modes for optical model. More...
class	FBGenericMenu
	A GenericMenu class. More...
class	FBGenericMenuItem
	FBGenericMenuItem This class stores data for a single menu item. More...
class	FBGeometry
	Geometry class. More...
class	FBGeometryArrayElementType
	Type of data when requesting an array. More...
class	FBGeometryArrayID
	ID to use when requesting a specific array of data for a model. More...
class	FBGeometryMappingMode
	Determine how the element is mapped on a surface. More...
class	FBGeometryReferenceMode
	Determine how the mapping information is stored in the array of coordinate. More...
class	FBGlobalLight
	Global light class. More...
class	FBGroup
	Objects Grouping class. More...
class	FBHandle
	FBHandle class. More...
class	FBIconPosition
	Different icon positions possible. More...
class	FBImage
	Image class. More...
class	FBImageContainer
	Image. More...
class	FBImageFormat
	Image formats. More...
class	FBImageInterleaveType
	Image field interleave types. More...
class	FBImageInterpolationType
	Image interpolation types. More...
class	FBImageType
	Image types. More...
class	FBInputKey
	Keyboard inputs. More...
class	FBInputModifier
	Input Modifiers (Ctrl, Alt, Shift). More...
class	FBInputType
	Types of input events. More...
class	FBInsertSegmentMode
	Insert segment modes. More...
class	FBInterpolation
	Types of interpolation for an FCurve. More...
class	FBInterpolatorCurveType
	Types of interpolator for an FCurve. More...
class	FBKeyControl
	Key control. More...
class	FBKeyingGroup
	KeyingGroup class. More...
class	FBKeyingGroupType
	Keying group types. More...
class	FBLabel
	Text label. More...
class	FBLayerMode
	Layer mode. More...
class	FBLayerRotationMode
	Rotation mode for layer. More...
class	FBLayeredTexture
	LayeredTexture class. More...
class	FBLayout
	Used to build the user interface. More...
class	FBLayoutRegion
	Layout region. More...
class	FBLight
	Light class. More...
class	FBLightType
	Light types. More...
class	FBList
	List of items. More...
class	FBListStyle
	List style or direction. More...
class	FBManipulatorPickType
	Types of manipulator picking. More...
class	FBManipulatorTransformType
	Manipulator transform stles. More...
class	FBMarkerLook
	Look of the marker. More...
class	FBMarkerResolutionLevel
	Resolution of marker mesh sphere and capsule (Quality). More...
class	FBMarkerSet
	Marker set class. More...
class	FBMarkerType
	Type of the marker. More...
class	FBMaterial
	Material class. More...
class	FBMaterialTextureType
	Ways to apply Rotation. More...
class	FBMemo
	Multi-line text input. More...
class	FBMenuItemType
	Types of menu items available. More...
class	FBMenuManager
	The menu manager allows access to MotionBuilder menu bar. More...
class	FBMesh
	Mesh class. More...
class	FBMirrorPlaneType
	Mirror Plane Type. More...
class	FBModel
	Model class. More...
class	FBModelCube
	Cube model class. More...
class	FBModelMarker
	Model marker class. More...
class	FBModelNull
	Null object class. More...
class	FBModelOptical
	Optical model class. More...
class	FBModelPath3D
	Path 3D model class. More...
class	FBModelPlaceHolder
	Wrapper around a specific instance of a FBModel object. More...
class	FBModelPlane
	Plane model class. More...
class	FBModelRoot
	Root object class. More...
class	FBModelRotationOrder
	Ways to apply Rotation. More...
class	FBModelShadingMode
	Modes for model shading. More...
class	FBModelSkeleton
	Root object class. More...
class	FBModelTemplate
	Model template class. More...
class	FBModelTemplateStyle
	Model template styles When creating model templates, this parameter will affect the actual model created (associated with the model template). More...
class	FBModelTransformationMatrix
	Types of transformation vector/matrices possible. More...
class	FBMotionClip
	Motion class. More...
class	FBMultiLangManager
	Language manager. More...
class	FBNamespaceAction
	Namespace flags. More...
class	FBNote
	Note class. More...
class	FBNurbs
	Nurbs class. More...
class	FBObjectFlag
	Available flags for any component. More...
class	FBObjectPose
	FBObjectPose class. More...
class	FBObjectPoseMirrorOptions
	FBObjectPoseMirrorOptions class. More...
class	FBObjectPoseMirrorOptionsFlag
	ObjectPoseMirrorOptions flags. More...
class	FBObjectPoseOptions
	FBObjectPoseOptions class. More...
class	FBObjectPoseOptionsFlag
	ObjectPoseOptions flags. More...
class	FBObjectStatus
	Available lifetime status for any component. More...
class	FBOrientation
	General directions for UI components. More...
class	FBParity
	Parity modes. More...
class	FBPatch
	Patch class. More...
class	FBPathTangeantMode
	Tangeant modes available for path keys. More...
class	FBPhysicalProperties
	Base class for physical properties attach to a model. More...
class	FBPickingMode
	3D picking mode. More...
class	FBPlayMode
	Play modes. More...
class	FBPlayerControl
	Player control. More...
class	FBPlotAllowed
	FBPlotAllowed. More...
class	FBPlotPopup
	Plot Popup (for setting options only). More...
class	FBPlug
	Connections Basic Open Reality SDK Element. More...
class	FBPopup
	Popup window. More...
class	FBPopupInputType
	User input types for a popup. More...
class	FBPose
	Pose class. More...
class	FBPoseTransformType
	Transform mode of pose. More...
class	FBPoseType
	Types of pose. More...
class	FBProgress
	Progress bar. More...
class	FBPropertyConnectionEditor
	Property Connection Editor. More...
class	FBPropertyFlag
	Available flags for FBProperty objects. More...
class	FBPropertyListCharacterExtension
	Character extension property list. More...
class	FBPropertyListCharacterPose
class	FBPropertyListConstraint
class	FBPropertyListConstraintSolver
class	FBPropertyListControlSet
class	FBPropertyListFolder
class	FBPropertyListMotionClip
class	FBPropertyListObjectPose
class	FBPropertyListPhysicalProperties
class	FBPropertyListVideoClip
class	FBPropertyManager
	Property Manager. More...
class	FBPropertyType
	Property types. More...
class	FBRSType
	RS type for serial port. More...
class	FBRecalcMarkerSetOffset
	Recalculate MarkerSet offset for? More...
class	FBReferenceTime
	Reference time class. More...
class	FBRenderOptions
class	FBRenderer
	Open Reality renderer interface. More...
class	FBRenderingPass
	Rendering Pass. More...
class	FBRigidBodyMode
	Rigid body modes. More...
class	FBRotationFilter
	Rotation filters. More...
class	FBScene
	Access to the MotionBuilder scene. More...
class	FBSceneChangeType
	Types of model selection events. More...
class	FBSegmentMode
	Segment modes. More...
class	FBSet
	Objects Set class. More...
class	FBShader
	Shader class. More...
class	FBShaderLighted
	Lighted shader class. More...
class	FBShaderManager
	Shader manager. More...
class	FBShaderShadowLive
	Shader Shadow Live class. More...
class	FBShadowFrameType
	Shadow calculation methods. More...
class	FBShadowType
	Shadow types. More...
class	FBSkeletonNodeId
	All Skeleton nodes. 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	FBStoryClipCompMode
	Compensation Modes for story character clips. More...
class	FBStoryClipShowGhostMode
	Show Ghost Modes for story animation clips. More...
class	FBStoryClipSolveMode
	Solve Modes for story character clips. More...
class	FBStoryFolder
	Story Folder class. More...
class	FBStoryTrack
	Story Track class. More...
class	FBStoryTrackBodyPart
	Body Parts for story track character. More...
class	FBStoryTrackRefMode
	References Modes for story animation tracks. More...
class	FBStoryTrackType
	Types for new story tracks. More...
class	FBStringList
	String list. More...
class	FBSurface
	Surface class. More...
class	FBSurfaceMode
	Surface modes. More...
class	FBSurfaceType
	Surface types. More...
class	FBTCPIPSocketType
	Types of TCP/IP Sockets. More...
class	FBTabPanel
	Tab panel. More...
class	FBTake
	A take is a container for animation in a scene. More...
class	FBTakeChangeType
	Types of take change events. More...
class	FBTakeSpanOnLoad
	This enumeration indicate the how to set the take start and end points on after a load. More...
class	FBTangentClampMode
	Different clamping modes for the tangents. More...
class	FBTangentConstantMode
	Different constant modes for the tangents. More...
class	FBTangentMode
	Methods of tangent calculation. More...
class	FBTextJustify
	Text justification styles. More...
class	FBTextStyle
	Text appearance styles. More...
class	FBTexture
	Texture class. More...
class	FBTextureBlendMode
	Texture blend modes. More...
class	FBTextureMapping
	Texture mapping modes. More...
class	FBTextureUseType
	Texture Use Type. More...
class	FBThermometer
	Thermometer. More...
class	FBTime
	Time data structure. More...
class	FBTimeCode
class	FBTimeMode
	Different time modes available. More...
class	FBTimeReferential
	FBCommandState. More...
class	FBTimeSpan
	TimeSpan class. More...
class	FBTransportMode
	Transport modes. More...
class	FBTransportPlaySpeed
	Available transport control play speed. More...
class	FBTransportSnapMode
	Available snap methods for the transport control. More...
class	FBTransportTimeFormat
	Available transport control time display. More...
class	FBTree
	Tree list view. More...
class	FBTreeNode
	A node in the tree view. More...
class	FBTriggerStyle
	Audio clips' trigger styles. More...
class	FBUndoManager
	Access to global undo and redo functionality. More...
class	FBUseChnMode
	Use Channel modes. More...
class	FBUserObject
class	FBVideo
	Video media class. More...
class	FBVideoClip
class	FBVideoCodecMode
	Enum FBVideoRenderDepth. More...
class	FBVideoFormat
	Video color modes. More...
class	FBVideoGrabber
	Video Grabber class. More...
class	FBVideoIn
	Video media class. More...
class	FBVideoInterlaceMode
	Video interlace modes. More...
class	FBVideoOut
	Video media class. More...
class	FBVideoProxyMode
	Video proxy modes. More...
class	FBVideoRenderDepth
	Enum FBVideoRenderDepth. More...
class	FBVideoRenderFieldMode
	Enum FBVideoRenderFieldMode. More...
class	FBVideoRenderViewingMode
	Enum FBVideoRenderViewingMode. More...
class	FBVideoStorageMode
	Video storage modes. More...
class	FBView
	Generic view. More...
class	FBViewerInfos
	Scene information display. More...
class	FBViewerMode
	Different viewer modes for the 3D viewer. More...
class	FBZSortMode
	Z sorting Mode. More...
Functions
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.
bool	FBConnect (FBPlug pSrc, FBPlug pDst, FBConnectionType pConnectionType= FBConnectionType.kFBConnectionTypeNone)
	Request the connection two FBPlug objects.
bool	FBDisconnect (FBPlug pSrc, FBPlug pDst)
	Connect two FBPlug objects.
FBAudioFmt	FBAudioFmt_AppendFormat (FBAudioFmt pFormat, int pChannels, int pBits, int pRate)
FBAudioFmt	FBAudioFmt_AppendFormat (FBAudioFmt pFormat, FBAudioFmt pSrcFormat)
int	FBAudioFmt_GetBitsValue (FBAudioFmt pFormat)
int	FBAudioFmt_GetBytesValue (FBAudioFmt pFormat)
int	FBAudioFmt_GetChannelValue (FBAudioFmt pFormat)
FBAudioFmt	FBAudioFmt_GetDefaultFormat ()
int	FBAudioFmt_GetRateValue (FBAudioFmt pFormat)
FBAudioFmt	FBAudioFmt_RemoveFormat (FBAudioFmt pFormat, int pChannels, int pBits, int pRate)
FBAudioFmt	FBAudioFmt_RemoveFormat (FBAudioFmt pFormat, FBAudioFmt pSrcFormat)
bool	FBAudioFmt_TestFormat (FBAudioFmt pSrcFormat, int pChannels, int pBits, int pRate)
FBComponent	FBCreateObject (str pGroupName, str pEntryName, str pName, pData=None, int nth=0)
	FBCreateObject.
FBModel	FBFindModelByName (str pModelName, FBModel pParent=None)
	Find a model in the hierarchy.
	FBFindObjectsByName (str pNamePattern, FBComponentList pList, bool pIncludeNamespace=True, bool pModelsOnly=False)
	FBFindObjectsByName.
	FBFindObjectsByNamespace (str pNamePattern, FBComponentList pList)
	FBFindObjectsByName.
int	FBGetCharacterExternalSolverCount ()
	Get character external solver count.
int	FBGetCharacterExternalSolverIndex (str pName)
	Get character external solver index.
str	FBGetCharacterExternalSolverName (int pIndex)
	Get character external solver name.
FBCharacterKeyingMode	FBGetCharactersKeyingMode ()
	return Character Manipulation/Keying Mode
FBBodyPartId	FBGetEffectorBodyPart (FBEffectorId pEffectorId)
	return BodyPart ID from Effector.
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.
	FBGetSelectedModels (FBModelList pList, FBModel pParent=None, bool pSelected=True, bool pSortBySelectOrder=False)
	Find all models that are selected (if pSelected is true) Searches recursively from a root model for models that are selected, and adds them to a list of models.
FBModel	FBLoadFbxPrimitivesModel (str pModelName)
	Load a model.
int	FBMessageBox (str pBoxTitle, str pMessage, str pButton1Str, str pButton2Str=None, str pButton3Str=None, int pDefaultButton=0, int pScrolledMessage=0)
	Dialog popup box.
	FBModelTransactionBegin ()
	FBModelTransactionBegin.
	FBModelTransactionEnd ()
	FBModelTransactionEnd.
bool	FBPopNormalTool (str pToolName, bool pSetFocus=True)
	This function is used to bring up a specific tool in the GUI.
	FBSelectObjectsByNamespace (str pNameSpaceName, bool pSelect, bool pSearchExclusive=True)
	FBSelectObjectsByNamespace.
	FBSleep (unsigned long MilliSeconds)
	Sleep function Puts system to sleep for specified time.
	FBTrace (str pFormatString,...p1)
	This function prints useful debugging strings in the console.

Function Documentation

FBAudioFmt pyfbsdk::FBAudioFmt_AppendFormat	(	FBAudioFmt	pFormat,
		FBAudioFmt	pSrcFormat
	)

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

int pyfbsdk::FBAudioFmt_GetBitsValue ( FBAudioFmt pFormat )

int pyfbsdk::FBAudioFmt_GetBytesValue ( FBAudioFmt pFormat )

int pyfbsdk::FBAudioFmt_GetChannelValue ( FBAudioFmt pFormat )

FBAudioFmt pyfbsdk::FBAudioFmt_GetDefaultFormat ( )

int pyfbsdk::FBAudioFmt_GetRateValue ( FBAudioFmt pFormat )

FBAudioFmt pyfbsdk::FBAudioFmt_RemoveFormat	(	FBAudioFmt	pFormat,
		FBAudioFmt	pSrcFormat
	)

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

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

bool pyfbsdk::FBConnect	(	FBPlug	pSrc,
		FBPlug	pDst,
		FBConnectionType	pConnectionType = `FBConnectionType.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.

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.

See sample: ObjectCreation.py.

bool pyfbsdk::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.

FBModel pyfbsdk::FBFindModelByName	(	str	pModelName,
		FBModel	pParent = `None`
	)

Find a model in the hierarchy.

Searches the scene for a model, based on the model's unique name.

Parameters:

	pModelName	Name of model to search for.
	pParent	Root model to search from (default=NULL(root)).

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

See samples: CopyAnimation.py, 3ds Max Biped Template.py, EnableGameModeOnSelectedCharacters_Z.py.

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

FBFindObjectsByName.

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

Parameters:

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

See sample: FindObjectsWithWildcard.py.

pyfbsdk::FBFindObjectsByNamespace	(	str	pNamePattern,
		FBComponentList	pList
	)

FBFindObjectsByName.

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: trmodscene )
	pList	List that contains the objects

See sample: FindObjectsWithWildcard.py.

int pyfbsdk::FBGetCharacterExternalSolverCount ( )

Get character external solver count.

Returns:: Number of external character solver available.

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.

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.

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.

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.The following sample code shows 2 cases that do not use context, and 2 cases that are using a context which are internal class names.Python sample code:

    from pyfbsdk import *

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

C++ sample code:

    // Will return 'Character Extension'.
    FBTrace( "%s\n", FBGetMultiLangText( "", "CharacterExtension" ));

    // Will return 'Max Freedom'.
    FBTrace( "%s\n", FBGetMultiLangText( "", "TranslationMax" ));

    // Will return 'Parent/Child'.
    FBTrace( "%s\n", FBGetMultiLangText( "KConstraintUIName", "Parent-Child" ));

    // Will return 'Field Of View'.
    FBTrace( "%s\n", FBGetMultiLangText( "KCamera", "FieldOfView" ));

Parameters:

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

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

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.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()));
        }
    }

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.

pyfbsdk::FBGetSelectedModels	(	FBModelList	pList,
		FBModel	pParent = `None`,
		bool	pSelected = `True`,
		bool	pSortBySelectOrder = `False`
	)

Find all models that are selected (if pSelected is true) Searches recursively from a root model for models that are selected, and adds them to a list of models.

Parameters:

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

See sample: FBGetSelectedModels.py.

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.

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.

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

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.

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.

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.

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

pyfbsdk::FBSleep ( unsigned long MilliSeconds )

Sleep function Puts system to sleep for specified time.

Parameters:

MilliSeconds

Time to sleep for.

See sample: FBProgress.py.

pyfbsdk::FBTrace	(	str	pFormatString,
			p1
	)

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.

Generated on Tue Feb 9 19:34:00 2010 for Python Reference Guide by

1.5.3

pyfbsdk Namespace Reference

Detailed Description

Classes

Functions

Function Documentation