Customize file loading and saving. More...

#include <fbfbxoptions.h>

Inheritance diagram for FBFbxOptions:

[legend]

Public Member Functions
	FBFbxOptions (bool pLoad, const char *pFilePathToLoad=NULL, HIObject pObject=NULL)
	Constructor. More...

void	SetAll (FBElementAction pElementAction, bool pAnimation)
	Set All Options. More...

void	SaveToString (FBString &pString, FBOptionsContext context)
	Serialize all options to a string Serialize all options to a string specifying a context. More...

void	SetFromString (const char *pString, FBOptionsContext context)
	Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString) More...

Setup take Info to loaded or saved.
You need to use the appropriate constructor to fill up those take info before call these functions.
int	GetTakeCount () const
	Return the count of takes in the scene to saved or the file to loaded. More...

bool	GetTakeSelect (int pTakeIndex) const
	Return if true if the take will be saved or Loaded. More...

void	SetTakeSelect (int pTakeIndex, bool pSelect)
	Return if true if the take will be saved or Loaded. More...

const char *	GetTakeName (int pTakeIndex) const
	Take Original Name. More...

void	SetTakeName (int pTakeIndex, const char *pName)
	Take Original Name. More...

const char *	GetTakeDescription (int pTakeIndex) const
	Take Description. More...

void	SetTakeDescription (int pTakeIndex, const char *pDescription)
	Take Description. More...

const char *	GetTakeDestinationName (int pTakeIndex) const
	Take Destination Name upon save or load. More...

void	SetTakeDestinationName (int pTakeIndex, const char *pDestinationName)
	Take Destination Name upon save or load. More...

FBTimeSpan	GetTakeKeyRange (int pTakeIndex)
	Get take key range. More...

void	SetTakeKeyRange (int pTakeIndex, FBTimeSpan pKeyTimeSpan)
	Set take key range. More...

void	SetNamespaceList (const FBStringList &pNamespaceList)
	SetNamespaceList upon save or load On Load, if the SetMultiLoadNamespaceList method is also called, the NamespaceList property is ignored. More...

FBStringList	GetNamespaceList ()
	GetNamespaceList upon save or load. More...

void	SetObjectsToSave (FBArrayTemplate< FBComponent * > *pObjectsToSave)
	Sets the list of objects that will be saved. More...

void	SetMultiLoadNamespaceList (const FBStringList &pMultiLoadNamespaceList)
	Sets the list of namespaces that will be used when merging multiple scenes (see FBApplication::FileMerge). More...

FBStringList	GetMultiLoadNamespaceList ()
	Returns the list of namespaces that will be used when merging multiple scenes (see FBApplication::FileMerge). More...

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

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

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

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

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

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

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

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

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

void	HardSelect ()
	HardSelect. More...

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

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

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
Load/Save options.
Warning These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyBool	UpdateRecentFiles
	Read Write Property: Set to true to update recent file list. More...

Load specific options.
Warning These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyTakeSpanOnLoad	TakeSpan
	Read Write Property: Indicate how the take start and end point should be set. By default it is read from the file. More...

Save specific options.
All of these options are false by default, except for 'EmbedMedia' which is true by default. Warning These options are not present in the history file. Thus will not be affected by 'SetOptionsFromHistory()' and 'SetHistoryFromOptions()'.
FBPropertyFileFormatAndVersion	FileFormatAndVersion
	Read Write Property: File format and version chosen to save the scene. More...

FBPropertyBool	EmbedMedia
	Read Write Property: Embed all media in the FBX file itself. When saving in ASCII mode it is not possible to embed media. More...

FBPropertyBool	SaveSelectedModelsOnly
	Read Write Property: Indicate that only the selected models will be saved. More...

FBPropertyBool	KeepTransformHierarchy
	Read Write Property: Indicate whether we keep transform hierarchy when SaveSelectedModelsOnly is true. Default value is false to ensure consistent behavior with SaveSelected operation via file menu. More...

FBPropertyBool	UseASCIIFormat
	Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode. More...

FBPropertyInt	CacheSize
	Read Write Property: The Cached buffer size used to accelerate IO system. More...

FBPropertyBool	CompressArray
	Read Write Property: Indicate if the perform compression on the arrays values. More...

FBPropertyInt	CompressMinSize
	Read Write Property: Indicate if the minimum item size for compressing arrays. More...

FBPropertyInt	CompressLevel
	Read Write Property: The allowed level range for Compression is [0-9] where 0 equals no compression and 9 is as-much-as-we-can. More...

Scene settings options.
FBPropertyBool	BaseCameras
	Read Write Property: Consider base camera settings. More...

FBPropertyBool	CameraSwitcherSettings
	Read Write Property: Consider camera switcher settings. More...

FBPropertyBool	CurrentCameraSettings
	Read Write Property: Consider current camera settings. More...

FBPropertyBool	GlobalLightingSettings
	Read Write Property: Consider global Lighting settings. More...

FBPropertyBool	TransportSettings
	Read Write Property: Consider transport control settings. More...

Scene segmentation options
FBPropertyBool	FileReference
	Read Write property: Load/Save scene as FileReference. More...

FBPropertyBool	FileReferenceEdit
	Read Write Property: Load/Save the edits made to referenced objects or not. More...

FBPropertyString	NamespaceList
	Read Write Property: A list of namespaces separated by '~'. On Load, duplicate the loaded objects into each namespace in the list. If the SetMultiLoadNamespaceList method is also called, this property is ignored. More...

Layer merge options
FBPropertyBool	RemoveEmptyLayer
	Read Write property: Remove empty animation layers that are in additive mode, without child or parent. More...

FBPropertyBool	ConsiderMuteSolo
	Read Write property: Consider the mute/solo settings to identify identical layer when merging. More...

Element settings options.
FBPropertyElementAction	Actors
	Read Write Property: Handling of the Actors elements. More...

FBPropertyElementAction	ActorFaces
	Read Write Property: Handling of the Actor Faces elements. More...

FBPropertyElementAction	Audio
	Read Write Property: Handling of the Audio elements. More...

FBPropertyElementAction	Bones
	Read Write Property: Handling of the Bones elements. More...

FBPropertyElementAction	Cameras
	Read Write Property: Handling of the Cameras elements. More...

FBPropertyElementAction	Characters
	Read Write Property: Handling of the Characters elements. More...

FBPropertyElementAction	CharacterFaces
	Read Write Property: Handling of the Character Faces elements. More...

FBPropertyElementAction	CharacterExtensions
	Read Write Property: Handling of the Character Extensions. More...

FBPropertyElementAction	Constraints
	Read Write Property: Handling of the Constraints elements. More...

FBPropertyElementAction	Devices
	Read Write Property: Handling of the Devices elements. More...

FBPropertyElementAction	FileReferences
	Read Write Property: Handling of the FileReferences elements. More...

FBPropertyElementAction	Groups
	Read Write Property: Handling of the Groups elements. More...

FBPropertyElementAction	KeyingGroups
	Read Write Property: Handling of the Keying Groups elements. More...

FBPropertyElementAction	Lights
	Read Write Property: Handling of the Lights elements. More...

FBPropertyElementAction	Materials
	Read Write Property: Handling of the Materials elements. More...

FBPropertyElementAction	Models
	Read Write Property: Handling of the Models elements. More...

FBPropertyElementAction	Notes
	Read Write Property: Handling of the Notes elements. More...

FBPropertyElementAction	OpticalData
	Read Write Property: Handling of the Optical Data elements. More...

FBPropertyElementAction	PhysicalProperties
	Read Write Property: Handling of the Physical Properties elements. More...

FBPropertyElementAction	Poses
	Read Write Property: Handling of the Poses elements. More...

FBPropertyElementAction	Scripts
	Read Write Property: Handling of the Scripts elements. More...

FBPropertyElementAction	Sets
	Read Write Property: Handling of the Sets elements. More...

FBPropertyElementAction	Shaders
	Read Write Property: Handling of the Shaders elements. More...

FBPropertyElementAction	Solvers
	Read Write Property: Handling of the Solvers elements. More...

FBPropertyElementAction	Story
	Read Write Property: Handling of the Story elements. More...

FBPropertyElementAction	Textures
	Read Write Property: Handling of the Textures elements. More...

FBPropertyElementAction	Video
	Read Write Property: Handling of the Video elements. More...

Element animation settings options.
Not all elements type have animation associated with them.
FBPropertyBool	ActorFacesAnimation
	Read Write Property: Handling of the Actor Faces animation. More...

FBPropertyBool	BonesAnimation
	Read Write Property: Handling of the Bones animation. More...

FBPropertyBool	CamerasAnimation
	Read Write Property: Handling of the Cameras animation. More...

FBPropertyBool	CharactersAnimation
	Read Write Property: Handling of the Characters animation. More...

FBPropertyBool	CharacterFacesAnimation
	Read Write Property: Handling of the Character Faces animation. More...

FBPropertyBool	ConstraintsAnimation
	Read Write Property: Handling of the Constraints animation. More...

FBPropertyBool	DevicesAnimation
	Read Write Property: Handling of the Devices animation. More...

FBPropertyBool	LightsAnimation
	Read Write Property: Handling of the Lights animation. More...

FBPropertyBool	MaterialsAnimation
	Read Write Property: Handling of the Materials animation. More...

FBPropertyBool	ModelsAnimation
	Read Write Property: Handling of the Models animation. More...

FBPropertyBool	NotesAnimation
	Read Write Property: Handling of the Notes animation. More...

FBPropertyBool	PhysicalPropertiesAnimation
	Read Write Property: Handling of the Physical Properties animation. More...

FBPropertyBool	ShadersAnimation
	Read Write Property: Handling of the Shaders animation. More...

FBPropertyBool	SolversAnimation
	Read Write Property: Handling of the Solvers animation. More...

FBPropertyBool	StoryAnimation
	Read Write Property: Handling of the Story animation (animatable properties on story objects). More...

FBPropertyBool	TexturesAnimation
	Read Write Property: Handling of the Textures animation. More...

Save Character & Animation settings options.
FBPropertyBool	SaveCharacter
	Read Write Property: Set to true if the character should be saved when call FBApplication::SaveCharacterRigAndAnimation. More...

FBPropertyBool	SaveControlSet
	Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication::SaveCharacterRigAndAnimation. More...

FBPropertyBool	SaveCharacterExtensions
	Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation. More...

FBPropertyBool	ClearSelectionBeforeSave
	Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication::SaveCharacterRigAndAnimation. More...

Load Character & Animation settings options.
FBPropertyCharacterLoadAnimationMethod	TransferMethod
	Read Write Property: How should the animation should be transfered on the target rig. More...

FBPropertyBool	ProcessAnimationOnExtension
	Read Write Property: Set to true if animation on character extensions should also be transferred. More...

FBPropertyBool	ReplaceControlSet
	Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation. More...

FBPropertyBool	ResetDOF
	Read Write Property: Set to true if we should change the limits on the target rig. More...

FBPropertyBool	ResetHierarchy
	Read Write Property: Set to true if we should reset the character hierarchy. More...

FBPropertyBool	RemoveConstraintReference
	Read Write Property: Set to true if we should remove constraint reference. More...

FBPropertyBool	CopyCharacterExtensions
	Read Write Property: pCopyMissingExtensions Set to true if the character extensions on the rig in the file should be copied to the target rig. More...

FBPropertyBool	RetargetOnBaseLayer
	Read Write Property: If the transfer method is retarget, set this parameter to control where the retarget correction will be made (on base layer or on another layer). More...

FBPropertyBool	IgnoreConflicts
	Read Write Property: Set to true to ignore conflicts between objects in character extensions and objects in the scene. Conflicting objects will be merged in the extension More...

Dialog UI options.
FBPropertyBool	ShowFileDialog
	Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile. More...

FBPropertyBool	ShowOptionsDialog
	Read Write Property: Set to true if want to pop up options dialog for detail settings. More...

FBPropertyBool	SetPropertyStaticIfPossible
	Read Write Property: Set to false if want to keep properties' animated flag even when they are not really animated(no keyframe data) while retrieving/storing. More...

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

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

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

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

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

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

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

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

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

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

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

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

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

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

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

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

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

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

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

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

int	GetSrcCount ()
	Get source connection count. More...

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

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

int	GetDstCount ()
	Get destination connection count. More...

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

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

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

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

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

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

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

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

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

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

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

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

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

int	GetOwnedCount ()
	Get the owned plug count. More...

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

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

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

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

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

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

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

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Customize file loading and saving.

Definition at line 123 of file fbfbxoptions.h.

Constructor & Destructor Documentation

◆ FBFbxOptions()

FBFbxOptions	(	bool	pLoad,
		const char *	pFilePathToLoad = `NULL`,
		HIObject	pObject = `NULL`
	)

Constructor.

Create a FBFbxOption to be used in FBApplication Save/Load with default settings.

Parameters

pLoad	If true, will init option for a default Load (Append all elements and animation). If false will initialized options for a default Save (Save all elements and animation).
pFilePathToLoad	If pLoad is true, the client code should pass the file path to load to collect the take info; ignore when pLoad is false.
pObject	For internal use only.

Member Function Documentation

◆ GetMultiLoadNamespaceList()

FBStringList GetMultiLoadNamespaceList ( )

Returns the list of namespaces that will be used when merging multiple scenes (see FBApplication::FileMerge).

This list is affecting only the merge operation. When merging multiple scenes, if this list of namespaces is set, the FBFbxOptions::NamespaceList property value is ignored.

Returns: The multi load namespace list currently set.

◆ GetNamespaceList()

FBStringList GetNamespaceList ( )

GetNamespaceList upon save or load.

Returns: namespace list

◆ GetTakeCount()

int GetTakeCount ( ) const

Return the count of takes in the scene to saved or the file to loaded.

Warning: You need to use appropriate constructor to be able to take infos.

◆ GetTakeDescription()

const char* GetTakeDescription ( int pTakeIndex ) const

Take Description.

Parameters

pTakeIndex index of take to get.

◆ GetTakeDestinationName()

const char* GetTakeDestinationName ( int pTakeIndex ) const

Take Destination Name upon save or load.

Parameters

pTakeIndex index of take to get.

◆ GetTakeKeyRange()

FBTimeSpan GetTakeKeyRange ( int pTakeIndex )

Get take key range.

Parameters

pTakeIndex index of take to get.

Returns: A time range, keys inside that time range will be kept. Keys outside that time range will be removed when importing the animation, by default the time range is FBTime::MinusInfinity -> FBTime::Infinity

Remarks: Valid only on load/merge, not when saving a file.

◆ GetTakeName()

const char* GetTakeName ( int pTakeIndex ) const

Take Original Name.

Parameters

pTakeIndex index of take to get.

◆ GetTakeSelect()

bool GetTakeSelect ( int pTakeIndex ) const

Return if true if the take will be saved or Loaded.

Parameters

pTakeIndex index of take to get.

◆ SaveToString()

void SaveToString	(	FBString &	pString,
		FBOptionsContext	context
	)

Serialize all options to a string Serialize all options to a string specifying a context.

Parameters

pString	The string containing all settings, target of serializing
context	The context to be used when serializing

◆ SetAll()

void SetAll	(	FBElementAction	pElementAction,
		bool	pAnimation
	)

Set All Options.

Initialize all loading/saving properties to ElementAction and animation specified.

Parameters

pElementAction	Default value for all FBPropertyElementAction properties.
pAnimation	Default value for all Animation properties.

◆ SetFromString()

void SetFromString	(	const char *	pString,
		FBOptionsContext	context
	)

Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString)

Parameters

pString	The string containing all settings. See SaveToFile
context	The context to be used when de-serializing

◆ SetMultiLoadNamespaceList()

void SetMultiLoadNamespaceList ( const FBStringList & pMultiLoadNamespaceList )

Sets the list of namespaces that will be used when merging multiple scenes (see FBApplication::FileMerge).

The number of namespaces contained in this list must match the number of files merged, otherwise the merge operation will abort. The first namespace in the list will be applied on the first merged scene, the second namespace in the list will be applied on the second merged scene, and so one and so forth. This list is affecting only the merge operation. When merging multiple scenes, if this list of namespaces is set, the FBFbxOptions::NamespaceList property value is ignored.

Parameters

pMultiLoadNamespaceList The multi load namespace list to set.

# This example shows how to merge multiple scenes, each scene in its own user specified namespace:
 
# Create an Load FBFbxOptions object
fbxLoadOptions = FBFbxOptions( True )
 
# Create a list of namespaces (2 items here, so the number of scenes to merge must also be 2)
# and set the list in the FBFbxOptions object
myNS = FBStringList( "MyFirstNS~MySecondNS" )
fbxLoadOptions.SetMultiLoadNamespaceList( myNS )
 
# Create a list of scenes to merge
myScenesToMerge = FBStringList( "C:\Temp\MyFirstScene.fbx~C:\Temp\AnotherScene.fbx" )
 
# Let's merge those scenes. The namespaces will be applied on the scenes' contents.
print FBApplication().FileMerge( myScenesToMerge, False, fbxLoadOptions )

◆ SetNamespaceList()

void SetNamespaceList ( const FBStringList & pNamespaceList )

SetNamespaceList upon save or load On Load, if the SetMultiLoadNamespaceList method is also called, the NamespaceList property is ignored.

Parameters

pNamespaceList namespace list to set

◆ SetObjectsToSave()

void SetObjectsToSave ( FBArrayTemplate< FBComponent * > * pObjectsToSave )

Sets the list of objects that will be saved.

This needs to be set before calling FBApplication::FileSave. The list is affecting only one save operation. Once the save is completed, the list is cleared.

Parameters

pObjectsToSave The objects to save.

◆ SetTakeDescription()

void SetTakeDescription	(	int	pTakeIndex,
		const char *	pDescription
	)

Take Description.

Parameters

pTakeIndex	index of take to set.
pDescription	take description to set

◆ SetTakeDestinationName()

void SetTakeDestinationName	(	int	pTakeIndex,
		const char *	pDestinationName
	)

Take Destination Name upon save or load.

Parameters

pTakeIndex	index of take to set.
pDestinationName	take description to set

◆ SetTakeKeyRange()

void SetTakeKeyRange	(	int	pTakeIndex,
		FBTimeSpan	pKeyTimeSpan
	)

Set take key range.

Parameters

pTakeIndex	index of take to set.
pKeyTimeSpan	Timespan indicating the time range to keep the keys. Keys that are outside the time range for this take will be removed, by default the time range is FBTime::MinusInfinity -> FBTime::Infinity

Remarks: Valid only on load/merge, not when saving a file.

◆ SetTakeName()

void SetTakeName	(	int	pTakeIndex,
		const char *	pName
	)

Take Original Name.

Parameters

pTakeIndex	index of take to set.
pName	take name to set

◆ SetTakeSelect()

void SetTakeSelect	(	int	pTakeIndex,
		bool	pSelect
	)

Return if true if the take will be saved or Loaded.

Parameters

pTakeIndex	index of take to set
pSelect	set true if should be saved or loaded.

Member Data Documentation

◆ ActorFaces

FBPropertyElementAction ActorFaces

Read Write Property: Handling of the Actor Faces elements.

Definition at line 216 of file fbfbxoptions.h.

◆ ActorFacesAnimation

FBPropertyBool ActorFacesAnimation

Read Write Property: Handling of the Actor Faces animation.

Definition at line 249 of file fbfbxoptions.h.

◆ Actors

FBPropertyElementAction Actors

Read Write Property: Handling of the Actors elements.

Definition at line 215 of file fbfbxoptions.h.

◆ Audio

FBPropertyElementAction Audio

Read Write Property: Handling of the Audio elements.

Definition at line 217 of file fbfbxoptions.h.

◆ BaseCameras

FBPropertyBool BaseCameras

Read Write Property: Consider base camera settings.

Definition at line 190 of file fbfbxoptions.h.

◆ Bones

FBPropertyElementAction Bones

Read Write Property: Handling of the Bones elements.

Definition at line 218 of file fbfbxoptions.h.

◆ BonesAnimation

FBPropertyBool BonesAnimation

Read Write Property: Handling of the Bones animation.

Definition at line 250 of file fbfbxoptions.h.

◆ CacheSize

FBPropertyInt CacheSize

Read Write Property: The Cached buffer size used to accelerate IO system.

Definition at line 180 of file fbfbxoptions.h.

◆ Cameras

FBPropertyElementAction Cameras

Read Write Property: Handling of the Cameras elements.

Definition at line 219 of file fbfbxoptions.h.

◆ CamerasAnimation

FBPropertyBool CamerasAnimation

Read Write Property: Handling of the Cameras animation.

Definition at line 251 of file fbfbxoptions.h.

◆ CameraSwitcherSettings

FBPropertyBool CameraSwitcherSettings

Read Write Property: Consider camera switcher settings.

Definition at line 191 of file fbfbxoptions.h.

◆ CharacterExtensions

FBPropertyElementAction CharacterExtensions

Read Write Property: Handling of the Character Extensions.

Definition at line 222 of file fbfbxoptions.h.

◆ CharacterFaces

FBPropertyElementAction CharacterFaces

Read Write Property: Handling of the Character Faces elements.

Definition at line 221 of file fbfbxoptions.h.

◆ CharacterFacesAnimation

FBPropertyBool CharacterFacesAnimation

Read Write Property: Handling of the Character Faces animation.

Definition at line 253 of file fbfbxoptions.h.

◆ Characters

FBPropertyElementAction Characters

Read Write Property: Handling of the Characters elements.

Definition at line 220 of file fbfbxoptions.h.

◆ CharactersAnimation

FBPropertyBool CharactersAnimation

Read Write Property: Handling of the Characters animation.

Definition at line 252 of file fbfbxoptions.h.

◆ ClearSelectionBeforeSave

FBPropertyBool ClearSelectionBeforeSave

Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 273 of file fbfbxoptions.h.

◆ CompressArray

FBPropertyBool CompressArray

Read Write Property: Indicate if the perform compression on the arrays values.

Definition at line 181 of file fbfbxoptions.h.

◆ CompressLevel

FBPropertyInt CompressLevel

Read Write Property: The allowed level range for Compression is [0-9] where 0 equals no compression and 9 is as-much-as-we-can.

Definition at line 183 of file fbfbxoptions.h.

◆ CompressMinSize

FBPropertyInt CompressMinSize

Read Write Property: Indicate if the minimum item size for compressing arrays.

Definition at line 182 of file fbfbxoptions.h.

◆ ConsiderMuteSolo

FBPropertyBool ConsiderMuteSolo

Read Write property: Consider the mute/solo settings to identify identical layer when merging.

Definition at line 209 of file fbfbxoptions.h.

◆ Constraints

FBPropertyElementAction Constraints

Read Write Property: Handling of the Constraints elements.

Definition at line 223 of file fbfbxoptions.h.

◆ ConstraintsAnimation

FBPropertyBool ConstraintsAnimation

Read Write Property: Handling of the Constraints animation.

Definition at line 254 of file fbfbxoptions.h.

◆ CopyCharacterExtensions

FBPropertyBool CopyCharacterExtensions

Read Write Property: pCopyMissingExtensions Set to true if the character extensions on the rig in the file should be copied to the target rig.

Definition at line 287 of file fbfbxoptions.h.

◆ CurrentCameraSettings

FBPropertyBool CurrentCameraSettings

Read Write Property: Consider current camera settings.

Definition at line 192 of file fbfbxoptions.h.

◆ Devices

FBPropertyElementAction Devices

Read Write Property: Handling of the Devices elements.

Definition at line 224 of file fbfbxoptions.h.

◆ DevicesAnimation

FBPropertyBool DevicesAnimation

Read Write Property: Handling of the Devices animation.

Definition at line 255 of file fbfbxoptions.h.

◆ EmbedMedia

FBPropertyBool EmbedMedia

Read Write Property: Embed all media in the FBX file itself. When saving in ASCII mode it is not possible to embed media.

Definition at line 176 of file fbfbxoptions.h.

◆ FileFormatAndVersion

FBPropertyFileFormatAndVersion FileFormatAndVersion

Read Write Property: File format and version chosen to save the scene.

Definition at line 175 of file fbfbxoptions.h.

◆ FileReference

FBPropertyBool FileReference

Read Write property: Load/Save scene as FileReference.

Definition at line 200 of file fbfbxoptions.h.

◆ FileReferenceEdit

FBPropertyBool FileReferenceEdit

Read Write Property: Load/Save the edits made to referenced objects or not.

Definition at line 201 of file fbfbxoptions.h.

◆ FileReferences

FBPropertyElementAction FileReferences

Read Write Property: Handling of the FileReferences elements.

Definition at line 225 of file fbfbxoptions.h.

◆ GlobalLightingSettings

FBPropertyBool GlobalLightingSettings

Read Write Property: Consider global Lighting settings.

Definition at line 193 of file fbfbxoptions.h.

◆ Groups

FBPropertyElementAction Groups

Read Write Property: Handling of the Groups elements.

Definition at line 226 of file fbfbxoptions.h.

◆ IgnoreConflicts

FBPropertyBool IgnoreConflicts

Read Write Property: Set to true to ignore conflicts between objects in character extensions and objects in the scene. Conflicting objects will be merged in the extension

Definition at line 289 of file fbfbxoptions.h.

◆ KeepTransformHierarchy

FBPropertyBool KeepTransformHierarchy

Read Write Property: Indicate whether we keep transform hierarchy when SaveSelectedModelsOnly is true. Default value is false to ensure consistent behavior with SaveSelected operation via file menu.

Definition at line 178 of file fbfbxoptions.h.

◆ KeyingGroups

FBPropertyElementAction KeyingGroups

Read Write Property: Handling of the Keying Groups elements.

Definition at line 227 of file fbfbxoptions.h.

◆ Lights

FBPropertyElementAction Lights

Read Write Property: Handling of the Lights elements.

Definition at line 228 of file fbfbxoptions.h.

◆ LightsAnimation

FBPropertyBool LightsAnimation

Read Write Property: Handling of the Lights animation.

Definition at line 256 of file fbfbxoptions.h.

◆ Materials

FBPropertyElementAction Materials

Read Write Property: Handling of the Materials elements.

Definition at line 229 of file fbfbxoptions.h.

◆ MaterialsAnimation

FBPropertyBool MaterialsAnimation

Read Write Property: Handling of the Materials animation.

Definition at line 257 of file fbfbxoptions.h.

◆ Models

FBPropertyElementAction Models

Read Write Property: Handling of the Models elements.

Definition at line 230 of file fbfbxoptions.h.

◆ ModelsAnimation

FBPropertyBool ModelsAnimation

Read Write Property: Handling of the Models animation.

Definition at line 258 of file fbfbxoptions.h.

◆ NamespaceList

FBPropertyString NamespaceList

Read Write Property: A list of namespaces separated by '~'. On Load, duplicate the loaded objects into each namespace in the list. If the SetMultiLoadNamespaceList method is also called, this property is ignored.

Definition at line 202 of file fbfbxoptions.h.

◆ Notes

FBPropertyElementAction Notes

Read Write Property: Handling of the Notes elements.

Definition at line 231 of file fbfbxoptions.h.

◆ NotesAnimation

FBPropertyBool NotesAnimation

Read Write Property: Handling of the Notes animation.

Definition at line 259 of file fbfbxoptions.h.

◆ OpticalData

FBPropertyElementAction OpticalData

Read Write Property: Handling of the Optical Data elements.

Definition at line 232 of file fbfbxoptions.h.

◆ PhysicalProperties

FBPropertyElementAction PhysicalProperties

Read Write Property: Handling of the Physical Properties elements.

Definition at line 233 of file fbfbxoptions.h.

◆ PhysicalPropertiesAnimation

FBPropertyBool PhysicalPropertiesAnimation

Read Write Property: Handling of the Physical Properties animation.

Definition at line 260 of file fbfbxoptions.h.

◆ Poses

FBPropertyElementAction Poses

Read Write Property: Handling of the Poses elements.

Definition at line 234 of file fbfbxoptions.h.

◆ ProcessAnimationOnExtension

FBPropertyBool ProcessAnimationOnExtension

Read Write Property: Set to true if animation on character extensions should also be transferred.

Definition at line 282 of file fbfbxoptions.h.

◆ RemoveConstraintReference

FBPropertyBool RemoveConstraintReference

Read Write Property: Set to true if we should remove constraint reference.

Definition at line 286 of file fbfbxoptions.h.

◆ RemoveEmptyLayer

FBPropertyBool RemoveEmptyLayer

Read Write property: Remove empty animation layers that are in additive mode, without child or parent.

Definition at line 208 of file fbfbxoptions.h.

◆ ReplaceControlSet

FBPropertyBool ReplaceControlSet

Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 283 of file fbfbxoptions.h.

◆ ResetDOF

FBPropertyBool ResetDOF

Read Write Property: Set to true if we should change the limits on the target rig.

Definition at line 284 of file fbfbxoptions.h.

◆ ResetHierarchy

FBPropertyBool ResetHierarchy

Read Write Property: Set to true if we should reset the character hierarchy.

Definition at line 285 of file fbfbxoptions.h.

◆ RetargetOnBaseLayer

FBPropertyBool RetargetOnBaseLayer

Read Write Property: If the transfer method is retarget, set this parameter to control where the retarget correction will be made (on base layer or on another layer).

Definition at line 288 of file fbfbxoptions.h.

◆ SaveCharacter

FBPropertyBool SaveCharacter

Read Write Property: Set to true if the character should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 270 of file fbfbxoptions.h.

◆ SaveCharacterExtensions

FBPropertyBool SaveCharacterExtensions

Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 272 of file fbfbxoptions.h.

◆ SaveControlSet

FBPropertyBool SaveControlSet

Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.

Definition at line 271 of file fbfbxoptions.h.

◆ SaveSelectedModelsOnly

FBPropertyBool SaveSelectedModelsOnly

Read Write Property: Indicate that only the selected models will be saved.

Definition at line 177 of file fbfbxoptions.h.

◆ Scripts

FBPropertyElementAction Scripts

Read Write Property: Handling of the Scripts elements.

Definition at line 235 of file fbfbxoptions.h.

◆ SetPropertyStaticIfPossible

FBPropertyBool SetPropertyStaticIfPossible

Read Write Property: Set to false if want to keep properties' animated flag even when they are not really animated(no keyframe data) while retrieving/storing.

Definition at line 297 of file fbfbxoptions.h.

◆ Sets

FBPropertyElementAction Sets

Read Write Property: Handling of the Sets elements.

Definition at line 236 of file fbfbxoptions.h.

◆ Shaders

FBPropertyElementAction Shaders

Read Write Property: Handling of the Shaders elements.

Definition at line 237 of file fbfbxoptions.h.

◆ ShadersAnimation

FBPropertyBool ShadersAnimation

Read Write Property: Handling of the Shaders animation.

Definition at line 261 of file fbfbxoptions.h.

◆ ShowFileDialog

FBPropertyBool ShowFileDialog

Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile.

Definition at line 295 of file fbfbxoptions.h.

◆ ShowOptionsDialog

FBPropertyBool ShowOptionsDialog

Read Write Property: Set to true if want to pop up options dialog for detail settings.

Definition at line 296 of file fbfbxoptions.h.

◆ Solvers

FBPropertyElementAction Solvers

Read Write Property: Handling of the Solvers elements.

Definition at line 238 of file fbfbxoptions.h.

◆ SolversAnimation

FBPropertyBool SolversAnimation

Read Write Property: Handling of the Solvers animation.

Definition at line 262 of file fbfbxoptions.h.

◆ Story

FBPropertyElementAction Story

Read Write Property: Handling of the Story elements.

Definition at line 239 of file fbfbxoptions.h.

◆ StoryAnimation

FBPropertyBool StoryAnimation

Read Write Property: Handling of the Story animation (animatable properties on story objects).

Definition at line 263 of file fbfbxoptions.h.

◆ TakeSpan

FBPropertyTakeSpanOnLoad TakeSpan

Read Write Property: Indicate how the take start and end point should be set. By default it is read from the file.

Definition at line 166 of file fbfbxoptions.h.

◆ Textures

FBPropertyElementAction Textures

Read Write Property: Handling of the Textures elements.

Definition at line 240 of file fbfbxoptions.h.

◆ TexturesAnimation

FBPropertyBool TexturesAnimation

Read Write Property: Handling of the Textures animation.

Definition at line 264 of file fbfbxoptions.h.

◆ TransferMethod

FBPropertyCharacterLoadAnimationMethod TransferMethod

Read Write Property: How should the animation should be transfered on the target rig.

Definition at line 281 of file fbfbxoptions.h.

◆ TransportSettings

FBPropertyBool TransportSettings

Read Write Property: Consider transport control settings.

Definition at line 194 of file fbfbxoptions.h.

◆ UpdateRecentFiles

FBPropertyBool UpdateRecentFiles

Read Write Property: Set to true to update recent file list.

Definition at line 160 of file fbfbxoptions.h.

◆ UseASCIIFormat

FBPropertyBool UseASCIIFormat

Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.

Definition at line 179 of file fbfbxoptions.h.

◆ Video

FBPropertyElementAction Video

Read Write Property: Handling of the Video elements.

Definition at line 241 of file fbfbxoptions.h.

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

fbfbxoptions.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBFbxOptions()

Member Function Documentation

◆ GetMultiLoadNamespaceList()

◆ GetNamespaceList()

◆ GetTakeCount()

◆ GetTakeDescription()

◆ GetTakeDestinationName()

◆ GetTakeKeyRange()

◆ GetTakeName()

◆ GetTakeSelect()

◆ SaveToString()

◆ SetAll()

◆ SetFromString()

◆ SetMultiLoadNamespaceList()

◆ SetNamespaceList()

◆ SetObjectsToSave()

◆ SetTakeDescription()

◆ SetTakeDestinationName()

◆ SetTakeKeyRange()

◆ SetTakeName()

◆ SetTakeSelect()

Member Data Documentation

◆ ActorFaces

◆ ActorFacesAnimation

◆ Actors

◆ Audio

◆ BaseCameras

◆ Bones

◆ BonesAnimation

◆ CacheSize

◆ Cameras

◆ CamerasAnimation

◆ CameraSwitcherSettings

◆ CharacterExtensions

◆ CharacterFaces

◆ CharacterFacesAnimation

◆ Characters

◆ CharactersAnimation

◆ ClearSelectionBeforeSave

◆ CompressArray

◆ CompressLevel

◆ CompressMinSize

◆ ConsiderMuteSolo

◆ Constraints

◆ ConstraintsAnimation

◆ CopyCharacterExtensions

◆ CurrentCameraSettings

◆ Devices

◆ DevicesAnimation

◆ EmbedMedia

◆ FileFormatAndVersion

◆ FileReference

◆ FileReferenceEdit

◆ FileReferences

◆ GlobalLightingSettings

◆ Groups

◆ IgnoreConflicts

◆ KeepTransformHierarchy

◆ KeyingGroups

◆ Lights

◆ LightsAnimation

◆ Materials

◆ MaterialsAnimation

◆ Models

◆ ModelsAnimation

◆ NamespaceList

◆ Notes

◆ NotesAnimation

◆ OpticalData

◆ PhysicalProperties

◆ PhysicalPropertiesAnimation

◆ Poses

◆ ProcessAnimationOnExtension

◆ RemoveConstraintReference

◆ RemoveEmptyLayer