Customize motion file exporting. More...

#include <fbmotionfileexportoptions.h>

Inheritance diagram for FBMotionFileExportOptions:

[legend]

Public Member Functions
	FBMotionFileExportOptions (const char *pFilePath, HIObject pObject=nullptr)
	Constructor.

const char *	GetFilePath () const
	Get the file path for the motion file(s) to create.

bool	SetFilePath (const char *pFilePath)
	Set the file path for the motion file(s) to create.

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

bool	IsValid () const
	Is this object valid?

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

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

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

const char *	GetTakeName (int pTakeIndex) const
	Get the take name of the given take.

const char *	GetTakeFilePath (int pTakeIndex) const
	Get the export file path for given take.

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

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

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

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

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

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

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

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

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

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

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

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

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

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyModelSelection	ModelSelection
	Read Write Property: Specifies the content to export.

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

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

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

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Customize motion file exporting.

Definition at line 65 of file fbmotionfileexportoptions.h.

Constructor & Destructor Documentation

◆ FBMotionFileExportOptions()

FBMotionFileExportOptions	(	const char *	pFilePath,
		HIObject	pObject = `nullptr`
	)

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.
pObject	For internal use only.

Member Function Documentation

◆ GetFilePath()

const char * GetFilePath ( ) const

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 ( ) const

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

const char * GetTakeFilePath ( int pTakeIndex ) const

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

double GetTakeFrameRate ( int pTakeIndex ) const

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

const char * GetTakeName ( int pTakeIndex ) const

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

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

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

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

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 ( ) const

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 ( const char * 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,
		const char *	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,
		double	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

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

Definition at line 79 of file fbmotionfileexportoptions.h.

◆ FileCreation

FBPropertyFileCreation FileCreation

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

Definition at line 77 of file fbmotionfileexportoptions.h.

◆ ModelSelection

FBPropertyModelSelection ModelSelection

Read Write Property: Specifies the content to export.

Definition at line 76 of file fbmotionfileexportoptions.h.

◆ OneTakePerFile

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

Definition at line 78 of file fbmotionfileexportoptions.h.

The documentation for this class was generated from the following file:

fbmotionfileexportoptions.h

Public Member Functions

Public Attributes

Additional Inherited Members

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