Customize file loading and saving.
Public Member Functions | |
int | GetTakeCount () |
Return the count of takes in the scene to saved or the file to loaded. | |
bool | GetTakeSelect (int pTakeIndex) |
Return if true if the take will be saved or Loaded. | |
SetTakeSelect (int pTakeIndex, bool pSelect) | |
Return if true if the take will be saved or Loaded. | |
str | GetTakeName (int pTakeIndex) |
Take Original Name. | |
SetTakeName (int pTakeIndex, str pName) | |
Take Original Name. | |
str | GetTakeDescription (int pTakeIndex) |
Take Description. | |
SetTakeDescription (int pTakeIndex, str pDescription) | |
Take Description. | |
str | GetTakeDestinationName (int pTakeIndex) |
Take Destination Name upon save or load. | |
SetTakeDestinationName (int pTakeIndex, str pDestinationName) | |
Take Destination Name upon save or load. | |
__init__ (bool pLoad, str pFilePathToLoad=None, object pObject=None) | |
Constructor. | |
SetAll (FBElementAction pElementAction, bool pAnimation) | |
Set All Options. | |
SaveToString (str pString, FBOptionsContext context) | |
Serialize all options to a string Serialize all options to a string specifying a context. | |
SetFromString (str pString, FBOptionsContext context) | |
Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString). | |
SetNamespaceList (FBStringList pNamespaceList) | |
SetNamespaceList upon save or load. | |
FBStringList | GetNamespaceList () |
GetNamespaceList upon save or load. | |
Public Attributes | |
FBPropertyBase | UpdateRecentFiles |
Read Write Property: Set to true to update recent file list. | |
FBPropertyTakeSpanOnLoad | TakeSpan |
Read Write Property: Indicate how the take start and end point should be set. | |
FBPropertyFileFormatAndVersion | FileFormatAndVersion |
Read Write Property: File format and version chosen to save the scene. | |
FBPropertyBase | EmbedMedia |
Read Write Property: Embed all media in the FBX file itself. | |
FBPropertyBase | SaveSelectedModelsOnly |
Read Write Property: Indicate that only the selected models will be saved. | |
FBPropertyBase | KeepTransformHierarchy |
Read Write Property: Indicate whether we keep transform hierarchy when SaveSelectedModelsOnly is true. | |
FBPropertyBase | UseASCIIFormat |
Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode. | |
FBPropertyBase | CacheSize |
Read Write Property: The Cached buffer size used to accelerate IO system. | |
FBPropertyBase | CompressArray |
Read Write Property: Indicate if the perform compression on the arrays values. | |
FBPropertyBase | CompressMinSize |
Read Write Property: Indicate if the minimum item size for compressing arrays. | |
FBPropertyBase | 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. | |
FBPropertyBase | BaseCameras |
Read Write Property: Consider base camera settings. | |
FBPropertyBase | CameraSwitcherSettings |
Read Write Property: Consider camera switcher settings. | |
FBPropertyBase | CurrentCameraSettings |
Read Write Property: Consider current camera settings. | |
FBPropertyBase | GlobalLightingSettings |
Read Write Property: Consider global Lighting settings. | |
FBPropertyBase | TransportSettings |
Read Write Property: Consider transport control settings. | |
FBPropertyBase | FileReference |
Read Write property: Load/Save scene as FileReference. | |
FBPropertyBase | FileReferenceEdit |
Read Write Property: Load/Save the edits made to referenced objects or not. | |
FBPropertyString | NamespaceList |
Read Write Property: A list of namespaces separated by '~', On Load, duplicate the loaded objects into each namespace in the list. | |
FBPropertyBase | RemoveEmptyLayer |
Read Write property: Remove empty animation layers that are in additive mode, without child or parent. | |
FBPropertyBase | ConsiderMuteSolo |
Read Write property: Consider the mute/solo settings to identify identical layer when merging. | |
FBPropertyElementAction | Actors |
Read Write Property: Handling of the Actors elements. | |
FBPropertyElementAction | ActorFaces |
Read Write Property: Handling of the Actor Faces elements. | |
FBPropertyElementAction | Audio |
Read Write Property: Handling of the Audio elements. | |
FBPropertyElementAction | Bones |
Read Write Property: Handling of the Bones elements. | |
FBPropertyElementAction | Cameras |
Read Write Property: Handling of the Cameras elements. | |
FBPropertyElementAction | Characters |
Read Write Property: Handling of the Characters elements. | |
FBPropertyElementAction | CharacterFaces |
Read Write Property: Handling of the Character Faces elements. | |
FBPropertyElementAction | CharacterExtensions |
Read Write Property: Handling of the Character Extensions. | |
FBPropertyElementAction | Constraints |
Read Write Property: Handling of the Constraints elements. | |
FBPropertyElementAction | Devices |
Read Write Property: Handling of the Devices elements. | |
FBPropertyElementAction | FileReferences |
Read Write Property: Handling of the FileReferences elements. | |
FBPropertyElementAction | Groups |
Read Write Property: Handling of the Groups elements. | |
FBPropertyElementAction | KeyingGroups |
Read Write Property: Handling of the Keying Groups elements. | |
FBPropertyElementAction | Lights |
Read Write Property: Handling of the Lights elements. | |
FBPropertyElementAction | Materials |
Read Write Property: Handling of the Materials elements. | |
FBPropertyElementAction | Models |
Read Write Property: Handling of the Models elements. | |
FBPropertyElementAction | Notes |
Read Write Property: Handling of the Notes elements. | |
FBPropertyElementAction | OpticalData |
Read Write Property: Handling of the Optical Data elements. | |
FBPropertyElementAction | PhysicalProperties |
Read Write Property: Handling of the Physical Properties elements. | |
FBPropertyElementAction | Poses |
Read Write Property: Handling of the Poses elements. | |
FBPropertyElementAction | Scripts |
Read Write Property: Handling of the Scripts elements. | |
FBPropertyElementAction | Sets |
Read Write Property: Handling of the Sets elements. | |
FBPropertyElementAction | Shaders |
Read Write Property: Handling of the Shaders elements. | |
FBPropertyElementAction | Solvers |
Read Write Property: Handling of the Solvers elements. | |
FBPropertyElementAction | Story |
Read Write Property: Handling of the Story elements. | |
FBPropertyElementAction | Textures |
Read Write Property: Handling of the Textures elements. | |
FBPropertyElementAction | Video |
Read Write Property: Handling of the Video elements. | |
FBPropertyBase | ActorFacesAnimation |
Read Write Property: Handling of the Actor Faces animation. | |
FBPropertyBase | BonesAnimation |
Read Write Property: Handling of the Bones animation. | |
FBPropertyBase | CamerasAnimation |
Read Write Property: Handling of the Cameras animation. | |
FBPropertyBase | CharactersAnimation |
Read Write Property: Handling of the Characters animation. | |
FBPropertyBase | CharacterFacesAnimation |
Read Write Property: Handling of the Character Faces animation. | |
FBPropertyBase | ConstraintsAnimation |
Read Write Property: Handling of the Constraints animation. | |
FBPropertyBase | DevicesAnimation |
Read Write Property: Handling of the Devices animation. | |
FBPropertyBase | LightsAnimation |
Read Write Property: Handling of the Lights animation. | |
FBPropertyBase | MaterialsAnimation |
Read Write Property: Handling of the Materials animation. | |
FBPropertyBase | ModelsAnimation |
Read Write Property: Handling of the Models animation. | |
FBPropertyBase | NotesAnimation |
Read Write Property: Handling of the Notes animation. | |
FBPropertyBase | PhysicalPropertiesAnimation |
Read Write Property: Handling of the Physical Properties animation. | |
FBPropertyBase | ShadersAnimation |
Read Write Property: Handling of the Shaders animation. | |
FBPropertyBase | SolversAnimation |
Read Write Property: Handling of the Solvers animation. | |
FBPropertyBase | StoryAnimation |
Read Write Property: Handling of the Story animation (animatable properties on story objects). | |
FBPropertyBase | TexturesAnimation |
Read Write Property: Handling of the Textures animation. | |
FBPropertyBase | SaveCharacter |
Read Write Property: Set to true if the character should be saved when call FBApplication.SaveCharacterRigAndAnimation. | |
FBPropertyBase | SaveControlSet |
Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication.SaveCharacterRigAndAnimation. | |
FBPropertyBase | SaveCharacterExtensions |
Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication.SaveCharacterRigAndAnimation. | |
FBPropertyBase | ClearSelectionBeforeSave |
Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication.SaveCharacterRigAndAnimation. | |
FBPropertyCharacterLoadAnimationMethod | TransferMethod |
Read Write Property: How should the animation should be transfered on the target rig. | |
FBPropertyBase | ProcessAnimationOnExtension |
Read Write Property: Set to true if animation on character extensions should also be transferred. | |
FBPropertyBase | ReplaceControlSet |
Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication.SaveCharacterRigAndAnimation. | |
FBPropertyBase | ResetDOF |
Read Write Property: Set to true if we should change the limits on the target rig. | |
FBPropertyBase | ResetHierarchy |
Read Write Property: Set to true if we should reset the character hierarchy. | |
FBPropertyBase | RemoveConstraintReference |
Read Write Property: Set to true if we should remove constraint reference. | |
FBPropertyBase | 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. | |
FBPropertyBase | 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). | |
FBPropertyBase | IgnoreConflicts |
Read Write Property: Set to true to ignore conflicts between objects in character extensions and objects in the scene. | |
FBPropertyBase | ShowFileDialog |
Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile. | |
FBPropertyBase | ShowOptionsDialog |
Read Write Property: Set to true if want to pop up options dialog for detail settings. | |
FBPropertyBase | 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. |
int GetTakeCount | ( | ) |
Return the count of takes in the scene to saved or the file to loaded.
Return if true if the take will be saved or Loaded.
pTakeIndex | index of take to get. |
Return if true if the take will be saved or Loaded.
pTakeIndex | index of take to set |
pSelect | set true if should be saved or loaded. |
Take Original Name.
pTakeIndex | index of take to set. |
pName | take name to set |
Take Description.
pTakeIndex | index of take to set. |
pDescription | take description to set |
Take Destination Name upon save or load.
pTakeIndex | index of take to get. |
Take Destination Name upon save or load.
pTakeIndex | index of take to set. |
pDestinationName | take description to set |
Constructor.
Create a FBFbxOption to be used in FBApplication Save/Load with default settings.
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. |
SetAll | ( | FBElementAction | pElementAction, |
bool | pAnimation | ||
) |
Set All Options.
Initialize all loading/saving properties to ElementAction and animation specified.
pElementAction | Default value for all FBPropertyElementAction properties. |
pAnimation | Default value for all Animation properties. |
SaveToString | ( | str | pString, |
FBOptionsContext | context | ||
) |
Serialize all options to a string Serialize all options to a string specifying a context.
pString | The string containing all settings, target of serializing |
context | The context to be used when serializing |
SetFromString | ( | str | pString, |
FBOptionsContext | context | ||
) |
Set all options from string Set all parameters from a formatted string (previously serialized with SaveToString).
pString | The string containing all settings. See SaveToFile |
context | The context to be used when de-serializing |
SetNamespaceList | ( | FBStringList | pNamespaceList | ) |
SetNamespaceList upon save or load.
pNamespaceList | namespace list to set |
FBStringList GetNamespaceList | ( | ) |
FBPropertyBase UpdateRecentFiles |
Read Write Property: Set to true to update recent file list.
FBPropertyTakeSpanOnLoad TakeSpan |
Read Write Property: Indicate how the take start and end point should be set.
By default it is read from the file.
FBPropertyFileFormatAndVersion FileFormatAndVersion |
Read Write Property: File format and version chosen to save the scene.
FBPropertyBase EmbedMedia |
Read Write Property: Embed all media in the FBX file itself.
When saving in ASCII mode it is not possible to embed media.
FBPropertyBase SaveSelectedModelsOnly |
Read Write Property: Indicate that only the selected models will be saved.
FBPropertyBase 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.
FBPropertyBase UseASCIIFormat |
Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.
FBPropertyBase CacheSize |
Read Write Property: The Cached buffer size used to accelerate IO system.
FBPropertyBase CompressArray |
Read Write Property: Indicate if the perform compression on the arrays values.
FBPropertyBase CompressMinSize |
Read Write Property: Indicate if the minimum item size for compressing arrays.
FBPropertyBase 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.
FBPropertyBase BaseCameras |
Read Write Property: Consider base camera settings.
FBPropertyBase CameraSwitcherSettings |
Read Write Property: Consider camera switcher settings.
FBPropertyBase CurrentCameraSettings |
Read Write Property: Consider current camera settings.
FBPropertyBase GlobalLightingSettings |
Read Write Property: Consider global Lighting settings.
FBPropertyBase TransportSettings |
Read Write Property: Consider transport control settings.
FBPropertyBase FileReference |
Read Write property: Load/Save scene as FileReference.
FBPropertyBase FileReferenceEdit |
Read Write Property: Load/Save the edits made to referenced objects or not.
Read Write Property: A list of namespaces separated by '~', On Load, duplicate the loaded objects into each namespace in the list.
FBPropertyBase RemoveEmptyLayer |
Read Write property: Remove empty animation layers that are in additive mode, without child or parent.
FBPropertyBase ConsiderMuteSolo |
Read Write property: Consider the mute/solo settings to identify identical layer when merging.
FBPropertyElementAction Actors |
Read Write Property: Handling of the Actors elements.
FBPropertyElementAction ActorFaces |
Read Write Property: Handling of the Actor Faces elements.
FBPropertyElementAction Audio |
Read Write Property: Handling of the Audio elements.
FBPropertyElementAction Bones |
Read Write Property: Handling of the Bones elements.
FBPropertyElementAction Cameras |
Read Write Property: Handling of the Cameras elements.
FBPropertyElementAction Characters |
Read Write Property: Handling of the Characters elements.
FBPropertyElementAction CharacterFaces |
Read Write Property: Handling of the Character Faces elements.
FBPropertyElementAction CharacterExtensions |
Read Write Property: Handling of the Character Extensions.
FBPropertyElementAction Constraints |
Read Write Property: Handling of the Constraints elements.
FBPropertyElementAction Devices |
Read Write Property: Handling of the Devices elements.
FBPropertyElementAction FileReferences |
Read Write Property: Handling of the FileReferences elements.
FBPropertyElementAction Groups |
Read Write Property: Handling of the Groups elements.
FBPropertyElementAction KeyingGroups |
Read Write Property: Handling of the Keying Groups elements.
FBPropertyElementAction Lights |
Read Write Property: Handling of the Lights elements.
FBPropertyElementAction Materials |
Read Write Property: Handling of the Materials elements.
FBPropertyElementAction Models |
Read Write Property: Handling of the Models elements.
FBPropertyElementAction Notes |
Read Write Property: Handling of the Notes elements.
FBPropertyElementAction OpticalData |
Read Write Property: Handling of the Optical Data elements.
FBPropertyElementAction PhysicalProperties |
Read Write Property: Handling of the Physical Properties elements.
FBPropertyElementAction Poses |
Read Write Property: Handling of the Poses elements.
FBPropertyElementAction Scripts |
Read Write Property: Handling of the Scripts elements.
FBPropertyElementAction Sets |
Read Write Property: Handling of the Sets elements.
FBPropertyElementAction Shaders |
Read Write Property: Handling of the Shaders elements.
FBPropertyElementAction Solvers |
Read Write Property: Handling of the Solvers elements.
FBPropertyElementAction Story |
Read Write Property: Handling of the Story elements.
FBPropertyElementAction Textures |
Read Write Property: Handling of the Textures elements.
FBPropertyElementAction Video |
Read Write Property: Handling of the Video elements.
FBPropertyBase ActorFacesAnimation |
Read Write Property: Handling of the Actor Faces animation.
FBPropertyBase BonesAnimation |
Read Write Property: Handling of the Bones animation.
FBPropertyBase CamerasAnimation |
Read Write Property: Handling of the Cameras animation.
FBPropertyBase CharactersAnimation |
Read Write Property: Handling of the Characters animation.
FBPropertyBase CharacterFacesAnimation |
Read Write Property: Handling of the Character Faces animation.
FBPropertyBase ConstraintsAnimation |
Read Write Property: Handling of the Constraints animation.
FBPropertyBase DevicesAnimation |
Read Write Property: Handling of the Devices animation.
FBPropertyBase LightsAnimation |
Read Write Property: Handling of the Lights animation.
FBPropertyBase MaterialsAnimation |
Read Write Property: Handling of the Materials animation.
FBPropertyBase ModelsAnimation |
Read Write Property: Handling of the Models animation.
FBPropertyBase NotesAnimation |
Read Write Property: Handling of the Notes animation.
FBPropertyBase PhysicalPropertiesAnimation |
Read Write Property: Handling of the Physical Properties animation.
FBPropertyBase ShadersAnimation |
Read Write Property: Handling of the Shaders animation.
FBPropertyBase SolversAnimation |
Read Write Property: Handling of the Solvers animation.
FBPropertyBase StoryAnimation |
Read Write Property: Handling of the Story animation (animatable properties on story objects).
FBPropertyBase TexturesAnimation |
Read Write Property: Handling of the Textures animation.
FBPropertyBase SaveCharacter |
Read Write Property: Set to true if the character should be saved when call FBApplication.SaveCharacterRigAndAnimation.
FBPropertyBase SaveControlSet |
Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication.SaveCharacterRigAndAnimation.
FBPropertyBase SaveCharacterExtensions |
Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication.SaveCharacterRigAndAnimation.
FBPropertyBase ClearSelectionBeforeSave |
Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication.SaveCharacterRigAndAnimation.
FBPropertyCharacterLoadAnimationMethod TransferMethod |
Read Write Property: How should the animation should be transfered on the target rig.
FBPropertyBase ProcessAnimationOnExtension |
Read Write Property: Set to true if animation on character extensions should also be transferred.
FBPropertyBase ReplaceControlSet |
Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication.SaveCharacterRigAndAnimation.
FBPropertyBase ResetDOF |
Read Write Property: Set to true if we should change the limits on the target rig.
FBPropertyBase ResetHierarchy |
Read Write Property: Set to true if we should reset the character hierarchy.
FBPropertyBase RemoveConstraintReference |
Read Write Property: Set to true if we should remove constraint reference.
FBPropertyBase 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.
FBPropertyBase 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).
FBPropertyBase 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
FBPropertyBase ShowFileDialog |
Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile.
FBPropertyBase ShowOptionsDialog |
Read Write Property: Set to true if want to pop up options dialog for detail settings.
FBPropertyBase 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.