Customize motion file exporting. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBMotionFileExportOptions:

[legend]

Public Member Functions
	FBMotionFileExportOptions (str pFilePath)
	Constructor.

str	GetFilePath ()
	Get the file path for the motion file(s) to create.

int	GetTakeCount ()
	Get the take count that can be exported (i.e.: the take count in the scene).

str	GetTakeFilePath (int pTakeIndex)
	Get the export file path for given take.

float	GetTakeFrameRate (int pTakeIndex)
	Get the actual frame rate of the given take as a double, useful when you have a custom frame rate.

str	GetTakeName (int pTakeIndex)
	Get the take name of the given take.

bool	GetTakeSelect (int pTakeIndex)
	Get the export selection status of the given take.

FBTime	GetTakeStart (int pTakeIndex)
	Get the start time of the given take.

FBTime	GetTakeStop (int pTakeIndex)
	Get the stop time of the given take.

FBTimeMode	GetTakeTimeMode (int pTakeIndex)
	Get the time mode of the given take.

bool	IsValid ()
	Is this object valid?

bool	ResetTakeInfo ()
	Reset all the take info hold by this object.

bool	SetFilePath (str pFilePath)
	Set the file path for the motion file(s) to create.

bool	SetTakeFilePath (int pTakeIndex, str pFilePath)
	Set the export file path for given take.

bool	SetTakeSelect (int pTakeIndex, bool pSelect)
	Set the export selection status of the given take.

bool	SetTakeTimeMode (int pTakeIndex, FBTimeMode pTimeMode, float pCustomFrameRate=30.0)
	Set the time mode of the given take.

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
bool	AddPrefix
	Read Write Property: Effective only if the OneTakePerFile property is true. True to prefix the constructor's specified filename in the take export file path, false otherwise. Changing this property value will reset any user-specified file path set with the SetTakeFilePath method.

FBFileCreation	FileCreation
	Read Write Property: Operation to execute when trying to write a file that already exists on disk.

FBModelSelection	ModelSelection
	Read Write Property: Specifies the content to export.

bool	OneTakePerFile
	Read Write Property: True to export each take in a separated file, false to export all takes in a single file. Changing this property value will reset any user-specified file path set with the SetTakeFilePath method.

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

Customize motion file exporting.

Constructor & Destructor Documentation

◆ FBMotionFileExportOptions()

FBMotionFileExportOptions ( str pFilePath )

Constructor.

Create an FBMotionFileExportOptions object to be used when exporting a motion file. Pass the file path for the motion file(s) to create, modify the options and then call the file export process. Only the FBX file format is supported for now.

Parameters

pFilePath The file path for the motion file(s) to create.

Member Function Documentation

◆ GetFilePath()

str GetFilePath ( )

Get the file path for the motion file(s) to create.

This is the file path provided with the constructor or with the SetFilePath method.

Returns: The file path for the motion file(s) to create.

◆ GetTakeCount()

int GetTakeCount ( )

Get the take count that can be exported (i.e.: the take count in the scene).

Returns: The take count that can be exported.

◆ GetTakeFilePath()

str GetTakeFilePath ( int pTakeIndex )

Get the export file path for given take.

Parameters

pTakeIndex Index of take to get the file path.

Returns: The file path of the given take. Returns nullptr (None in Python) if the operation cannot be performed.

Remarks: Changing the value of the OneTakePerFile and/or AddPrefix properties could affect the value returned.

◆ GetTakeFrameRate()

float GetTakeFrameRate ( int pTakeIndex )

Get the actual frame rate of the given take as a double, useful when you have a custom frame rate.

Parameters

pTakeIndex Index of take to get the frame rate.

Returns: The frame rate of the given take.

◆ GetTakeName()

str GetTakeName ( int pTakeIndex )

Get the take name of the given take.

Parameters

pTakeIndex Index of take to get the name.

Returns: The name of the given take. Returns nullptr (None in Python) if the operation cannot be performed.

◆ GetTakeSelect()

bool GetTakeSelect ( int pTakeIndex )

Get the export selection status of the given take.

Parameters

pTakeIndex Index of take to get the selection status.

Returns: True is the take will be exported, false otherwise.

◆ GetTakeStart()

FBTime GetTakeStart ( int pTakeIndex )

Get the start time of the given take.

Parameters

pTakeIndex Index of take to get the start time.

Returns: The start time of the given take.

◆ GetTakeStop()

FBTime GetTakeStop ( int pTakeIndex )

Get the stop time of the given take.

Parameters

pTakeIndex Index of take to get the stop time.

Returns: The stop time of the given take.

◆ GetTakeTimeMode()

FBTimeMode GetTakeTimeMode ( int pTakeIndex )

Get the time mode of the given take.

Parameters

pTakeIndex Index of take to get the time mode.

Returns: The time mode of the given take.

Remarks: Use GetTakeFrameRate if you have a custom time mode to get the actual frame rate.

◆ IsValid()

bool IsValid ( )

Is this object valid?

Returns: True if the provided file path for the motion file(s) to create is valid and if the take info is up to date with the scene, false otherwise.

Remarks: Call the SetFilePath method to provide a valid file path.; Call the ResetTakeInfo method to reset the take info (i.e.: will be then in sync with the scene).

◆ ResetTakeInfo()

bool ResetTakeInfo ( )

Reset all the take info hold by this object.

Useful to call when the scene takes changed since the creation of this object.

Returns: True if the operation is successful, false otherwise.

◆ SetFilePath()

bool SetFilePath ( str pFilePath )

Set the file path for the motion file(s) to create.

When the OneTakePerFile property is true, the default takes file path will be based on this file path.

Parameters

pFilePath The file path for the motion file(s) to create.

Returns: True if the provided file path is valid, false otherwise.

Remarks: All the takes file path will be updated after calling this method.

◆ SetTakeFilePath()

bool SetTakeFilePath	(	int	pTakeIndex,
		str	pFilePath
	)

Set the export file path for given take.

Parameters

pTakeIndex	Index of take to set the file path.
pFilePath	The file path of the given take.

Returns: True if the operation is successful, false otherwise.

Remarks: Changing the value of the OneTakePerFile and/or AddPrefix properties could reset the value set.; If the OneTakePerFile property is false, changing the file path for one take will modify the file path of all the other takes at once.

◆ SetTakeSelect()

bool SetTakeSelect	(	int	pTakeIndex,
		bool	pSelect
	)

Set the export selection status of the given take.

Parameters

pTakeIndex	Index of take to set the selection status.
pSelect	True if the take should be exported, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ SetTakeTimeMode()

bool SetTakeTimeMode	(	int	pTakeIndex,
		FBTimeMode	pTimeMode,
		float	pCustomFrameRate = `30.0`
	)

Set the time mode of the given take.

Parameters

pTakeIndex	Index of take to set the time mode.
pTimeMode	Time mode to set.
pCustomFrameRate	Custom frame rate if pTimeMode is set to kFBTimeModeCustom, unused otherwise (default is 30.0).

Returns: True if the operation is successful, false otherwise.

Remarks: If the OneTakePerFile property is false, changing the time mode/frame rate for one take will modify the time mode/frame rate of all the other takes at once.

Member Data Documentation

◆ AddPrefix

bool AddPrefix

Read Write Property: Effective only if the OneTakePerFile property is true. True to prefix the constructor's specified filename in the take export file path, false otherwise. Changing this property value will reset any user-specified file path set with the SetTakeFilePath method.

◆ FileCreation

FBFileCreation FileCreation

Read Write Property: Operation to execute when trying to write a file that already exists on disk.

◆ ModelSelection

FBModelSelection ModelSelection

Read Write Property: Specifies the content to export.

◆ OneTakePerFile

bool OneTakePerFile

Read Write Property: True to export each take in a separated file, false to export all takes in a single file. Changing this property value will reset any user-specified file path set with the SetTakeFilePath method.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FBMotionFileExportOptions()

Member Function Documentation

◆ GetFilePath()

◆ GetTakeCount()

◆ GetTakeFilePath()

◆ GetTakeFrameRate()

◆ GetTakeName()

◆ GetTakeSelect()

◆ GetTakeStart()

◆ GetTakeStop()

◆ GetTakeTimeMode()

◆ IsValid()

◆ ResetTakeInfo()

◆ SetFilePath()

◆ SetTakeFilePath()

◆ SetTakeSelect()

◆ SetTakeTimeMode()

Member Data Documentation

◆ AddPrefix

◆ FileCreation

◆ ModelSelection

◆ OneTakePerFile