This reference page is linked to from the following overview topics: Namespaces and Autocomplete, Deleting a Referenced Object, FBScene - The Scene Class, Customizing the MotionBuilder SDK, Optical devices, FBModel - Transformation Data and the Scene Graph, FBComponent - The Base Entity Class, Your First Python Program, Understanding the Referenced Objects and Referenced Items, MotionBuilder 2014, FBPlug - Object Connection Management, FBMaterial and FBTexture - Materials and Textures, Creating and Characterizing a Skeleton, MotionBuilder 2013, Utility Classes, Character Marker Set, Getting Notified of Source File Changes, FBLight - Lights, Adjusting the Extraction, Modifying the Items in a Referenced Object, Solving from the Goal to the Skeleton, Keyframe Animation on Referenced Items, FBCamera - Cameras, Unloading and Reloading a Referenced Object, Example: Cube Counter, Restoring a Referenced Object, FBCharacter - Characters, FBPose - Poses, Rigid Body Physics, Joint Chains.
def FBLoadFbxPrimitivesModel | ( | ) |
Python Docstring:
FBLoadFbxPrimitivesModel( (str)arg1) -> object
C++ Signature:
K_DLLIMPORT FBModel * FBLoadFbxPrimitivesModel(const char * pModelName)
Load a model.
pModelName | Name of primitive model to load. |
def FBTrace | ( | ) |
Python Docstring:
FBTrace( (str)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBTrace(const char * pFormatString, ... )
This function prints useful debugging strings in the console with kFBNORMAL_TRACE output detailed level.
pFormatString | A printf-style format string, to use the following arguments in the list. |
Not thread safe, as an static array is used internally.
def FBTraceGetLevel | ( | ) |
Python Docstring:
FBTraceGetLevel() -> int
C++ Signature:
K_DLLIMPORT unsigned int FBTraceGetLevel()
Get Global Trace Detailed Level which affects all the output targets.
def FBObjectPrintLivings | ( | ) |
Python Docstring:
FBObjectPrintLivings( (int)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBObjectPrintLivings(unsigned int pStartUniqueId)
Print those living objects created when logging is enabled.
pStartUniqueId | Any living object has been logged and with its uniqueId no less than pStartUniqueId will be printed out. |
FBMessageBoxGetUserValue | ( | ) |
Python Docstring:
FBMessageBoxGetUserValue( (str)arg1, (str)arg2, (object)arg3, (FBPopupInputType)arg4, (str)arg5 [, (str)arg6 [, (str)arg7 [, (object)arg8 [, (object)arg9]]]]) -> tuple
C++ Signature:
K_DLLEXPORT int FBMessageBoxGetUserValue(const char * pBoxTitle, const char * pMessage, void * pValue, FBPopupInputType pValueType, const char * pButton1Str, const char * pButton2Str = NULL, const char * pButton3Str = NULL, 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.
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 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. |
/**
def FBModelTransactionBegin | ( | ) |
Python Docstring:
FBModelTransactionBegin() -> None
C++ Signature:
K_DLLIMPORT void FBModelTransactionBegin()
FBModelTransactionBegin. This set of functions speeds up the process of batch operations on models.
def FBAudioFmt_GetRateValue | ( | ) |
Python Docstring:
FBAudioFmt_GetRateValue( (object)arg1) -> int
C++ Signature:
K_DLLIMPORT int FBAudioFmt_GetRateValue(FBAudioFmt pFormat)
def FBGetEffectorBodyPart | ( | ) |
Python Docstring:
FBGetEffectorBodyPart( (FBEffectorId)arg1) -> FBBodyPartId
C++ Signature:
K_DLLIMPORT FBBodyPartId FBGetEffectorBodyPart(FBEffectorId pEffectorId)
return BodyPart ID from Effector.
pEffectorId | Effector ID. |
def FBGetCharacterFingerTipsVisibility | ( | ) |
Python Docstring:
FBGetCharacterFingerTipsVisibility() -> bool
C++ Signature:
K_DLLIMPORT bool FBGetCharacterFingerTipsVisibility()
Queries visibility of the finger-tips of the current character.
def FBSetCharacterFingerTipsVisibility | ( | ) |
Python Docstring:
FBSetCharacterFingerTipsVisibility( (object)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBSetCharacterFingerTipsVisibility(bool pShow)
Sets visibility of the finger-tips of the current character.
pShow | Specifies if finger-tips of the current character should be visible. |
def FBMatrixMult | ( | ) |
Python Docstring:
FBMatrixMult( (FBMatrix)arg1, (FBMatrix)arg2, (FBMatrix)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixMult(FBMatrix & pMatrix, const FBMatrix & pA, const FBMatrix & pB)
Multiply two matrices.
pMatrix | Calculated resulting matrix. |
pA | 1st matrix. |
pB | 2nd matrix. |
def FBVertexMatrixMult | ( | ) |
Python Docstring:
FBVertexMatrixMult( (FBVertex)arg1, (FBMatrix)arg2, (FBVertex)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBVertexMatrixMult(FBVertex & pOutVertex, const FBMatrix & pMatrix, const FBVertex & pVertex)
Multiply a vertex by a matrix.
pOutVertex | Resulting vertex. |
pMatrix | Matrix to affect the vertex with. |
pVertex | Source vertex. |
def FBTranslationToMatrix | ( | ) |
Python Docstring:
FBTranslationToMatrix( (FBMatrix)arg1, (FBVector4d)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBTranslationToMatrix(FBMatrix & pMatrix, const FBVector4 & pVector)
Convert a translation vector to a matrix.
pMatrix | Calculated resulting matrix. |
pVector | Translation vector. |
def FBMatrixToTranslation | ( | ) |
Python Docstring:
FBMatrixToTranslation( (FBVector4d)arg1, (FBMatrix)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixToTranslation(FBVector4 & pVector, const FBMatrix & pMatrix)
Obtain translation vector from a matrix.
pVector | Extracted translation vector. |
pMatrix | Input matrix. |
def FBRotationToQuaternion | ( | ) |
Python Docstring:
FBRotationToQuaternion( (FBVector4d)arg1, (FBVector3d)arg2 [, (FBRotationOrder)arg3]) -> None
C++ Signature:
K_DLLIMPORT void FBRotationToQuaternion(FBQuaternion & pQuaternion, const FBVector3 & pVector, FBRotationOrder pRotationOrder = kFBXYZ)
Get a quaternion from a rotation vector.
pQuaternion | Calculated quaternion. |
pVector | Input rotation vector. |
pRotationOrder | Rotation order of the rotation vector. |
def FBMatrixToQuaternion | ( | ) |
Python Docstring:
FBMatrixToQuaternion( (FBVector4d)arg1, (FBMatrix)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixToQuaternion(FBQuaternion & pQuaternion, const FBMatrix & pMatrix)
Get a quaternion from a matrix (potential ).
pQuaternion | Calculated quaternion. |
pMatrix | Input matrix. |
def FBAdd | ( | ) |
Python Docstring:
FBAdd( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBAdd(FBVector4 & pResult, const FBVector4 & pV1, const FBVector4 & pV2)
Add two vectors together (pResult = pV1+pV2)
pResult | Resulting vector. |
pV1 | 1st vector. |
pV2 | 2nd vector. |
def FBQSub | ( | ) |
Python Docstring:
FBQSub( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBQSub(FBQuaternion & pResult, const FBQuaternion & pQ1, const FBQuaternion & pQ2)
Subtract pQ2 from pQ1 (pResult = pQ1-pQ2)
pResult | Resulting quaternion. |
pQ1 | 1st quaternion. |
pQ2 | 2nd quaternion. |
def FBInterpolateRotation | ( | ) |
Python Docstring:
FBInterpolateRotation( (FBVector3d)arg1, (FBVector3d)arg2, (FBVector3d)arg3, (object)arg4) -> None FBInterpolateRotation( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3, (object)arg4) -> None
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBDeformer_TypeInfo | ( | ) |
def FBTimeWarpManager_TypeInfo | ( | ) |
def FBAnimationNode_TypeInfo | ( | ) |
def FBGlobalLight_TypeInfo | ( | ) |
def FBTake_TypeInfo | ( | ) |
def FBUserObject_TypeInfo | ( | ) |
def FBVideoOut_TypeInfo | ( | ) |
def FBModel_TypeInfo | ( | ) |
def FBModelVertexData_TypeInfo | ( | ) |
def FBModelMarker_TypeInfo | ( | ) |
def FBModelNull_TypeInfo | ( | ) |
def FBModelRoot_TypeInfo | ( | ) |
def FBModelSkeleton_TypeInfo | ( | ) |
def FBModelOptical_TypeInfo | ( | ) |
def FBModelMarkerOptical_TypeInfo | ( | ) |
def FBMarkerSet_TypeInfo | ( | ) |
def FBControlSet_TypeInfo | ( | ) |
def FBActor_TypeInfo | ( | ) |
def FBActorFace_TypeInfo | ( | ) |
def FBCharacterExtension_TypeInfo | ( | ) |
def FBCharacter_TypeInfo | ( | ) |
def FBCamera_TypeInfo | ( | ) |
def FBSet_TypeInfo | ( | ) |
def FBHUDElement_TypeInfo | ( | ) |
def FBHUDTextureElement_TypeInfo | ( | ) |
def FBHUDFlashElement_TypeInfo | ( | ) |
def FBAssetFile_TypeInfo | ( | ) |
def ShowTool | ( | ) |
def CloseTool | ( | ) |
def FBGenericMenuItem_TypeInfo | ( | ) |
def FBEditColor_TypeInfo | ( | ) |
def FBSlider_TypeInfo | ( | ) |
def FBEditProperty_TypeInfo | ( | ) |
def FBPropertyConnectionEditor_TypeInfo | ( | ) |
def FBPropertyViewManager_TypeInfo | ( | ) |
def FBSchedulingDependencyOutput | ( | ) |
Python Docstring:
FBSchedulingDependencyOutput( (object)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBSchedulingDependencyOutput(bool pEnable)
Debug function for MT dependency debug. When enabled log file will be created and updated each time MultiThreaded scheduling is happening (scene rebuild)
pEnable | ON/OFF switch. This is not stored in config (should be changed only for debug purpose, because slow down rebuild process ) |
def FBFindModelByLabelName | ( | ) |
Python Docstring:
FBFindModelByLabelName( (str)arg1) -> object
C++ Signature:
K_DLLIMPORT FBModel * FBFindModelByLabelName(const char * pModelLabelName)
Find a model in the scene by its label name. Searches the scene for a model, based on the model's label name. Label name is "NameSpaceName:ObjectName". also known as "PrefixName::ObjectName" Full name is "GroupName::NameSpaceName:ObjectName".
pModelLabelName | LabelName of model to search for. Specify it with schema like "NameSpaceName:ObjectName",or "ObjectName" if no NameSpaceName. |
def FBFindModelByUniqueColorId | ( | ) |
Python Docstring:
FBFindModelByUniqueColorId( (FBColor)arg1) -> tuple
C++ Signature:
K_DLLIMPORT FBModel * FBFindModelByUniqueColorId(const FBColor & pColor, int * pSubItemIndex = NULL)
Find a model in the scene by its unique color id. A model could have a single unique ColorID, but SDK plugin user could request additional ColorID per model to support multi sub items picking. see FBModel.SetAdditionalUniqueColorIDCount().
pColor | Color channel values are in range of [0,1] with precision 1.0/255 |
pSubItemIndex | Pass out SubImtem index value if not null. In pyfbsdk no such parameter. |
def FBFindObjectByFullName | ( | ) |
Python Docstring:
FBFindObjectByFullName( (str)arg1) -> object
C++ Signature:
K_DLLIMPORT FBComponent * FBFindObjectByFullName(const char * 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"
pObjectFullName | Full Name of object to search for. Specify it with schema like "GroupName::NameSpaceName:ObjectName",or "GroupName::ObjectName" if no NameSpaceName. |
def FBMergeTransactionFileRefEditBegin | ( | ) |
Python Docstring:
FBMergeTransactionFileRefEditBegin() -> None
C++ Signature:
K_DLLIMPORT void FBMergeTransactionFileRefEditBegin()
Call to begin the transaction for merging multiple files and applying File Reference edit at the same time. Useful to consecutively merge multiple files into scene with FileRef edit operation in between.
def FBMergeTransactionFileRefEditEnd | ( | ) |
Python Docstring:
FBMergeTransactionFileRefEditEnd() -> None
C++ Signature:
K_DLLIMPORT void FBMergeTransactionFileRefEditEnd()
Call to end merge transaction with File Reference edit.
def FBMergeTransactionFileRefEditIsOn | ( | ) |
Python Docstring:
FBMergeTransactionFileRefEditIsOn() -> bool
C++ Signature:
K_DLLIMPORT bool FBMergeTransactionFileRefEditIsOn()
Call to tell if system is during File Reference Edit Merge transaction.
def FBTraceSetLevel | ( | ) |
Python Docstring:
FBTraceSetLevel( (int)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBTraceSetLevel(unsigned int pNewLevel)
Set Global Trace Detailed Level which affects all the output targets.
pNewLevel | Any trace message with detailed level higher than this new level will be ignored, valid value range [kFBNO_TRACE, kFBALL_TRACE] |
def FBModelTransactionEnd | ( | ) |
Python Docstring:
FBModelTransactionEnd() -> None
C++ Signature:
K_DLLIMPORT void FBModelTransactionEnd()
FBModelTransactionEnd. This set of functions speeds up the process of batch operations on models.
def FBAudioFmt_TestFormat | ( | ) |
Python Docstring:
FBAudioFmt_TestFormat( (object)arg1, (object)arg2, (object)arg3, (object)arg4) -> bool
C++ Signature:
K_DLLIMPORT bool FBAudioFmt_TestFormat(const FBAudioFmt pSrcFormat, int pChannels, int pBits, int pRate)
def FBGetCharacterFloorContactsVisibility | ( | ) |
Python Docstring:
FBGetCharacterFloorContactsVisibility() -> bool
C++ Signature:
K_DLLIMPORT bool FBGetCharacterFloorContactsVisibility()
Queries visibility of the floor contacts of the current character.
def FBGetRenderingTaskCycle | ( | ) |
Python Docstring:
FBGetRenderingTaskCycle() -> FBProfileTaskCycle
C++ Signature:
K_DLLIMPORT FBProfileTaskCycle * FBGetRenderingTaskCycle()
Get rendering task cycle.
def FBGetEvaluationTaskCycle | ( | ) |
Python Docstring:
FBGetEvaluationTaskCycle() -> FBProfileTaskCycle
C++ Signature:
K_DLLIMPORT FBProfileTaskCycle * FBGetEvaluationTaskCycle()
Get evaluation task cycle.
def FBGetDisplayInfo | ( | ) |
Python Docstring:
FBGetDisplayInfo() -> FBEvaluateInfo
C++ Signature:
K_DLLIMPORT FBEvaluateInfo * FBGetDisplayInfo()
Get the displays evaluation information structure. This function can be used in order to call real-time functions based on the current display evalution state.
def FBMatrixInverse | ( | ) |
Python Docstring:
FBMatrixInverse( (FBMatrix)arg1, (FBMatrix)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixInverse(FBMatrix & pMatrix, const FBMatrix & pSrc)
Invert a matrix.
pMatrix | Calculated inverse matrix. |
pSrc | Source matrix to invert. |
def FBTRSToMatrix | ( | ) |
Python Docstring:
FBTRSToMatrix( (FBMatrix)arg1, (FBVector4d)arg2, (FBVector3d)arg3, (FBSVector)arg4) -> None
C++ Signature:
K_DLLIMPORT void FBTRSToMatrix(FBMatrix & pMatrix, const FBVector4 & pTVector, const FBVector3 & pRVector, const FBSVector & pSVector)
Convert translation, rotation, and scaling vectors to a matrix.
pMatrix | Calculated resulting matrix. |
pTVector | Translation vector. |
pRVector | Rotation vector. |
pSVector | Scaling vector. |
def FBMatrixToScaling | ( | ) |
Python Docstring:
FBMatrixToScaling( (FBSVector)arg1, (FBMatrix)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixToScaling(FBSVector & pVector, const FBMatrix & pMatrix)
Obtain scaling vector from a matrix.
pVector | Extracted scaling vector. |
pMatrix | Input matrix. |
def FBMatrixToTRS | ( | ) |
Python Docstring:
FBMatrixToTRS( (FBVector4d)arg1, (FBVector3d)arg2, (FBSVector)arg3, (FBMatrix)arg4) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixToTRS(FBVector4 & pTVector, FBVector3 & pRVector, FBSVector & pSVector, const FBMatrix & pMatrix)
Obtain translation, rotation, and scaling vectors from a matrix.
pTVector | Extracted translation vector. |
pRVector | Extracted rotation vector. |
pSVector | Extracted scaling vector. |
pMatrix | Input matrix. |
def FBQuaternionToRotation | ( | ) |
Python Docstring:
FBQuaternionToRotation( (FBVector3d)arg1, (FBVector4d)arg2 [, (FBRotationOrder)arg3]) -> None
C++ Signature:
K_DLLIMPORT void FBQuaternionToRotation(FBVector3 & pVector, const FBQuaternion & pQuaternion, FBRotationOrder pRotationOrder = kFBXYZ)
Get a rotation vector from a quaternion vector.
pVector | Calculated rotation vector. |
pQuaternion | Input quaternion. |
pRotationOrder | Rotation order of the rotation vector. |
def FBGetGlobalMatrix | ( | ) |
Python Docstring:
FBGetGlobalMatrix( (FBMatrix)arg1, (FBMatrix)arg2, (FBMatrix)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBGetGlobalMatrix(FBMatrix & pMatrix, const FBMatrix & pMatrixParent, const 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).
pMatrix | Calculated local matrix. |
pMatrixParent | Parent matrix. |
pLocalMatrix | Local matrix. |
def FBQAdd | ( | ) |
Python Docstring:
FBQAdd( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBQAdd(FBQuaternion & pResult, const FBQuaternion & pQ1, const FBQuaternion & pQ2)
Add two quaternions together (pResult = pQ1+pQ2)
pResult | Resulting quaternion. |
pQ1 | 1st quaternion. |
pQ2 | 2nd quaternion. |
def FBMult | ( | ) |
Python Docstring:
FBMult( (FBVector4d)arg1, (FBVector4d)arg2, (object)arg3) -> None FBMult( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3) -> None FBMult( (FBMatrix)arg1, (FBMatrix)arg2, (FBSVector)arg3) -> None FBMult( (FBMatrix)arg1, (FBMatrix)arg2, (FBSVector)arg3) -> None
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBGetContinuousRotation | ( | ) |
Python Docstring:
FBGetContinuousRotation( (FBVector3d)arg1, (FBVector3d)arg2, (FBVector3d)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBGetContinuousRotation(FBVector3 & pROut, const FBVector3 & pR0, const FBVector3 & pR1)
Get a continuous rotation in Euler space. This routine will help to avoid gimble locks due to interpolation.
pROut | Successful continuous rotation (gimble-lock free). |
pR0 | Suggested next rotation. |
pR1 | Previous rotation. |
def FBClamp | ( | ) |
Python Docstring:
FBClamp( (object)arg1, (object)arg2, (object)arg3) -> float
C++ Signature:
K_DLLIMPORT double FBClamp(double pV, double pL, double pH)
Clamp value.
pV | Value to clamp. |
pL | Low limit. |
pH | High limit. |
def FBProperty_TypeInfo | ( | ) |
def FBComponent_TypeInfo | ( | ) |
def FBAudioClip_TypeInfo | ( | ) |
def FBPointCacheFile_TypeInfo | ( | ) |
def FBHandle_TypeInfo | ( | ) |
def FBVideoIn_TypeInfo | ( | ) |
def FBTexture_TypeInfo | ( | ) |
def FBMaterial_TypeInfo | ( | ) |
def FBSurface_TypeInfo | ( | ) |
def FBConstraint_TypeInfo | ( | ) |
def FBPhysicalProperties_TypeInfo | ( | ) |
def FBDeviceInstrument_TypeInfo | ( | ) |
def FBOpticalGap_TypeInfo | ( | ) |
def FBRigidBody_TypeInfo | ( | ) |
def FBCharacterPose_TypeInfo | ( | ) |
def FBShaderLighted_TypeInfo | ( | ) |
def FBShaderShadowLive_TypeInfo | ( | ) |
def FBHUD_TypeInfo | ( | ) |
def FBHUDTextElement_TypeInfo | ( | ) |
def FBApplication_TypeInfo | ( | ) |
def FBStoryTrack_TypeInfo | ( | ) |
def FBProfiler_TypeInfo | ( | ) |
def FBAssetItem_TypeInfo | ( | ) |
def FBAssetMng_TypeInfo | ( | ) |
def FBFbxOptions_TypeInfo | ( | ) |
def FBLayout_TypeInfo | ( | ) |
def CloseToolByName | ( | ) |
def FBBrowsingProperty_TypeInfo | ( | ) |
def FBScrollBox_TypeInfo | ( | ) |
def FBSpreadRow_TypeInfo | ( | ) |
def FBTabPanel_TypeInfo | ( | ) |
def FBEditNumber_TypeInfo | ( | ) |
def FBVisualContainer_TypeInfo | ( | ) |
def FBConnect | ( | ) |
Python Docstring:
FBConnect( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool
C++ Signature:
K_DLLIMPORT bool FBConnect(FBPlug * pSrc, FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Request the connection two FBPlug objects.
pSrc | Source plug. |
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. |
def FBDisconnect | ( | ) |
Python Docstring:
FBDisconnect( (FBPlug)arg1, (FBPlug)arg2) -> bool
C++ Signature:
K_DLLIMPORT bool FBDisconnect(FBPlug * pSrc, FBPlug * pDst)
Connect two FBPlug objects.
pSrc | Source plug. |
pDst | Destination plug. |
def FBSleep | ( | ) |
Python Docstring:
FBSleep( (int)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBSleep(kULong MilliSeconds)
Sleep function Puts system to sleep for specified time.
MilliSeconds | Time to sleep for. |
def FBPopNormalTool | ( | ) |
Python Docstring:
FBPopNormalTool( (str)arg1 [, (object)arg2]) -> bool
C++ Signature:
K_DLLIMPORT bool FBPopNormalTool(const char * pToolName, bool pSetFocus = true)
This function is used to bring up a specific tool in the GUI.
pToolName | The name of the tool as shown in the Open Reality menu. |
pSetFocus | Indicate if the tool will have the focus. |
def FBGetSelectedModels | ( | ) |
Python Docstring:
FBGetSelectedModels( (FBModelList)arg1 [, (FBModel)arg2 [, (object)arg3 [, (object)arg4]]]) -> None
C++ Signature:
K_DLLIMPORT void FBGetSelectedModels(FBModelList & pList, FBModel * pParent = NULL, bool pSelected = true, bool pSortBySelectOrder = false)
Find all models that are selected (if pSelected
is
true) Searches recursively from a root model for models that are
selected, and adds them to a list of models.
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 |
def FBCreateObject | ( | ) |
Python Docstring:
FBCreateObject( (str)arg1, (str)arg2, (str)arg3 [, (object)arg4]) -> object
C++ Signature:
K_DLLIMPORT FBComponent * FBCreateObject(const char * pGroupName, const char * pEntryName, const char * pName, void * pData = NULL, int nth = 0)
FBCreateObject.
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. |
def FBFindObjectsByName | ( | ) |
Python Docstring:
FBFindObjectsByName( (str)arg1, (FBComponentList)arg2 [, (object)arg3 [, (object)arg4]]) -> None
C++ Signature:
K_DLLIMPORT void FBFindObjectsByName(const char * pNamePattern, FBArrayTemplate & pList, bool pIncludeNamespace = true, bool pModelsOnly = false)
FBFindObjectsByName. This function will query the system for objects fulfilling a particular name pattern
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 |
def FBDeleteObjectsByName | ( | ) |
Python Docstring:
FBDeleteObjectsByName( (str)arg1 [, (str)arg2 [, (str)arg3]]) -> int
C++ Signature:
K_DLLIMPORT int FBDeleteObjectsByName(const char * pNamePattern, const char * pNameSpace = NULL, const char * pGroupName = NULL)
FBDeleteObjectsByName. This function will query the system for objects fulfilling a particular name pattern and delete them. specify a namespace preferred, delete all objects with the group name without specified a namespace specified may lead to inconsistent in scene. Wrap multiple calls to FBDeleteObjectsByName() inside pair of FBMergeTransactionBegin() / FBMergeTransactionEnd() could improve application's performance.
pNamePattern | if not NULL, indicate the name pattern to search. This pattern can contain any amount of *. (ex: *tr*mod*scene ). if is NULL or Empty string, * will be used for match all. |
pNameSpace | if not NULL, the objects must be inside the given namespace. |
pGroupName | if not NULL, indicate the object group name (type). |
def FBBeginChangeAllModels | ( | ) |
Python Docstring:
FBBeginChangeAllModels() -> None
C++ Signature:
K_DLLIMPORT void FBBeginChangeAllModels()
Call begin change to all models (need to be closed). Useful for selection of many models that can trigger many related callbacks)
def FBEndChangeAllModels | ( | ) |
Python Docstring:
FBEndChangeAllModels() -> None
C++ Signature:
K_DLLIMPORT void FBEndChangeAllModels()
Call end change to all models (should be first open).
def FBMergeTransactionBegin | ( | ) |
Python Docstring:
FBMergeTransactionBegin() -> None
C++ Signature:
K_DLLIMPORT void FBMergeTransactionBegin()
Call to begin the transaction for merging multiple files. Useful to consecutively merge multiple files into scene.
def FBMergeTransactionEnd | ( | ) |
Python Docstring:
FBMergeTransactionEnd() -> None
C++ Signature:
K_DLLIMPORT void FBMergeTransactionEnd()
Call to end the merge transaction.
def FBMergeTransactionIsOn | ( | ) |
Python Docstring:
FBMergeTransactionIsOn() -> bool
C++ Signature:
K_DLLIMPORT bool FBMergeTransactionIsOn()
Call to tell if system is during Merge transaction.
def FBTraceWithLevel | ( | ) |
Python Docstring:
FBTraceWithLevel( (int)arg1, (str)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBTraceWithLevel(unsigned int pLevel, const char * pFormatString, ... )
This function prints useful debugging strings in the console.
pLevel | to control trace output detailed level, valid value range [kFBCRITICAL_TRACE, kFBALL_TRACE] |
pFormatString | A printf-style format string, to use the following arguments in the list. |
Not thread safe, as an static array is used internally.
def FBObjectGetGlobalUniqueId | ( | ) |
Python Docstring:
FBObjectGetGlobalUniqueId() -> int
C++ Signature:
K_DLLIMPORT unsigned int FBObjectGetGlobalUniqueId()
Get the global static object unique ID counter. Each new created object will be assigned this global unique ID. Object.UniqueID = GlobalUniqueID++
def FBObjectLifeLogEnable | ( | ) |
Python Docstring:
FBObjectLifeLogEnable( (object)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBObjectLifeLogEnable(bool pEnable)
Enable object creation / deletion logging. Default logging if off This logging may hurt performance slightly. use it only for debug purpose.
pEnable | true to enable logging. |
def FBObjectGetLivingCount | ( | ) |
Python Docstring:
FBObjectGetLivingCount() -> int
C++ Signature:
K_DLLIMPORT unsigned int FBObjectGetLivingCount()
Get current total living object count.
def FBMessageBox | ( | ) |
Python Docstring:
FBMessageBox( (str)arg1, (str)arg2, (str)arg3 [, (str)arg4 [, (str)arg5 [, (object)arg6 [, (object)arg7]]]]) -> int
C++ Signature:
K_DLLEXPORT int FBMessageBox(const char * pBoxTitle, const char * pMessage, const char * pButton1Str, const char * pButton2Str = NULL, const char * pButton3Str = NULL, 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.
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). |
FBMessageBoxWithCheck | ( | ) |
Python Docstring:
FBMessageBoxWithCheck( (str)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5, (str)arg6, (object)arg7 [, (object)arg8 [, (object)arg9]]) -> tuple
C++ Signature:
K_DLLEXPORT int FBMessageBoxWithCheck(const char * pBoxTitle, const char * pMessage, const char * pButton1Str, const char * pButton2Str, const char * pButton3Str, const char * 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.
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). |
pCheckBoxValue | Check box value. |
pDefaultButton | Indicates the default (pre-selected) button (default is 0). |
pScrolledMessage | Scroll message (default is 0). |
def FBAudioFmt_GetDefaultFormat | ( | ) |
Python Docstring:
FBAudioFmt_GetDefaultFormat() -> int
C++ Signature:
K_DLLIMPORT FBAudioFmt FBAudioFmt_GetDefaultFormat()
def FBAudioFmt_AppendFormat | ( | ) |
Python Docstring:
FBAudioFmt_AppendFormat( (object)arg1, (object)arg2, (object)arg3, (object)arg4) -> int FBAudioFmt_AppendFormat( (object)arg1, (object)arg2) -> int
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBAudioFmt_RemoveFormat | ( | ) |
Python Docstring:
FBAudioFmt_RemoveFormat( (object)arg1, (object)arg2, (object)arg3, (object)arg4) -> int FBAudioFmt_RemoveFormat( (object)arg1, (object)arg2) -> int
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBAudioFmt_GetChannelValue | ( | ) |
Python Docstring:
FBAudioFmt_GetChannelValue( (object)arg1) -> int
C++ Signature:
K_DLLIMPORT int FBAudioFmt_GetChannelValue(FBAudioFmt pFormat)
def FBAudioFmt_GetBitsValue | ( | ) |
Python Docstring:
FBAudioFmt_GetBitsValue( (object)arg1) -> int
C++ Signature:
K_DLLIMPORT int FBAudioFmt_GetBitsValue(FBAudioFmt pFormat)
def FBAudioFmt_GetBytesValue | ( | ) |
Python Docstring:
FBAudioFmt_GetBytesValue( (object)arg1) -> int
C++ Signature:
K_DLLIMPORT int FBAudioFmt_GetBytesValue(FBAudioFmt pFormat)
def FBGetMultiLangText | ( | ) |
Python Docstring:
FBGetMultiLangText( (FBPlug)arg1, (str)arg2 [, (object)arg3]) -> str FBGetMultiLangText( (str)arg1, (str)arg2 [, (object)arg3]) -> str
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBGetCharactersKeyingMode | ( | ) |
Python Docstring:
FBGetCharactersKeyingMode() -> FBCharacterKeyingMode
C++ Signature:
K_DLLIMPORT FBCharacterKeyingMode FBGetCharactersKeyingMode()
return Character Manipulation/Keying Mode
def FBGetCharacterExternalSolverCount | ( | ) |
Python Docstring:
FBGetCharacterExternalSolverCount() -> int
C++ Signature:
K_DLLIMPORT int FBGetCharacterExternalSolverCount()
Get character external solver count.
def FBGetCharacterExternalSolverName | ( | ) |
Python Docstring:
FBGetCharacterExternalSolverName( (object)arg1) -> str
C++ Signature:
K_DLLIMPORT const char * FBGetCharacterExternalSolverName(int pIndex)
Get character external solver name.
pIndex | Index of external solver. |
def FBGetCharacterExternalSolverIndex | ( | ) |
Python Docstring:
FBGetCharacterExternalSolverIndex( (str)arg1) -> int
C++ Signature:
K_DLLIMPORT int FBGetCharacterExternalSolverIndex(const char * pName)
Get character external solver index.
pName | Name of external solver. |
def FBSetCharacterFloorContactsVisibility | ( | ) |
Python Docstring:
FBSetCharacterFloorContactsVisibility( (object)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBSetCharacterFloorContactsVisibility(bool pShow)
Sets visibility of the floor contacts of the current character.
pShow | Specifies if floor contacts of the current character should be visible. |
def FBGetMainThreadTaskCycle | ( | ) |
Python Docstring:
FBGetMainThreadTaskCycle() -> FBProfileTaskCycle
C++ Signature:
K_DLLIMPORT FBProfileTaskCycle * FBGetMainThreadTaskCycle()
Get root task cycle.
def FBMatrixTranspose | ( | ) |
Python Docstring:
FBMatrixTranspose( (FBMatrix)arg1, (FBMatrix)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixTranspose(FBMatrix & pMatrix, const FBMatrix & pSrc)
Transpose a matrix.
pMatrix | Calculated transpose matrix. |
pSrc | Source matrix to transpose. |
def FBVectorMatrixMult | ( | ) |
Python Docstring:
FBVectorMatrixMult( (FBVector4d)arg1, (FBMatrix)arg2, (FBVector4d)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBVectorMatrixMult(FBVector4d & pOutVector, const FBMatrix & pMatrix, const FBVector4d & pVector)
Multiply a vector by a matrix.
pOutVector | Resulting vector. |
pMatrix | Matrix to affect the vector with. |
pVector | Source vector. |
def FBRotationToMatrix | ( | ) |
Python Docstring:
FBRotationToMatrix( (FBMatrix)arg1, (FBVector3d)arg2 [, (FBRotationOrder)arg3]) -> None
C++ Signature:
K_DLLIMPORT void FBRotationToMatrix(FBMatrix & pMatrix, const FBVector3 & pVector, FBRotationOrder pRotationOrder = kFBXYZ)
Convert a rotation vector to a matrix.
pMatrix | Calculated resulting matrix. |
pVector | Rotation vector. |
pRotationOrder | Rotation order |
def FBScalingToMatrix | ( | ) |
Python Docstring:
FBScalingToMatrix( (FBMatrix)arg1, (FBSVector)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBScalingToMatrix(FBMatrix & pMatrix, const FBSVector & pVector)
Convert a scaling vector to a matrix.
pMatrix | Calculated resulting matrix. |
pVector | Scaling vector. |
def FBMatrixToRotation | ( | ) |
Python Docstring:
FBMatrixToRotation( (FBVector3d)arg1, (FBMatrix)arg2 [, (FBRotationOrder)arg3]) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixToRotation(FBVector3 & pVector, const FBMatrix & pMatrix, FBRotationOrder pRotationOrder = kFBXYZ)
Obtain rotation vector from a matrix.
pVector | Extracted rotation vector. |
pMatrix | Input matrix. |
pRotationOrder | Rotation Order. |
def FBQuaternionToMatrix | ( | ) |
Python Docstring:
FBQuaternionToMatrix( (FBMatrix)arg1, (FBVector4d)arg2) -> None
C++ Signature:
K_DLLIMPORT void FBQuaternionToMatrix(FBMatrix & pMatrix, const FBQuaternion & pQuaternion)
Get a rotation matrix from a quaternion vector.
pMatrix | Calculated rotation matrix. |
pQuaternion | Input quaternion. |
def FBGetLocalMatrix | ( | ) |
Python Docstring:
FBGetLocalMatrix( (FBMatrix)arg1, (FBMatrix)arg2, (FBMatrix)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBGetLocalMatrix(FBMatrix & pMatrix, const FBMatrix & pMatrixParent, const 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.
pMatrix | Calculated local matrix. |
pMatrixParent | Parent matrix (new base referential). |
pMatrixChild | Child matrix. |
def FBMatrixOrthogonalize | ( | ) |
Python Docstring:
FBMatrixOrthogonalize( (FBMatrix)arg1) -> None
C++ Signature:
K_DLLIMPORT void FBMatrixOrthogonalize(FBMatrix & pMatrix)
Make sure that rotation vectors are orthogonal and normalized (fast way for removing scaling from matrix)
pMatrix | Orthogonalized matrix. |
pMatrix | Rotation Matrix to Orthogonalize. |
def FBSub | ( | ) |
Python Docstring:
FBSub( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3) -> None
C++ Signature:
K_DLLIMPORT void FBSub(FBVector4 & pResult, const FBVector4 & pV1, const FBVector4 & pV2)
Subtract pV2 from pV1 (pResult = pV1-pV2)
pResult | Resulting vector. |
pV1 | 1st vector. |
pV2 | 2nd vector. |
def FBDot | ( | ) |
Python Docstring:
FBDot( (FBVector4d)arg1, (FBVector4d)arg2) -> float
C++ Signature:
K_DLLIMPORT double FBDot(const FBVector4 & pV1, const FBVector4 & pV2)
Calculate the dot product of two vectors.
pV1 | 1st vector. |
pV2 | 2nd vector. |
def FBQMult | ( | ) |
Python Docstring:
FBQMult( (FBVector4d)arg1, (FBVector4d)arg2, (object)arg3) -> None FBQMult( (FBVector4d)arg1, (FBVector4d)arg2, (FBVector4d)arg3) -> None
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBQDot | ( | ) |
Python Docstring:
FBQDot( (FBVector4d)arg1, (FBVector4d)arg2) -> float
C++ Signature:
K_DLLIMPORT double FBQDot(const FBQuaternion & pQ1, const FBQuaternion & pQ2)
Calculate the dot product of two quaternions.
pQ1 | 1st quaternion. |
pQ2 | 2nd quaternion. |
def FBQLength | ( | ) |
Python Docstring:
FBQLength( (FBVector4d)arg1) -> float
C++ Signature:
K_DLLIMPORT double FBQLength(const FBQuaternion & pQ)
Get the length of a quaternion.
pQ | Quaternion to calculate length for. |
def FBLength | ( | ) |
Python Docstring:
FBLength( (FBVector4d)arg1) -> float FBLength( (FBVertex)arg1) -> float
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def FBPlug_TypeInfo | ( | ) |
def FBAudioIn_TypeInfo | ( | ) |
def FBAudioOut_TypeInfo | ( | ) |
def FBMotionClip_TypeInfo | ( | ) |
def FBVideoGrabber_TypeInfo | ( | ) |
def FBBox_TypeInfo | ( | ) |
def FBDeck_TypeInfo | ( | ) |
def FBFCurve_TypeInfo | ( | ) |
def FBDeformerPointCache_TypeInfo | ( | ) |
def FBPointCacheManager_TypeInfo | ( | ) |
def FBFileMonitoringManager_TypeInfo | ( | ) |
def FBReferenceTime_TypeInfo | ( | ) |
def FBPlayerControl_TypeInfo | ( | ) |
def FBEvaluateManager_TypeInfo | ( | ) |
def FBKeyControl_TypeInfo | ( | ) |
def FBBoxPlaceHolder_TypeInfo | ( | ) |
def FBNote_TypeInfo | ( | ) |
def FBVideo_TypeInfo | ( | ) |
def FBVideoMemory_TypeInfo | ( | ) |
def FBVideoClip_TypeInfo | ( | ) |
def FBVideoClipImage_TypeInfo | ( | ) |
def FBLayeredTexture_TypeInfo | ( | ) |
def FBModelPlaceHolder_TypeInfo | ( | ) |
def FBGeometry_TypeInfo | ( | ) |
def FBPose_TypeInfo | ( | ) |
def FBMesh_TypeInfo | ( | ) |
def FBNurbs_TypeInfo | ( | ) |
def FBPatch_TypeInfo | ( | ) |
def FBModelTemplate_TypeInfo | ( | ) |
def FBConstraintRelation_TypeInfo | ( | ) |
def FBConstraintSolver_TypeInfo | ( | ) |
def FBConstraintManager_TypeInfo | ( | ) |
def FBDevice_TypeInfo | ( | ) |
def FBFilter_TypeInfo | ( | ) |
def FBCluster_TypeInfo | ( | ) |
def FBModelPlane_TypeInfo | ( | ) |
def FBModelPath3D_TypeInfo | ( | ) |
def FBOpticalSegment_TypeInfo | ( | ) |
def FBDeviceOptical_TypeInfo | ( | ) |
def FBDeviceOpticalMarker_TypeInfo | ( | ) |
def FBModelOpticalAdvanced_TypeInfo | ( | ) |
def FBCharacterMarkerSet_TypeInfo | ( | ) |
def FBKeyingGroup_TypeInfo | ( | ) |
def FBCharacterSolver_TypeInfo | ( | ) |
def FBCharacterFace_TypeInfo | ( | ) |
def FBModelCube_TypeInfo | ( | ) |
def FBCameraStereo_TypeInfo | ( | ) |
def FBCameraSwitcher_TypeInfo | ( | ) |
def FBLight_TypeInfo | ( | ) |
def FBShader_TypeInfo | ( | ) |
def FBGroup_TypeInfo | ( | ) |
def FBNamespace_TypeInfo | ( | ) |
def FBFileReference_TypeInfo | ( | ) |
def FBScene_TypeInfo | ( | ) |
def FBHUDRectElement_TypeInfo | ( | ) |
def FBHUDBloopSlateElement_TypeInfo | ( | ) |
def FBHUDTimelineElement_TypeInfo | ( | ) |
def FBRendererCallback_TypeInfo | ( | ) |
def FBRenderer_TypeInfo | ( | ) |
def FBStoryFolder_TypeInfo | ( | ) |
def FBStoryClip_TypeInfo | ( | ) |
def FBStory_TypeInfo | ( | ) |
def FBAssetFolder_TypeInfo | ( | ) |
def FBLogger_TypeInfo | ( | ) |
def FBSystem_TypeInfo | ( | ) |
def FBActionManager_TypeInfo | ( | ) |
def FBProgress_TypeInfo | ( | ) |
def FBFolder_TypeInfo | ( | ) |
def FBObjectPose_TypeInfo | ( | ) |
def FBImage_TypeInfo | ( | ) |
def FBVisualComponent_TypeInfo | ( | ) |
def _DestroyToolByName | ( | ) |
def _DestroyTool | ( | ) |
def ShowToolByName | ( | ) |
def FBTool_TypeInfo | ( | ) |
def FBButton_TypeInfo | ( | ) |
def FBArrowButton_TypeInfo | ( | ) |
def FBLabel_TypeInfo | ( | ) |
def FBGenericMenu_TypeInfo | ( | ) |
def FBMenuManager_TypeInfo | ( | ) |
def FBSpread_TypeInfo | ( | ) |
def FBSpreadPart_TypeInfo | ( | ) |
def FBSpreadCell_TypeInfo | ( | ) |
def FBSpreadColumn_TypeInfo | ( | ) |
def FBThermometer_TypeInfo | ( | ) |
def FBLayoutRegion_TypeInfo | ( | ) |
def FBImageContainer_TypeInfo | ( | ) |
def FBEdit_TypeInfo | ( | ) |
def FBEditVector_TypeInfo | ( | ) |
def FBList_TypeInfo | ( | ) |
def FBTree_TypeInfo | ( | ) |
def FBTreeNode_TypeInfo | ( | ) |
def FBView_TypeInfo | ( | ) |
def FBEditPropertyModern_TypeInfo | ( | ) |
def FBMemo_TypeInfo | ( | ) |
def FBFCurveEditor_TypeInfo | ( | ) |
def FBEditTimeCode_TypeInfo | ( | ) |
def FBPopup_TypeInfo | ( | ) |
def FBPlotPopup_TypeInfo | ( | ) |
def FBWebView_TypeInfo | ( | ) |
def FBWidgetHolder_TypeInfo | ( | ) |
def FBAnimationLayer_TypeInfo | ( | ) |
def FBManipulator_TypeInfo | ( | ) |