#include <mobu-python-api.h>

Class Description

Customize file loading and saving.

Inheritance diagram for FBFbxOptions:

Public Member Functions
	__reduce__ ()

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

	__init__ (...)
	Constructor. More...

	SetAll (FBFbxOptions arg1, FBElementAction arg2, object arg3)
	Set All Options. More...

	SetFromString (FBFbxOptions arg1, str arg2)
	Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString) More...

str	SaveToString (FBFbxOptions arg1)
	Serialize all options to a string Serialize all options to a string specifying a context. More...

int	GetTakeCount (FBFbxOptions arg1)
	Return the count of takes in the scene to saved or the file to loaded. More...

bool	GetTakeSelect (FBFbxOptions arg1, object arg2)
	Return if true if the take will be saved or Loaded. More...

	SetTakeSelect (FBFbxOptions arg1, object arg2, object arg3)
	Return if true if the take will be saved or Loaded. More...

str	GetTakeName (FBFbxOptions arg1, object arg2)
	Take Original Name. More...

	SetTakeName (FBFbxOptions arg1, object arg2, str arg3)
	Take Original Name. More...

str	GetTakeDescription (FBFbxOptions arg1, object arg2)
	Take Description. More...

	SetTakeDescription (FBFbxOptions arg1, object arg2, str arg3)
	Take Description. More...

str	GetTakeDestinationName (FBFbxOptions arg1, object arg2)
	Take Destination Name upon save or load. More...

	SetTakeDestinationName (FBFbxOptions arg1, object arg2, str arg3)
	Take Destination Name upon save or load. More...

	SetObjectsToSave (FBFbxOptions arg1, list arg2)
	Sets the list of objects that will be saved. More...

	SetMultiLoadNamespaceList (FBFbxOptions arg1, FBStringList arg2)
	Sets the list of namespaces that will be used when merging multiple scenes (see FBApplication::FileMerge). More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

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

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

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

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

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

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

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

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

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

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

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

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

FBPropertyBool	ActorFacesAnimation
	Read Write Property: Handling of the Actor Faces animation. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

FBPropertyBool	GlobalLightingSettings
	Read Write Property: Consider global Lighting settings. 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...

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

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

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

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

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

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

FBPropertyBool	NotesAnimation
	Read Write Property: Handling of the Notes animation. 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...

FBPropertyBool	PhysicalPropertiesAnimation
	Read Write Property: Handling of the Physical Properties animation. 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...

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

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

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

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

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

FBPropertyTakeSpanOnLoad	TakeSpan
	Read Write Property: Indicate how the take start and end point should be set. More...

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

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

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

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

FBPropertyBool	EmbedMedia
	Read Write Property: Embed all media in the FBX file itself. More...

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

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

FBPropertyFileFormatAndVersion	FileFormatAndVersion
	Read Write Property: File format and version chosen to save the scene. 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. More...

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

ORSDK2018::FBPropertyString	NamespaceList
	Read Write Property: A list of namespaces separated by '~'. More...

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

FBPropertyBool	RemoveEmptyLayer
	Read Write property: Remove empty animation layers that are in additive mode, without child or parent. 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...

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

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

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

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

Public Attributes inherited from FBComponent
object	OwnerNamespace

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

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

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

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

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__ ( ... )

Constructor.

Python Docstring:

__init__( (object)arg1, (object)arg2) -> None

__init__( (object)arg1, (object)arg2, (str)arg3) -> None

C++ Signature:

 FBFbxOptions(bool pLoad, const char * pFilePathToLoad = ((void *) 0), HIObject pObject = ((void *) 0))

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.

See the C++ reference

__reduce__ ( )

FBStringList GetMultiLoadNamespaceList ( FBFbxOptions arg1 )

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

Python Docstring:

GetMultiLoadNamespaceList( (FBFbxOptions)arg1) -> FBStringList

C++ Signature:

ORSDK2018::FBStringList GetMultiLoadNamespaceList()

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.

See the C++ reference

int GetTakeCount ( FBFbxOptions arg1 )

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

Python Docstring:

GetTakeCount( (FBFbxOptions)arg1) -> int

C++ Signature:

int GetTakeCount()

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

See the C++ reference

str GetTakeDescription	(	FBFbxOptions	arg1,
		object	arg2
	)

Take Description.

Python Docstring:

GetTakeDescription( (FBFbxOptions)arg1, (object)arg2) -> str

C++ Signature:

const char * GetTakeDescription(int pTakeIndex)

Parameters

pTakeIndex index of take to get.

See the C++ reference

str GetTakeDestinationName	(	FBFbxOptions	arg1,
		object	arg2
	)

Take Destination Name upon save or load.

Python Docstring:

GetTakeDestinationName( (FBFbxOptions)arg1, (object)arg2) -> str

C++ Signature:

const char * GetTakeDestinationName(int pTakeIndex)

Parameters

pTakeIndex index of take to get.

See the C++ reference

str GetTakeName	(	FBFbxOptions	arg1,
		object	arg2
	)

Take Original Name.

Python Docstring:

GetTakeName( (FBFbxOptions)arg1, (object)arg2) -> str

C++ Signature:

const char * GetTakeName(int pTakeIndex)

Parameters

pTakeIndex index of take to get.

See the C++ reference

bool GetTakeSelect	(	FBFbxOptions	arg1,
		object	arg2
	)

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

Python Docstring:

GetTakeSelect( (FBFbxOptions)arg1, (object)arg2) -> bool

C++ Signature:

bool GetTakeSelect(int pTakeIndex)

Parameters

pTakeIndex index of take to get.

See the C++ reference

str SaveToString ( FBFbxOptions arg1 )

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

Python Docstring:

SaveToString( (FBFbxOptions)arg1) -> str

C++ Signature:

void SaveToString(ORSDK2018::FBString & pString, FBOptionsContext context)

Parameters

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

See the C++ reference

SetAll	(	FBFbxOptions	arg1,
		FBElementAction	arg2,
		object	arg3
	)

Set All Options.

Python Docstring:

SetAll( (FBFbxOptions)arg1, (FBElementAction)arg2, (object)arg3) -> None

C++ Signature:

void SetAll(FBElementAction pElementAction, bool pAnimation)

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.

See the C++ reference

SetFromString	(	FBFbxOptions	arg1,
		str	arg2
	)

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

Python Docstring:

SetFromString( (FBFbxOptions)arg1, (str)arg2) -> None

C++ Signature:

void SetFromString(const char * pString, FBOptionsContext context)

Parameters

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

See the C++ reference

SetMultiLoadNamespaceList	(	FBFbxOptions	arg1,
		FBStringList	arg2
	)

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

Python Docstring:

SetMultiLoadNamespaceList( (FBFbxOptions)arg1, (FBStringList)arg2) -> None

C++ Signature:

void SetMultiLoadNamespaceList(const ORSDK2018::FBStringList & pMultiLoadNamespaceList)

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 )

See the C++ reference

SetObjectsToSave	(	FBFbxOptions	arg1,
		list	arg2
	)

Sets the list of objects that will be saved.

Python Docstring:

SetObjectsToSave( (FBFbxOptions)arg1, (list)arg2) -> None

C++ Signature:

void SetObjectsToSave(ORSDK2018::FBArrayTemplate< ORSDK2018::FBComponent * > * pObjectsToSave)

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.

See the C++ reference

SetTakeDescription	(	FBFbxOptions	arg1,
		object	arg2,
		str	arg3
	)

Take Description.

Python Docstring:

SetTakeDescription( (FBFbxOptions)arg1, (object)arg2, (str)arg3) -> None

C++ Signature:

void SetTakeDescription(int pTakeIndex, const char * pDescription)

Parameters

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

See the C++ reference

SetTakeDestinationName	(	FBFbxOptions	arg1,
		object	arg2,
		str	arg3
	)

Take Destination Name upon save or load.

Python Docstring:

SetTakeDestinationName( (FBFbxOptions)arg1, (object)arg2, (str)arg3) -> None

C++ Signature:

void SetTakeDestinationName(int pTakeIndex, const char * pDestinationName)

Parameters

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

See the C++ reference

SetTakeName	(	FBFbxOptions	arg1,
		object	arg2,
		str	arg3
	)

Take Original Name.

Python Docstring:

SetTakeName( (FBFbxOptions)arg1, (object)arg2, (str)arg3) -> None

C++ Signature:

void SetTakeName(int pTakeIndex, const char * pName)

Parameters

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

See the C++ reference

SetTakeSelect	(	FBFbxOptions	arg1,
		object	arg2,
		object	arg3
	)

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

Python Docstring:

SetTakeSelect( (FBFbxOptions)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void SetTakeSelect(int pTakeIndex, bool pSelect)

Parameters

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

See the C++ reference

Member Data Documentation

FBPropertyElementAction ActorFaces

Read Write Property: Handling of the Actor Faces elements.

See the C++ reference

FBPropertyBool ActorFacesAnimation

Read Write Property: Handling of the Actor Faces animation.

See the C++ reference

FBPropertyElementAction Actors

Read Write Property: Handling of the Actors elements.

See the C++ reference

FBPropertyElementAction Audio

Read Write Property: Handling of the Audio elements.

See the C++ reference

FBPropertyBool BaseCameras

Read Write Property: Consider base camera settings.

See the C++ reference

FBPropertyElementAction Bones

Read Write Property: Handling of the Bones elements.

See the C++ reference

FBPropertyBool BonesAnimation

Read Write Property: Handling of the Bones animation.

See the C++ reference

FBPropertyInt CacheSize

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

See the C++ reference

FBPropertyElementAction Cameras

Read Write Property: Handling of the Cameras elements.

See the C++ reference

FBPropertyBool CamerasAnimation

Read Write Property: Handling of the Cameras animation.

See the C++ reference

FBPropertyBool CameraSwitcherSettings

Read Write Property: Consider camera switcher settings.

See the C++ reference

FBPropertyElementAction CharacterExtensions

Read Write Property: Handling of the Character Extensions.

See the C++ reference

FBPropertyElementAction CharacterFaces

Read Write Property: Handling of the Character Faces elements.

See the C++ reference

FBPropertyBool CharacterFacesAnimation

Read Write Property: Handling of the Character Faces animation.

See the C++ reference

FBPropertyElementAction Characters

Read Write Property: Handling of the Characters elements.

See the C++ reference

FBPropertyBool CharactersAnimation

Read Write Property: Handling of the Characters animation.

See the C++ reference

FBPropertyBool ClearSelectionBeforeSave

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

See the C++ reference

FBPropertyBool ConsiderMuteSolo

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

See the C++ reference

FBPropertyElementAction Constraints

Read Write Property: Handling of the Constraints elements.

See the C++ reference

FBPropertyBool ConstraintsAnimation

Read Write Property: Handling of the Constraints animation.

See the C++ reference

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.

See the C++ reference

FBPropertyBool CurrentCameraSettings

Read Write Property: Consider current camera settings.

See the C++ reference

FBPropertyElementAction Devices

Read Write Property: Handling of the Devices elements.

See the C++ reference

FBPropertyBool DevicesAnimation

Read Write Property: Handling of the Devices animation.

See the C++ reference

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.

See the C++ reference

FBPropertyFileFormatAndVersion FileFormatAndVersion

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

See the C++ reference

FBPropertyBool FileReference

Read Write property: Load/Save scene as FileReference.

See the C++ reference

FBPropertyBool FileReferenceEdit

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

See the C++ reference

FBPropertyElementAction FileReferences

Read Write Property: Handling of the FileReferences elements.

See the C++ reference

FBPropertyBool GlobalLightingSettings

Read Write Property: Consider global Lighting settings.

See the C++ reference

FBPropertyElementAction Groups

Read Write Property: Handling of the Groups elements.

See the C++ reference

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

See the C++ reference

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.

See the C++ reference

FBPropertyElementAction KeyingGroups

Read Write Property: Handling of the Keying Groups elements.

See the C++ reference

FBPropertyElementAction Lights

Read Write Property: Handling of the Lights elements.

See the C++ reference

FBPropertyBool LightsAnimation

Read Write Property: Handling of the Lights animation.

See the C++ reference

FBPropertyElementAction Materials

Read Write Property: Handling of the Materials elements.

See the C++ reference

FBPropertyBool MaterialsAnimation

Read Write Property: Handling of the Materials animation.

See the C++ reference

FBPropertyElementAction Models

Read Write Property: Handling of the Models elements.

See the C++ reference

FBPropertyBool ModelsAnimation

Read Write Property: Handling of the Models animation.

See the C++ reference

ORSDK2018::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.

See the C++ reference

FBPropertyElementAction Notes

Read Write Property: Handling of the Notes elements.

See the C++ reference

FBPropertyBool NotesAnimation

Read Write Property: Handling of the Notes animation.

See the C++ reference

FBPropertyElementAction OpticalData

Read Write Property: Handling of the Optical Data elements.

See the C++ reference

FBPropertyElementAction PhysicalProperties

Read Write Property: Handling of the Physical Properties elements.

See the C++ reference

FBPropertyBool PhysicalPropertiesAnimation

Read Write Property: Handling of the Physical Properties animation.

See the C++ reference

FBPropertyElementAction Poses

Read Write Property: Handling of the Poses elements.

See the C++ reference

FBPropertyBool ProcessAnimationOnExtension

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

See the C++ reference

FBPropertyBool RemoveConstraintReference

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

See the C++ reference

FBPropertyBool RemoveEmptyLayer

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

See the C++ reference

FBPropertyBool ReplaceControlSet

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

See the C++ reference

FBPropertyBool ResetDOF

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

See the C++ reference

FBPropertyBool ResetHierarchy

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

See the C++ reference

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

See the C++ reference

FBPropertyBool SaveCharacter

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

See the C++ reference

FBPropertyBool SaveCharacterExtensions

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

See the C++ reference

FBPropertyBool SaveControlSet

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

See the C++ reference

FBPropertyBool SaveSelectedModelsOnly

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

See the C++ reference

FBPropertyElementAction Scripts

Read Write Property: Handling of the Scripts elements.

See the C++ reference

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.

See the C++ reference

FBPropertyElementAction Sets

Read Write Property: Handling of the Sets elements.

See the C++ reference

FBPropertyElementAction Shaders

Read Write Property: Handling of the Shaders elements.

See the C++ reference

FBPropertyBool ShadersAnimation

Read Write Property: Handling of the Shaders animation.

See the C++ reference

FBPropertyBool ShowFileDialog

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