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

#include <pyfbsdk_generated.h>

Inheritance diagram for FBApplication:

[legend]

Public Member Functions
	FBApplication ()
	Constructor.

bool	AudioRender (FBAudioRenderOptions pAudioRenderOptions=None)
	Render audio of current scene to media file, currently WAV file only.

bool	ExecuteScript (str pFilename)
	Execute a python script file.

bool	FileAppend (str pFilename, bool pShowUIMsg=False, FBFbxOptions pOptions=None)
	Append one or multiple files to the current scene.

FBBatchStatus	FileBatch (FBBatchOptions pBatchOptions, FBPlotOptions pPlotOptions=None)
	Start a batch.

	FileExit (bool pSave=False, int pExitCode=0)
	Quit application.

bool	FileExport (str pFilename)
	Export a motion file.

bool	FileExportBatch (str pName, FBTake pTake, FBBatchOptions pBatchOptions, FBModelList pExportModels)
	Export a motion file using batch options.

bool	FileExportWithOptions (FBMotionFileExportOptions pOptions)
	Export a motion file with the ability to specify options.

bool	FileImport (str pFilename, bool pMatchModels=False, bool pCreateUnmatchedModels=True)
	Import a motion file.

bool	FileImportBatch (str pName, FBBatchOptions pBatchOptions, FBModel pReference)
	Import a motion file using batch options.

bool	FileImportWithOptions (FBMotionFileImportOptions pOptions)
	Import a motion file with the ability to specify options.

bool	FileMerge (str pFilename, bool pShowUIMsg=False, FBFbxOptions pOptions=None)
	Merge one or multiple files with the current scene.

bool	FileMerge (FBStringList pPathlist, bool pShowUIMsg=False, FBFbxOptions pOptions=None)
	Merge multiple files with the current scene.

bool	FileNew (bool pAskUser=False, bool pClearSceneName=True)
	Command File->New in the menus.

bool	FileOpen (str pFilename, bool pShowUIMsg=False, FBFbxOptions pOptions=None)
	Open a file, replacing the current scene.

bool	FileOpen (pBuffer, kULong pBufferLength)
	Open a file from memory.

bool	FileRender (FBVideoGrabOptions pRenderOptions=None)
	Render current scene to media file.

bool	FileSave (str pFilename=None, FBFbxOptions pOptions=None)
	Save the file under another name.

	FlushEventQueue ()
	Flush event queue.

bool	GetMaxFrameCount (pBuffer, kULong pBufferLength, kLong pFrameCount, int pTimeScale)
	Get max frame count from a scene file in memory.

str	GetSceneAuthor ()
	Return the scene author from the scene properties.

str	GetSceneComment ()
	Return the scene comment from the scene properties.

str	GetSceneKeywords ()
	Return the scene keywords from the scene properties.

str	GetSceneRevisionNumber ()
	Return the scene revision number from the scene properties.

str	GetSceneSubject ()
	Return the scene subject from the scene properties.

str	GetSceneTitle ()
	Return the scene title from the scene properties.

bool	IsSceneModified ()
	Is the scene modified since last save / new scene creation?

bool	IsValidBatchFile (str pFilename)
	Verify motion file readability.

bool	LoadAnimationOnCharacter (str pFileName, FBCharacter pCharacter, FBFbxOptions pFbxOptions, FBPlotOptions pPlotOptions)
	Load a rig and its animation from a file.

bool	Maximize ()
	Maximize window (minimized).

bool	Minimize (bool pBlocking=True)
	Minimize window.

bool	OneClickAddToCurrentScene ()
	Send the scene and add it to the current scene in the specified application.

FBOneClickApplication	OneClickIsConnectedTo ()
	Return the other application that MotionBuilder is connected to.

	OneClickSelectPreviouslySentObject ()
	Select, in MotionBuilder, the object that were sent.

bool	OneClickSendAsNewScene (FBOneClickApplication pApplication)
	Send the current scene as a new scene in the specified application.

bool	OneClickUpdateCurrentScene ()
	Send the scene to update the current scene in the specified application.

bool	SaveCharacterRigAndAnimation (str pFileName, FBCharacter pCharacter, FBFbxOptions pFbxOptions)
	Save the rig and its animation in a file.

	SetSceneAuthor (str pAuthor)
	Set the scene author.

	SetSceneComment (str pComment)
	Set the scene comment.

	SetSceneKeywords (str pKeywords)
	Set the scene keywords.

	SetSceneRevisionNumber (str pRevNumber)
	Set the scene revision number.

	SetSceneSubject (str pSubject)
	Set the scene subject.

	SetSceneTitle (str pTitle)
	Set the scene title.

	UpdateAllWidgets ()
	Request to refresh display of all UI widgets.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBApplicationState	ApplicationState
	Read Only Property: State the MotionBuilder application has been started in.

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

FBCharacter	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 sample: CurrentCharacterGoToStancePose.py.

str	FBXFileName
	Read Write Property: Current scene filename.

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

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

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

FBEvent	OnFileNewCompleted
	Event: A File New has been completed.

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

FBEvent	OnFileOpenCompleted
	Event: A File Open has been completed.

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

FBEvent	OnFileSaveCompleted
	Event: A File Save has been completed.

FBEventOverrideFileOpen	OnOverrideFileOpen
	Event: Called when a file is about to be opened/merged. The user can override the process with his own file import system.

FBEvent	OnStartupCompleted
	Event: The startup of the application has been completed.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed 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 samples: FBFbxOptions.py, FBSystemEvents.py, ImportWithNamespace.py, BatchExportCharacterAnimationTool.py, ExportAnimationLibrary.py, SaveOneTakePerFile.py.

Constructor & Destructor Documentation

◆ FBApplication()

FBApplication ( )

Constructor.

Member Function Documentation

◆ AudioRender()

bool AudioRender ( FBAudioRenderOptions pAudioRenderOptions = None )

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

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.

◆ ExecuteScript()

bool ExecuteScript ( str pFilename )

Execute a python script file.

See the FBPython class for advanced capabilities. Same as calling the FBPython.ExecuteScript method.

Parameters

pFilename The script file to execute.

Returns: True if the script file was found and executed.

Remarks: This function can be used in any thread.

◆ FileAppend()

bool FileAppend	(	str	pFilename,
		bool	pShowUIMsg = `False`,
		FBFbxOptions	pOptions = `None`
	)

Append one or multiple files to the current scene.

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.

◆ FileBatch()

FBBatchStatus FileBatch	(	FBBatchOptions	pBatchOptions,
		FBPlotOptions	pPlotOptions = `None`
	)

Start a batch.

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.

◆ FileExit()

FileExit	(	bool	pSave = `False`,
		int	pExitCode = `0`
	)

Quit application.

Command File->Exit in the menus.

Parameters

pSave	true if file is saved on exit(default=false).
pExitCode	Exit code of the application(default=0).

◆ FileExport()

bool FileExport ( str pFilename )

Export a motion file.

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.; Only current take is exported.; 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.

◆ FileExportBatch()

bool FileExportBatch	(	str	pName,
		FBTake	pTake,
		FBBatchOptions	pBatchOptions,
		FBModelList	pExportModels
	)

Export a motion file using batch options.

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.

◆ FileExportWithOptions()

bool FileExportWithOptions ( FBMotionFileExportOptions pOptions )

Export a motion file with the ability to specify options.

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

Parameters

pOptions An FBMotionFileExportOptions object that contains the file path of the motion file(s) to export, as well as the options to export those motion files.

Returns: True if the export succeeded. Returns false if some files were not written (file not overwritten, invalid path, etc.). Returns false if the given options object is not valid. See the FBMotionFileExportOptions::IsValid method.

Remarks: Based on the values of the various options, multiple motion files could be created with file paths based on the initial file path provided. See the documentation of FBMotionFileExportOptions for more details.; For now, only the FBX motion file type is supported.; For now, you cannot export custom file types.

◆ FileImport()

bool FileImport	(	str	pFilename,
		bool	pMatchModels = `False`,
		bool	pCreateUnmatchedModels = `True`
	)

Import a motion file.

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.

◆ FileImportBatch()

bool FileImportBatch	(	str	pName,
		FBBatchOptions	pBatchOptions,
		FBModel	pReference
	)

Import a motion file using batch options.

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.

◆ FileImportWithOptions()

bool FileImportWithOptions ( FBMotionFileImportOptions pOptions )

Import a motion file with the ability to specify options.

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

Parameters

pOptions An FBMotionFileImportOptions 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.

◆ FileMerge() [1/2]

bool FileMerge	(	FBStringList	pPathlist,
		bool	pShowUIMsg = `False`,
		FBFbxOptions	pOptions = `None`
	)

Merge multiple files with the current scene.

Command File->Merge in the menus.

Parameters

pPathlist	Files to merge.
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 merge 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.

◆ FileMerge() [2/2]

bool FileMerge	(	str	pFilename,
		bool	pShowUIMsg = `False`,
		FBFbxOptions	pOptions = `None`
	)

Merge one or multiple files with the current scene.

Command File->Merge in the menus.

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

◆ FileNew()

bool FileNew	(	bool	pAskUser = `False`,
		bool	pClearSceneName = `True`
	)

Command File->New in the menus.

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.

◆ FileOpen() [1/2]

bool FileOpen	(	pBuffer	,
		kULong	pBufferLength
	)

Open a file from memory.

Parameters

pBuffer	the memory buffer for the file. Raw memory address is expected in Python.
pBufferLength	the memory buffer size.

Returns: true if file opened successfully.

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

◆ FileOpen() [2/2]

bool FileOpen	(	str	pFilename,
		bool	pShowUIMsg = `False`,
		FBFbxOptions	pOptions = `None`
	)

Open a file, replacing the current scene.

Command File->Open in the menus.

Parameters

pFilename	File to open.
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.

Returns: true if file open successfully.

See samples: BatchExportCharacterAnimationTool.py, RenameFirstTakeOnMultipleFiles.py.

◆ FileRender()

bool FileRender ( FBVideoGrabOptions pRenderOptions = None )

Render current scene to media file.

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.

◆ FileSave()

bool FileSave	(	str	pFilename = `None`,
		FBFbxOptions	pOptions = `None`
	)

Save the file under another name.

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 sample: SaveSelected.py.

◆ FlushEventQueue()

FlushEventQueue ( )

Flush event queue.

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

◆ GetMaxFrameCount()

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

Get max frame count from a scene file in memory.

Parameters

pBuffer	the memory buffer for the file. Raw memory address is expected in Python.
pBufferLength	the memory buffer size.
pFrameCount	(C++ only) out parameter to hold max frame count.
pTimeScale	Time scale.

Returns: (C++ only) True if file opened successfully. (Python only) A tuple with 2 values: (bool return value, pFrameCount).

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

◆ GetSceneAuthor()

str GetSceneAuthor ( )

Return the scene author from the scene properties.

◆ GetSceneComment()

str GetSceneComment ( )

Return the scene comment from the scene properties.

◆ GetSceneKeywords()

str GetSceneKeywords ( )

Return the scene keywords from the scene properties.

◆ GetSceneRevisionNumber()

str GetSceneRevisionNumber ( )

Return the scene revision number from the scene properties.

◆ GetSceneSubject()

str GetSceneSubject ( )

Return the scene subject from the scene properties.

◆ GetSceneTitle()

str GetSceneTitle ( )

Return the scene title from the scene properties.

◆ IsSceneModified()

bool IsSceneModified ( )

Is the scene modified since last save / new scene creation?

Returns: True if the scene is modified since last save / new scene creation, false otherwise.

◆ IsValidBatchFile()

bool IsValidBatchFile ( str pFilename )

Verify motion file readability.

Parameters

pFilename The file to test.

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

◆ LoadAnimationOnCharacter()

bool LoadAnimationOnCharacter	(	str	pFileName,
		FBCharacter	pCharacter,
		FBFbxOptions	pFbxOptions,
		FBPlotOptions	pPlotOptions
	)

Load a rig and its animation from a file.

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.

◆ Maximize()

bool Maximize ( )

Maximize window (minimized).

Returns: Operation was successful (true or false).

◆ Minimize()

bool Minimize ( bool pBlocking = True )

Minimize window.

Parameters

pBlocking Is the minimization blocking operation (default = true).

Returns: Operation was successful (true or false).

◆ OneClickAddToCurrentScene()

bool OneClickAddToCurrentScene ( )

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

Returns: True if transfer successful.

◆ OneClickIsConnectedTo()

FBOneClickApplication OneClickIsConnectedTo ( )

Return the other application that MotionBuilder is connected to.

Returns: The application that MotionBuilder is connected to.

◆ OneClickSelectPreviouslySentObject()

OneClickSelectPreviouslySentObject ( )

Select, in MotionBuilder, the object that were sent.

◆ OneClickSendAsNewScene()

bool OneClickSendAsNewScene ( FBOneClickApplication pApplication )

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

Parameters

pApplication The application that will receive the scene.

Returns: True if transfer successful.

◆ OneClickUpdateCurrentScene()

bool OneClickUpdateCurrentScene ( )

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

Returns: True if transfer successful.

◆ SaveCharacterRigAndAnimation()

bool SaveCharacterRigAndAnimation	(	str	pFileName,
		FBCharacter	pCharacter,
		FBFbxOptions	pFbxOptions
	)

Save the rig and its animation in a file.

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.

◆ SetSceneAuthor()

SetSceneAuthor ( str pAuthor )

Set the scene author.

Parameters

pAuthor The author to set in the scene properties.

◆ SetSceneComment()

SetSceneComment ( str pComment )

Set the scene comment.

Parameters

pComment The comment to set in the scene properties.

◆ SetSceneKeywords()

SetSceneKeywords ( str pKeywords )

Set the scene keywords.

Parameters

pKeywords The keywords to set in the scene properties.

◆ SetSceneRevisionNumber()

SetSceneRevisionNumber ( str pRevNumber )

Set the scene revision number.

Parameters

pRevNumber The revision number to set in the scene properties.

◆ SetSceneSubject()

SetSceneSubject ( str pSubject )

Set the scene subject.

Parameters

pSubject The subject to set in the scene properties.

◆ SetSceneTitle()

SetSceneTitle ( str pTitle )

Set the scene title.

Parameters

pTitle The title to set in the scene properties.

◆ UpdateAllWidgets()

UpdateAllWidgets ( )

Request to refresh display of all UI widgets.

Member Data Documentation

◆ ApplicationState

FBApplicationState ApplicationState

Read Only Property: State the MotionBuilder application has been started in.

◆ CurrentActor

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

◆ CurrentCharacter

FBCharacter 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 sample: CurrentCharacterGoToStancePose.py.

◆ FBXFileName

str FBXFileName

Read Write Property: Current scene filename.

◆ OnFileExit

FBEvent OnFileExit

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

◆ OnFileMerge

FBEvent OnFileMerge

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

◆ OnFileNew

FBEvent OnFileNew

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

◆ OnFileNewCompleted

FBEvent OnFileNewCompleted

Event: A File New has been completed.

◆ OnFileOpen

FBEvent OnFileOpen

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

◆ OnFileOpenCompleted

FBEvent OnFileOpenCompleted

Event: A File Open has been completed.

◆ OnFileSave

FBEvent OnFileSave

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

◆ OnFileSaveCompleted

FBEvent OnFileSaveCompleted

Event: A File Save has been completed.

◆ OnOverrideFileOpen

FBEventOverrideFileOpen OnOverrideFileOpen

Event: Called when a file is about to be opened/merged. The user can override the process with his own file import system.

◆ OnStartupCompleted

FBEvent OnStartupCompleted

Event: The startup of the application has been completed.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FBApplication()

Member Function Documentation

◆ AudioRender()

◆ ExecuteScript()

◆ FileAppend()

◆ FileBatch()

◆ FileExit()

◆ FileExport()

◆ FileExportBatch()

◆ FileExportWithOptions()

◆ FileImport()

◆ FileImportBatch()

◆ FileImportWithOptions()

◆ FileMerge() [1/2]

◆ FileMerge() [2/2]

◆ FileNew()

◆ FileOpen() [1/2]

◆ FileOpen() [2/2]

◆ FileRender()

◆ FileSave()

◆ FlushEventQueue()

◆ GetMaxFrameCount()

◆ GetSceneAuthor()

◆ GetSceneComment()

◆ GetSceneKeywords()

◆ GetSceneRevisionNumber()

◆ GetSceneSubject()

◆ GetSceneTitle()

◆ IsSceneModified()

◆ IsValidBatchFile()

◆ LoadAnimationOnCharacter()

◆ Maximize()

◆ Minimize()

◆ OneClickAddToCurrentScene()

◆ OneClickIsConnectedTo()

◆ OneClickSelectPreviouslySentObject()

◆ OneClickSendAsNewScene()

◆ OneClickUpdateCurrentScene()

◆ SaveCharacterRigAndAnimation()

◆ SetSceneAuthor()

◆ SetSceneComment()

◆ SetSceneKeywords()

◆ SetSceneRevisionNumber()

◆ SetSceneSubject()

◆ SetSceneTitle()

◆ UpdateAllWidgets()

Member Data Documentation

◆ ApplicationState

◆ CurrentActor

◆ CurrentCharacter

◆ FBXFileName

◆ OnFileExit

◆ OnFileMerge

◆ OnFileNew

◆ OnFileNewCompleted

◆ OnFileOpen

◆ OnFileOpenCompleted

◆ OnFileSave

◆ OnFileSaveCompleted

◆ OnOverrideFileOpen

◆ OnStartupCompleted