FBApplication Class Reference

#include <mobu-python-api.h>

Class Description

FBApplication is used mainly to manage files.

It provides functionality like that in the MotionBuilder file menu, for example, open file, save file. Note that event registration is instanced-based. When an FBApplication object is destroyed, all the event callbacks are unregistered. If you want to have a tool to be notified of events, it needs to have a FBApplication data member.

See the C++ reference

Inheritance diagram for FBApplication:

Public Member Functions
	__reduce__ ()
bool	ExecuteScript (FBApplication arg1, str arg2)
	Execute a python script file. More...
	__init__ (object arg1)
	Constructor. More...
FBBatchStatus	FileBatch (FBApplication arg1, FBBatchOptions arg2, FBPlotOptions arg3)
	Start a batch. More...
	FileExit (FBApplication arg1, object arg2)
	Quit application. More...
bool	FileExport (FBApplication arg1, str arg2)
	Export a motion file. More...
bool	FileImport (FBApplication arg1, str arg2, object arg3, object arg4)
	Import a motion file. More...
bool	FileImportWithOptions (FBApplication arg1, FBMotionFileOptions arg2)
	Import a motion file with the ability to specify options. More...
bool	SaveCharacterRigAndAnimation (FBApplication arg1, str arg2, FBCharacter arg3, FBFbxOptions arg4)
	Save the rig and its animation in a file. More...
bool	LoadAnimationOnCharacter (FBApplication arg1, str arg2, FBCharacter arg3, FBFbxOptions arg4, FBPlotOptions arg5)
	Load a rig and its animation from a file. More...
bool	OneClickSendAsNewScene (FBApplication arg1, FBOneClickApplication arg2)
	Send the current scene as a new scene in the specified application. More...
bool	OneClickUpdateCurrentScene (FBApplication arg1)
	Send the scene to update the current scene in the specified application. More...
bool	OneClickAddToCurrentScene (FBApplication arg1)
	Send the scene and add it to the current scene in the specified application. More...
	OneClickSelectPreviouslySentObject (FBApplication arg1)
	Select, in MotionBuilder, the object that were sent. More...
FBOneClickApplication	OneClickIsConnectedTo (FBApplication arg1)
	Return the other application that MotionBuilder is connected to. More...
bool	FileExportBatch (FBApplication arg1, str arg2, FBTake arg3, FBBatchOptions arg4, FBModelList arg5)
	Export a motion file using batch options. More...
bool	FileImportBatch (FBApplication arg1, str arg2, FBBatchOptions arg3, FBModel arg4)
	Import a motion file using batch options. More...
bool	IsValidBatchFile (FBApplication arg1, str arg2)
	Verify motion file readability. More...
bool	FileAppend (FBApplication arg1, str arg2, object arg3, FBFbxOptions arg4)
	Append one or multiple files to the current scene. More...
	FileMerge (...)
bool	FileNew (FBApplication arg1)
	Command FILE->NEW in the menus. More...
	FileOpen (...)
object	GetMaxFrameCount (FBApplication arg1, object arg2, int arg3, object arg4)
	Get max frame count from a scene file in memory. More...
bool	FileRender (FBApplication arg1, FBVideoGrabOptions arg2)
	Render current scene to media file. More...
bool	AudioRender (FBApplication arg1, FBAudioRenderOptions arg2)
	Render audio of current scene to media file, currently WAV file only. More...
bool	FileSave (FBApplication arg1, str arg2, FBFbxOptions arg3)
	Save the file under another name. More...
bool	Maximize (FBApplication arg1)
	Maximize window (minimized). More...
bool	Minimize (FBApplication arg1, object arg2)
	Minimize window. More...
	UpdateAllWidgets (FBApplication arg1)
	Request to refresh display of all UI widgets. More...
	FlushEventQueue (FBApplication arg1)
	Flush event queue. More...
	SwitchViewerCamera (FBApplication arg1, FBCamera arg2)
	Switch the current viewer's camera. More...
str	GetSceneTitle (FBApplication arg1)
	Return the scene title from the scene properties. More...
	SetSceneTitle (FBApplication arg1, str arg2)
	Set the scene title. More...
str	GetSceneSubject (FBApplication arg1)
	Return the scene subject from the scene properties. More...
	SetSceneSubject (FBApplication arg1, str arg2)
	Set the scene subject. More...
str	GetSceneAuthor (FBApplication arg1)
	Return the scene author from the scene properties. More...
	SetSceneAuthor (FBApplication arg1, str arg2)
	Set the scene author. More...
str	GetSceneKeywords (FBApplication arg1)
	Return the scene keywords from the scene properties. More...
	SetSceneKeywords (FBApplication arg1, str arg2)
	Set the scene keywords. More...
str	GetSceneRevisionNumber (FBApplication arg1)
	Return the scene revision number from the scene properties. More...
	SetSceneRevisionNumber (FBApplication arg1, str arg2)
	Set the scene revision number. More...
str	GetSceneComment (FBApplication arg1)
	Return the scene comment from the scene properties. More...
	SetSceneComment (FBApplication arg1, str arg2)
	Set the scene comment. More...
Public Member Functions inherited from FBComponent
	__reduce__ ()
FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...
str	ClassName (FBComponent arg1)
	Get the class name. More...
	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...
	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...
bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...
	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...
	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...
FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...
bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...
bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...
bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...
bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...
bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...
int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...
bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...
object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...
	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...
	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...
	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...
	HardSelect (FBComponent arg1)
	HardSelect. More...
object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...
	__init__ (...)
	Constructor. More...
Public Member Functions inherited from FBPlug
	__reduce__ ()
bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...
str	ClassName (FBPlug arg1)
	internal System vars. More...
bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...
bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...
bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...
bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...
	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...
	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...
bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...
bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...
bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...
bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...
	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...
object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...
int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...
FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...
object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...
int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...
object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...
object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...
int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...
FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...
bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...
bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...
	MoveSrcAt (...)
bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...
bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...
bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...
	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...
bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...
	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...
bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...
int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...
bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...
	__init__ (...)
method	staticmethod (function)
Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()
	__init__ (...)

Public Attributes
FBPropertyActor	CurrentActor
	Read Write Property: Indicate the current actor, as used by the character tool. More...
FBPropertyCharacter	CurrentCharacter
	Read Write Property: Indicate the current character, as used by the character tool. More...
ORSDK2018::FBPropertyString	FBXFileName
	Read Write Property: Current scene filename. More...
ORSDK2018::FBPropertyEvent	OnFileNewCompleted
	Event: A File New has been completed. More...
ORSDK2018::FBPropertyEvent	OnFileNew
	Event: A File New has been requested, nothing has been destroyed yet. More...
ORSDK2018::FBPropertyEvent	OnFileOpenCompleted
	Event: A File Open has been completed. More...
ORSDK2018::FBPropertyEvent	OnFileOpen
	Event: A File Open has been requested, nothing has been loaded yet. More...
ORSDK2018::FBPropertyEvent	OnFileSaveCompleted
	Event: A File Save has been completed. More...
ORSDK2018::FBPropertyEvent	OnFileSave
	Event: A File Save has been requested, nothing has been saved yet. More...
ORSDK2018::FBPropertyEvent	OnFileExit
	Event: A File Exit as been requested, nothing has been destroyed yet. More...
ORSDK2018::FBPropertyEvent	OnFileMerge
	Event: A File Merge has been requested, nothing has been loaded yet. More...
object	OnOverrideFileOpen
Public Attributes inherited from FBComponent
object	OwnerNamespace
ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...
ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...
ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...
object	FullName
ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...
ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...
FBPropertyBool	Selected
	Read Write Property: Selected property. More...
Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__

(

object

arg1

)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBApplication(HIObject pObject = ((void *) 0)) 

Parameters

pObject

Internal parent object(default=NULL).

See the C++ reference

__reduce__

(

)

bool AudioRender	(	FBApplication	arg1,
		FBAudioRenderOptions	arg2
	)

Render audio of current scene to media file, currently WAV file only.

Python Docstring:

AudioRender( (FBApplication)arg1 [, (FBAudioRenderOptions)arg2]) -> bool 

C++ Signature:

bool AudioRender(ORSDK2018::FBAudioRenderOptions * pAudioRenderOptions = ((void *) 0)) 

Parameters

pAudioRenderOptions

The options used when rendering audio of the scene. Default value: 2 channels, 16 bits, 44100 hz, the begin and end time span for current time referential, Default file name is "Output.wav" in the last audio output path, ro the default document path if the last path doesn't exist.

Returns

True if the file was rendered successfully

Warning

If the destination media file exist, it will be overwritten by default. If the destination media file is opened by other application, the audio render process may not success because of not able to open it.

See the C++ reference

bool ExecuteScript	(	FBApplication	arg1,
		str	arg2
	)

Execute a python script file.

Python Docstring:

ExecuteScript( (FBApplication)arg1, (str)arg2) -> bool 

C++ Signature:

bool ExecuteScript(ORSDK2018::FBString pFilename) 

Parameters

pFilename

The script file to execute.

Returns

True if the script file was found and executed.

Remarks

This function can only be used in the UI thread.

See the C++ reference

bool FileAppend	(	FBApplication	arg1,
		str	arg2,
		object	arg3,
		FBFbxOptions	arg4
	)

Append one or multiple files to the current scene.

Python Docstring:

FileAppend( (FBApplication)arg1, (str)arg2 [, (object)arg3 [, (FBFbxOptions)arg4]]) -> bool 

C++ Signature:

bool FileAppend(const char * pFilename, bool pShowUIMsg = false, ORSDK2018::FBFbxOptions * pOptions = ((void *) 0)) 

Same as File->Merge in the menus with all options set to append. In earlier versions of MotionBuilder, a namespace could be specified with a parameter in this function, or FBFbxOptions::CustomImportNamespace, Now this is now done with FBFbxOptions::NamespaceList.

Parameters

pFilename	File(s) to merge. For multiple files, use a list of files separated by '~'.
pShowUIMsg	Set false if don't want to popup any UI dialog or messages (default=false).
pOptions	Provide finer control on file open options (default=NULL). if not null, Option dialog will only show if both option's ShowOptionsDialog property and pShowUIMsg are true. It is possible to append multiple scenes, each one within its own user specified namespace, by calling the FBFbxOptions::SetMultiLoadNamespaceList method first. When doing so though, the FBFbxOption.NamespaceList property is then ignored.

Returns

true if successful.

See the C++ reference

FBBatchStatus FileBatch	(	FBApplication	arg1,
		FBBatchOptions	arg2,
		FBPlotOptions	arg3
	)

Start a batch.

Python Docstring:

FileBatch( (FBApplication)arg1, (FBBatchOptions)arg2 [, (FBPlotOptions)arg3]) -> FBBatchStatus 

C++ Signature:

FBBatchStatus FileBatch(ORSDK2018::FBBatchOptions * pBatchOptions, ORSDK2018::FBPlotOptions * pPlotOptions = ((void *) 0)) 

Command File->Batch... in the menus.

Parameters

pBatchOptions	The options for the batch process (same as in the batch UI).
pPlotOptions	The options for plotting (same as in the plot UI)(default=NULL).

Returns

The status of the operation.

See the C++ reference

FileExit	(	FBApplication	arg1,
		object	arg2
	)

Quit application.

Python Docstring:

FileExit( (FBApplication)arg1 [, (object)arg2]) -> None 

C++ Signature:

void FileExit(bool pSave = false) 

Command File->Exit in the menus.

Parameters

pSave

true if file is saved on exit(default=false).

See the C++ reference

bool FileExport	(	FBApplication	arg1,
		str	arg2
	)

Export a motion file.

Python Docstring:

FileExport( (FBApplication)arg1, (str)arg2) -> bool 

C++ Signature:

bool FileExport(ORSDK2018::FBString pFilename) 

Command File->Motion File Export... in the menus.

Parameters

pFilename

The file to create. To create two files at the same time (ex: .amc & .asf), separate the two files path with a comma ("Path1,Path2").

Returns

True if the export succeeded.

Remarks

If the file exists, it will be overwritten.

current take is use.

The last parameter is only used for motion files.

For now, you cannot export custom file types.

Currently, only the default export options are used.

Warning

The signature of this function might change in the future to support export options.

See the C++ reference

bool FileExportBatch	(	FBApplication	arg1,
		str	arg2,
		FBTake	arg3,
		FBBatchOptions	arg4,
		FBModelList	arg5
	)

Export a motion file using batch options.

Python Docstring:

FileExportBatch( (FBApplication)arg1, (str)arg2, (FBTake)arg3, (FBBatchOptions)arg4, (FBModelList)arg5) -> bool 

C++ Signature:

bool FileExportBatch(const char * pName, ORSDK2018::FBTake * pTake, ORSDK2018::FBBatchOptions * pBatchOptions, FBModelList & pExportModels) 

Export used for saving files in batch process.

Parameters

pName	The name of the file without extension. Extension and path will be taken from batch options.
pTake	Animation take to the export.
pBatchOptions	The options for the export.
pExportModels	Models to the export.

Returns

True if the export succeeded.

Remarks

Not all options have to be set, only those that belong to process.

See the C++ reference

bool FileImport	(	FBApplication	arg1,
		str	arg2,
		object	arg3,
		object	arg4
	)

Import a motion file.

Python Docstring:

FileImport( (FBApplication)arg1, (str)arg2 [, (object)arg3 [, (object)arg4]]) -> bool 

C++ Signature:

bool FileImport(ORSDK2018::FBString pFilename, bool pMatchModels = false, bool pCreateUnmatchedModels = true) 

Command File->Motion File Import... in the menus.

Parameters

pFilename	The file to import. To import two files at the same time (ex: .amc & .asf), separate the two files path with a comma ("Path1,Path2").
pMatchModels	If there is already a model in the scene with the same name, the model will not be created and we replace the animation of the given model.
pCreateUnmatchedModels	Whether unmatched models will be created. This flag matters only when pMatchModels is true. when pMatchModels is false, all the models are created.

Returns

True if the import succeeded.

Remarks

No models selected, all the models in the scene will be checked for a potential name match.

If there are models selected in the scene, only these models will be checked for a potential name match.

If only one model is selected (ex: hips), this models and its hierarchy will be used.

The data will be imported in the current take.

The last two parameter are only used for motion files.

For now, you cannot import custom file types.

Currently, only the default import options are used.

Warning

The signature of this function might change in the future to support import options.

See the C++ reference

bool FileImportBatch	(	FBApplication	arg1,
		str	arg2,
		FBBatchOptions	arg3,
		FBModel	arg4
	)

Import a motion file using batch options.

Python Docstring:

FileImportBatch( (FBApplication)arg1, (str)arg2, (FBBatchOptions)arg3, (FBModel)arg4) -> bool 

C++ Signature:

bool FileImportBatch(const char * pName, ORSDK2018::FBBatchOptions * pBatchOptions, ORSDK2018::FBModel * pReference) 

Import used for loading files in batch process.

Parameters

pName	The name of the file without extension. Extension and path will be taken from batch options.
pBatchOptions	The options for the import.
pReference	Reference model for the import.

Returns

True if the import succeeded.

Remarks

Not all options have to be set, only those that belong to process.

See the C++ reference

bool FileImportWithOptions	(	FBApplication	arg1,
		FBMotionFileOptions	arg2
	)

Import a motion file with the ability to specify options.

Python Docstring:

FileImportWithOptions( (FBApplication)arg1, (FBMotionFileOptions)arg2) -> bool 

C++ Signature:

bool FileImportWithOptions(ORSDK2018::FBMotionFileOptions * pOptions) 

Command File->Motion File Import... in the menus.

Parameters

pOptions

A FBMotionFileOptions object that contains the path to the files, as well as the options to load those motion files.

Returns

True if the import succeeded.

Remarks

The import will only work if you open files of the same type.

For now, you cannot import custom file types.

Not all options can be applied to a particular motion file type, please use the Motion File Import UI as a reference.

See the C++ reference

FileMerge

(

...

)

Python Docstring:

FileMerge( (FBApplication)arg1, (str)arg2 [, (object)arg3 [, (FBFbxOptions)arg4]]) -> bool

FileMerge( (FBApplication)arg1, (FBStringList)arg2 [, (object)arg3 [, (FBFbxOptions)arg4]]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool FileMerge(const char * pFilename, bool pShowUIMsg = false, ORSDK2018::FBFbxOptions * pOptions = ((void *) 0))
bool FileMerge(ORSDK2018::FBStringList & pPathlist, bool pShowUIMsg = false, ORSDK2018::FBFbxOptions * pOptions = ((void *) 0))

bool FileNew

(

FBApplication

arg1

)

Command FILE->NEW in the menus.

Python Docstring:

FileNew( (FBApplication)arg1) -> bool 

C++ Signature:

bool FileNew(bool pAskUser = false, bool pClearSceneName = true) 

Parameters

pAskUser	Set to true to cause a save dialog to popup. Default is false.
pClearSceneName	Set to true to clear the scene name, set to false to retain it. Default is true.

Returns

true if successful.

See the C++ reference

FileOpen

(

...

)

Python Docstring:

FileOpen( (FBApplication)arg1, (str)arg2 [, (object)arg3 [, (FBFbxOptions)arg4]]) -> bool

FileOpen( (FBApplication)arg1, (object)arg2, (int)arg3) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool FileOpen(const char * pFilename, bool pShowUIMsg = false, ORSDK2018::FBFbxOptions * pOptions = ((void *) 0))
bool FileOpen(void * pBuffer, kULong pBufferLength)

bool FileRender	(	FBApplication	arg1,
		FBVideoGrabOptions	arg2
	)

Render current scene to media file.

Python Docstring:

FileRender( (FBApplication)arg1 [, (FBVideoGrabOptions)arg2]) -> bool 

C++ Signature:

bool FileRender(ORSDK2018::FBVideoGrabOptions * pRenderOptions = ((void *) 0)) 

Command FILE->RENDER in the menus.

Parameters

pRenderOptions

The options used when rendering the scene. If you don't specify them, current one are used.

Returns

True if the file was rendered successfully otherwise False and FBVideoGrabber.GetLastErrorMsg() contains the description of the error.

Remarks

Render options can be changed if they are not valid.

Warning

If the destination media file exist, it will be overwritten by default.

See the C++ reference

bool FileSave	(	FBApplication	arg1,
		str	arg2,
		FBFbxOptions	arg3
	)

Save the file under another name.

Python Docstring:

FileSave( (FBApplication)arg1 [, (str)arg2 [, (FBFbxOptions)arg3]]) -> bool 

C++ Signature:

bool FileSave(const char * pFilename = ((void *) 0), ORSDK2018::FBFbxOptions * pOptions = ((void *) 0)) 

Command File->SaveAs in the menus.

Parameters

pFilename	Save file as pFilename. A value of NULL will use the current file name.
pOptions	Provide finer control on file save options (default=NULL)

Returns

true if successful.

See the C++ reference

FlushEventQueue

(

FBApplication

arg1

)

Flush event queue.

Python Docstring:

FlushEventQueue( (FBApplication)arg1) -> None 

C++ Signature:

void FlushEventQueue() 

Processes all pending events for the calling thread until there are no more events to process. You can call this function occasionally when your code is busy performing a long operation (e.g. copying a file).

See the C++ reference

object GetMaxFrameCount	(	FBApplication	arg1,
		object	arg2,
		int	arg3,
		object	arg4
	)

Get max frame count from a scene file in memory.

Python Docstring:

GetMaxFrameCount( (FBApplication)arg1, (object)arg2, (int)arg3, (object)arg4) -> object 

C++ Signature:

bool GetMaxFrameCount(void * pBuffer, kULong pBufferLength, kLong * pFrameCount, int pTimeScale) 

Warning

this is advanced & not supported function, use with caution.

Parameters

pBuffer	the memory buffer for the file. Raw memory address is expected in pyfbsdk.
pBufferLength	the memory buffer size.
pFrameCount	out parameter to hold max frame count. this parameter is not needed in pyfbsdk.
pTimeScale	Time scale.

Returns

true if file opened successfully. In pyfbsdk, a tuple (bool, kLong) will return instead, the first one is ORSDK function return value, the second is for max frame count.

See the C++ reference

str GetSceneAuthor

(

FBApplication

arg1

)

Return the scene author from the scene properties.

Python Docstring:

GetSceneAuthor( (FBApplication)arg1) -> str 

C++ Signature:

const char * GetSceneAuthor() 

See the C++ reference

str GetSceneComment

(

FBApplication

arg1

)

Return the scene comment from the scene properties.

Python Docstring:

GetSceneComment( (FBApplication)arg1) -> str 

C++ Signature:

const char * GetSceneComment() 

See the C++ reference

str GetSceneKeywords

(

FBApplication

arg1

)

Return the scene keywords from the scene properties.

Python Docstring:

GetSceneKeywords( (FBApplication)arg1) -> str 

C++ Signature:

const char * GetSceneKeywords() 

See the C++ reference

str GetSceneRevisionNumber

(

FBApplication

arg1

)

Return the scene revision number from the scene properties.

Python Docstring:

GetSceneRevisionNumber( (FBApplication)arg1) -> str 

C++ Signature:

const char * GetSceneRevisionNumber() 

See the C++ reference

str GetSceneSubject

(

FBApplication

arg1

)

Return the scene subject from the scene properties.

Python Docstring:

GetSceneSubject( (FBApplication)arg1) -> str 

C++ Signature:

const char * GetSceneSubject() 

See the C++ reference

str GetSceneTitle

(

FBApplication

arg1

)

Return the scene title from the scene properties.

Python Docstring:

GetSceneTitle( (FBApplication)arg1) -> str 

C++ Signature:

const char * GetSceneTitle() 

See the C++ reference

bool IsValidBatchFile	(	FBApplication	arg1,
		str	arg2
	)

Verify motion file readability.

Python Docstring:

IsValidBatchFile( (FBApplication)arg1, (str)arg2) -> bool 

C++ Signature:

bool IsValidBatchFile(const char * pFilename) 

Parameters

pFilename

The file to test.

Returns

True if file was opened successfully (file is closed at the end).

See the C++ reference

bool LoadAnimationOnCharacter	(	FBApplication	arg1,
		str	arg2,
		FBCharacter	arg3,
		FBFbxOptions	arg4,
		FBPlotOptions	arg5
	)

Load a rig and its animation from a file.

Python Docstring:

LoadAnimationOnCharacter( (FBApplication)arg1, (str)arg2, (FBCharacter)arg3, (FBFbxOptions)arg4, (FBPlotOptions)arg5) -> bool 

C++ Signature:

bool LoadAnimationOnCharacter(const char * pFileName, ORSDK2018::FBCharacter * pCharacter, ORSDK2018::FBFbxOptions * pFbxOptions, ORSDK2018::FBPlotOptions * pPlotOptions) 

Parameters

pFileName	File name.
pCharacter	Target character.
pFbxOptions	The options for the character rig and animation load
pPlotOptions	If the animation should be plotted on the target rig, these plot options will be used. Set to NULL if animation will not be plotted.

Returns

true if successful.

See the C++ reference

bool Maximize

(

FBApplication

arg1

)

Maximize window (minimized).

Python Docstring:

Maximize( (FBApplication)arg1) -> bool 

C++ Signature:

bool Maximize() 

Returns

Operation was successful (true or false).

See the C++ reference

bool Minimize	(	FBApplication	arg1,
		object	arg2
	)

Minimize window.

Python Docstring:

Minimize( (FBApplication)arg1 [, (object)arg2]) -> bool 

C++ Signature:

bool Minimize(bool pBlocking = true) 

Parameters

pBlocking

Is the minimization blocking operation (default = true).

Returns

Operation was successful (true or false).

See the C++ reference

bool OneClickAddToCurrentScene

(

FBApplication

arg1

)

Send the scene and add it to the current scene in the specified application.

Python Docstring:

OneClickAddToCurrentScene( (FBApplication)arg1) -> bool 

C++ Signature:

bool OneClickAddToCurrentScene() 

Returns

True if transfer successful.

See the C++ reference

FBOneClickApplication OneClickIsConnectedTo

(

FBApplication

arg1

)

Return the other application that MotionBuilder is connected to.

Python Docstring:

OneClickIsConnectedTo( (FBApplication)arg1) -> FBOneClickApplication 

C++ Signature:

FBOneClickApplication OneClickIsConnectedTo() 

Returns

The application that MotionBuilder is connected to.

See the C++ reference

OneClickSelectPreviouslySentObject

(

FBApplication

arg1

)

Select, in MotionBuilder, the object that were sent.

Python Docstring:

OneClickSelectPreviouslySentObject( (FBApplication)arg1) -> None 

C++ Signature:

void OneClickSelectPreviouslySentObject() 

See the C++ reference

bool OneClickSendAsNewScene	(	FBApplication	arg1,
		FBOneClickApplication	arg2
	)

Send the current scene as a new scene in the specified application.

Python Docstring:

OneClickSendAsNewScene( (FBApplication)arg1, (FBOneClickApplication)arg2) -> bool 

C++ Signature:

bool OneClickSendAsNewScene(FBOneClickApplication pApplication) 

Parameters

pApplication

The application that will receive the scene.

Returns

True if transfer successful.

See the C++ reference

bool OneClickUpdateCurrentScene

(

FBApplication

arg1

)

Send the scene to update the current scene in the specified application.

Python Docstring:

OneClickUpdateCurrentScene( (FBApplication)arg1) -> bool 

C++ Signature:

bool OneClickUpdateCurrentScene() 

Returns

True if transfer successful.

See the C++ reference

bool SaveCharacterRigAndAnimation	(	FBApplication	arg1,
		str	arg2,
		FBCharacter	arg3,
		FBFbxOptions	arg4
	)

Save the rig and its animation in a file.

Python Docstring:

SaveCharacterRigAndAnimation( (FBApplication)arg1, (str)arg2, (FBCharacter)arg3, (FBFbxOptions)arg4) -> bool 

C++ Signature:

bool SaveCharacterRigAndAnimation(const char * pFileName, ORSDK2018::FBCharacter * pCharacter, ORSDK2018::FBFbxOptions * pFbxOptions) 

Parameters

pFileName	File name.
pCharacter	Character to save.
pFbxOptions	The options for the character rig and animation export

Warning

After save, the current scene selection will be reset.

See the C++ reference

SetSceneAuthor	(	FBApplication	arg1,
		str	arg2
	)

Set the scene author.

Python Docstring:

SetSceneAuthor( (FBApplication)arg1, (str)arg2) -> None 

C++ Signature:

void SetSceneAuthor(const char * pAuthor) 

Parameters

pAuthor

The author to set in the scene properties.

See the C++ reference

SetSceneComment	(	FBApplication	arg1,
		str	arg2
	)

Set the scene comment.

Python Docstring:

SetSceneComment( (FBApplication)arg1, (str)arg2) -> None 

C++ Signature:

void SetSceneComment(const char * pComment) 

Parameters

pComment

The comment to set in the scene properties.

See the C++ reference

SetSceneKeywords	(	FBApplication	arg1,
		str	arg2
	)

Set the scene keywords.

Python Docstring:

SetSceneKeywords( (FBApplication)arg1, (str)arg2) -> None 

C++ Signature:

void SetSceneKeywords(const char * pKeywords) 

Parameters

pKeywords

The keywords to set in the scene properties.

See the C++ reference

SetSceneRevisionNumber	(	FBApplication	arg1,
		str	arg2
	)

Set the scene revision number.

Python Docstring:

SetSceneRevisionNumber( (FBApplication)arg1, (str)arg2) -> None 

C++ Signature:

void SetSceneRevisionNumber(const char * pRevNumber) 

Parameters

pRevNumber

The revision number to set in the scene properties.

See the C++ reference

SetSceneSubject	(	FBApplication	arg1,
		str	arg2
	)

Set the scene subject.

Python Docstring:

SetSceneSubject( (FBApplication)arg1, (str)arg2) -> None 

C++ Signature:

void SetSceneSubject(const char * pSubject) 

Parameters

pSubject

The subject to set in the scene properties.

See the C++ reference

SetSceneTitle	(	FBApplication	arg1,
		str	arg2
	)

Set the scene title.

Python Docstring:

SetSceneTitle( (FBApplication)arg1, (str)arg2) -> None 

C++ Signature:

void SetSceneTitle(const char * pTitle) 

Parameters

pTitle

The title to set in the scene properties.

See the C++ reference

SwitchViewerCamera	(	FBApplication	arg1,
		FBCamera	arg2
	)

Switch the current viewer's camera.

Python Docstring:

SwitchViewerCamera( (FBApplication)arg1, (FBCamera)arg2) -> None 

C++ Signature:

void SwitchViewerCamera(ORSDK2018::FBCamera & pCamera) 

Parameters

pCamera

Camera to switch current viewer to.

Remarks

This method is deprecated. Use FBRenderer.SetCameraInPane instead.

See the C++ reference

UpdateAllWidgets

(

FBApplication

arg1

)

Request to refresh display of all UI widgets.

Python Docstring:

UpdateAllWidgets( (FBApplication)arg1) -> None 

C++ Signature:

void UpdateAllWidgets() 

See the C++ reference

Member Data Documentation

FBPropertyActor CurrentActor

Read Write Property: Indicate the current actor, as used by the character tool.

Can be NULL. If not null, CurrentCharacter must be null, as the character tool works on only one item at a time.

See the C++ reference

FBPropertyCharacter CurrentCharacter

Read Write Property: Indicate the current character, as used by the character tool.

Can be NULL. If not null, CurrentActor must be null, as the character tool works on only one item at a time.

See the C++ reference

ORSDK2018::FBPropertyString FBXFileName

Read Write Property: Current scene filename.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileExit

Event: A File Exit as been requested, nothing has been destroyed yet.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileMerge

Event: A File Merge has been requested, nothing has been loaded yet.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileNew

Event: A File New has been requested, nothing has been destroyed yet.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileNewCompleted

Event: A File New has been completed.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileOpen

Event: A File Open has been requested, nothing has been loaded yet.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileOpenCompleted

Event: A File Open has been completed.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileSave

Event: A File Save has been requested, nothing has been saved yet.

See the C++ reference

ORSDK2018::FBPropertyEvent OnFileSaveCompleted

Event: A File Save has been completed.

See the C++ reference

object OnOverrideFileOpen