This reference page is linked to from the following overview topics: File Input and Output, Saving to a File, File Options.
Detailed Description
Customize file loading and saving.
Definition at line 105 of file fbfbxoptions.h.
#include <fbfbxoptions.h>
Public Member Functions |
|
| FBFbxOptions (bool pLoad, const char *pFilePathToLoad=NULL, HIObject pObject=NULL) | |
| Constructor. |
|
| void | SetAll (FBElementAction pElementAction, bool pAnimation) |
| Set All Options. |
|
|
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. |
|
| bool | GetTakeSelect (int pTakeIndex) const |
| Return if true if the take will be saved or
Loaded. |
|
| void | SetTakeSelect (int pTakeIndex, bool pSelect) |
| Return if true if the take will be saved or
Loaded. |
|
| const char * | GetTakeName (int pTakeIndex) const |
| Take Original Name. |
|
| void | SetTakeName (int pTakeIndex, const char *pName) |
| Take Original Name. |
|
| const char * | GetTakeDescription (int pTakeIndex) const |
| Take Description. |
|
| void | SetTakeDescription (int pTakeIndex, const char *pDescription) |
| Take Description. |
|
| const char * | GetTakeDestinationName (int pTakeIndex) const |
| Take Destination Name upon save or load.
|
|
| void | SetTakeDestinationName (int pTakeIndex, const char *pDestinationName) |
| Take Destination Name upon save or load.
|
|
Public Attributes |
|
| FBPropertyString | CustomImportNamespace |
| Read Write Property: Namespace we
append to every objects on a Load (import/open/merge) |
|
|
Load specific options.
|
|
|
|
| FBPropertyTakeSpanOnLoad | TakeSpan |
| Read Write Property: Indicate how the
take start and end point should be set. |
|
|
Save specific options.
|
|
|
All of these options are false by default, except for 'EmbedMedia' which is true by default.
|
|
| FBPropertyFileFormatAndVersion | FileFormatAndVersion |
| Read Write Property: File format and
version choosed to save the scene. |
|
| FBPropertyBool | EmbedMedia |
| Read Write Property: Embed all media
in the FBX file itself. |
|
| FBPropertyBool | SaveSelectedModelsOnly |
| Read Write Property: Indicate that
only the selected models will be saved. |
|
| FBPropertyBool | UseASCIIFormat |
| Read Write Property: Indicate if the
resulting FBX file will be in binary or ASCII mode. |
|
| FBPropertyInt | CacheSize |
| Read Write Property: The Cached
buffer size used to accelerate IO system. |
|
| FBPropertyBool | CompressArray |
| Read Write Property: Indicate if the
perform comporession on the arrays values. |
|
| FBPropertyInt | CompressMinSize |
| Read Write Property: Indicate if the
minimum item size for compressing arrays. |
|
| 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. |
|
|
Scene settings options.
|
|
| FBPropertyBool | BaseCameras |
| Read Write Property: Consider base
camera settings. |
|
| FBPropertyBool | CameraSwitcherSettings |
| Read Write Property: Consider camera
switcher settings. |
|
| FBPropertyBool | CurrentCameraSettings |
| Read Write Property: Consider current
camera settings. |
|
| FBPropertyBool | GlobalLightingSettings |
| Read Write Property: Consider global
Lighting settings. |
|
| FBPropertyBool | TransportSettings |
| Read Write Property: Consider
transport control settings. |
|
|
Element settings options.
|
|
| 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 | 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. |
|
|
Element animation settings options.
|
|
|
Not all elements type have animation associated with them. |
|
| FBPropertyBool | ActorFacesAnimation |
| Read Write Property: Handling of the
Actor Faces animation. |
|
| FBPropertyBool | BonesAnimation |
| Read Write Property: Handling of the
Bones animation. |
|
| FBPropertyBool | CamerasAnimation |
| Read Write Property: Handling of the
Cameras animation. |
|
| FBPropertyBool | CharactersAnimation |
| Read Write Property: Handling of the
Characters animation. |
|
| FBPropertyBool | CharacterFacesAnimation |
| Read Write Property: Handling of the
Character Faces animation. |
|
| FBPropertyBool | ConstraintsAnimation |
| Read Write Property: Handling of the
Constraints animation. |
|
| FBPropertyBool | DevicesAnimation |
| Read Write Property: Handling of the
Devices animation. |
|
| FBPropertyBool | LightsAnimation |
| Read Write Property: Handling of the
Lights animation. |
|
| FBPropertyBool | MaterialsAnimation |
| Read Write Property: Handling of the
Materials animation. |
|
| FBPropertyBool | ModelsAnimation |
| Read Write Property: Handling of the
Models animation. |
|
| FBPropertyBool | NotesAnimation |
| Read Write Property: Handling of the
Notes animation. |
|
| FBPropertyBool | PhysicalPropertiesAnimation |
| Read Write Property: Handling of the
Physical Properties animation. |
|
| FBPropertyBool | ShadersAnimation |
| Read Write Property: Handling of the
Shaders animation. |
|
| FBPropertyBool | SolversAnimation |
| Read Write Property: Handling of the
Solvers animation. |
|
| FBPropertyBool | TexturesAnimation |
| Read Write Property: Handling of the
Textures animation. |
|
|
Save Character & Animation settings
options.
|
|
| FBPropertyBool | SaveCharacter |
| Read Write Property: Set to true if
the character should be saved when call FBApplication::SaveCharacterRigAndAnimation.
|
|
| FBPropertyBool | SaveControlSet |
| Read Write Property: Set to true if
the rig (and its children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
|
|
| FBPropertyBool | SaveCharacterExtensions |
| Read Write Property: Set to true if
the character extensions (and their children) should be saved when
call FBApplication::SaveCharacterRigAndAnimation.
|
|
| FBPropertyBool | ClearSelectionBeforeSave |
| Read Write Property: Set to true if
the current selected objects shouldn't saved when call FBApplication::SaveCharacterRigAndAnimation.
|
|
|
Load Character & Animation settings
options.
|
|
| FBPropertyCharacterLoadAnimationMethod | TransferMethod |
| Read Write Property: How should the
animation should be transfered on the target rig. |
|
| FBPropertyBool | ProcessAnimationOnExtension |
| Read Write Property: Set to true if
animation on character extensions should also be transferred.
|
|
| FBPropertyBool | ReplaceControlSet |
| Read Write Property: Set to true if
the character extensions (and their children) should be saved when
call FBApplication::SaveCharacterRigAndAnimation.
|
|
| FBPropertyBool | ResetDOF |
| Read Write Property: Set to true if
we should change the limits on the target rig. |
|
| FBPropertyBool | ResetHierarchy |
| Read Write Property: Set to true if
we should reset the character hierarchy. |
|
| FBPropertyBool | RemoveConstraintReference |
| Read Write Property: Set to true if
we should remove constraint 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. |
|
| 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). |
|
| FBPropertyBool | IgnoreConflicts |
| Read Write Property: Set to true to
ignore conflicts between objects in character extensions and
objects in the scene. |
|
|
Dialog UI options.
|
|
| FBPropertyBool | ShowFileDialog |
| Read Write Property: Set to true if
want to pop up dialog for FileName, Format, Embed, Compression,
UseTakeName, OneTakePerFile. |
|
| FBPropertyBool | ShowOptionsDialog |
| Read Write Property: Set to true if
want to pop up options dialog for detail settings. |
|
Constructor & Destructor Documentation
| 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. pFilePathToLoad pass the filepath will collect the take info in file if pLoad is true; ignore when pLoad is false. pObject For internal use only.
Member Function Documentation
| 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.
| 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.
| bool GetTakeSelect | ( | int | pTakeIndex | ) | const |
Return if true if the take will be saved or Loaded.
- Parameters:
-
pTakeIndex index of take to get.
| void SetTakeSelect | ( | int | pTakeIndex, |
| bool | pSelect | ||
| ) |
Return if true if the take will be saved or Loaded.
- Parameters:
-
pTakeIndex index of take to set pIncluded set true if should be saved or loaded.
| const char* GetTakeName | ( | int | pTakeIndex | ) | const |
| void SetTakeName | ( | int | pTakeIndex, |
| const char * | pName | ||
| ) |
Take Original Name.
- Parameters:
-
pTakeIndex index of take to set. pName take name to set
| const char* GetTakeDescription | ( | int | pTakeIndex | ) | const |
| void SetTakeDescription | ( | int | pTakeIndex, |
| const char * | pDescription | ||
| ) |
Take Description.
- Parameters:
-
pTakeIndex index of take to set. pDescription take description to set
| const char* GetTakeDestinationName | ( | int | pTakeIndex | ) | const |
Take Destination Name upon save or load.
- Parameters:
-
pTakeIndex index of take to get.
| 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
Member Data Documentation
| 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 127 of file fbfbxoptions.h.
| FBPropertyFileFormatAndVersion FileFormatAndVersion |
Read Write Property: File format and version choosed to save the scene.
Definition at line 136 of file fbfbxoptions.h.
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 137 of file fbfbxoptions.h.
Read Write Property: Indicate that only the selected models will be saved.
Definition at line 138 of file fbfbxoptions.h.
Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.
Definition at line 139 of file fbfbxoptions.h.
Read Write Property: The Cached buffer size used to accelerate IO system.
Definition at line 140 of file fbfbxoptions.h.
Read Write Property: Indicate if the perform comporession on the arrays values.
Definition at line 141 of file fbfbxoptions.h.
Read Write Property: Indicate if the minimum item size for compressing arrays.
Definition at line 142 of file fbfbxoptions.h.
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 143 of file fbfbxoptions.h.
Read Write Property: Consider base camera settings.
Definition at line 150 of file fbfbxoptions.h.
Read Write Property: Consider camera switcher settings.
Definition at line 151 of file fbfbxoptions.h.
Read Write Property: Consider current camera settings.
Definition at line 152 of file fbfbxoptions.h.
Read Write Property: Consider global Lighting settings.
Definition at line 153 of file fbfbxoptions.h.
Read Write Property: Consider transport control settings.
Definition at line 154 of file fbfbxoptions.h.
Read Write Property: Namespace we append to every objects on a Load (import/open/merge)
Definition at line 157 of file fbfbxoptions.h.
| FBPropertyElementAction Actors |
Read Write Property: Handling of the Actors elements.
Definition at line 162 of file fbfbxoptions.h.
| FBPropertyElementAction ActorFaces |
Read Write Property: Handling of the Actor Faces elements.
Definition at line 163 of file fbfbxoptions.h.
| FBPropertyElementAction Audio |
Read Write Property: Handling of the Audio elements.
Definition at line 164 of file fbfbxoptions.h.
| FBPropertyElementAction Bones |
Read Write Property: Handling of the Bones elements.
Definition at line 165 of file fbfbxoptions.h.
| FBPropertyElementAction Cameras |
Read Write Property: Handling of the Cameras elements.
Definition at line 166 of file fbfbxoptions.h.
| FBPropertyElementAction Characters |
Read Write Property: Handling of the Characters elements.
Definition at line 167 of file fbfbxoptions.h.
| FBPropertyElementAction CharacterFaces |
Read Write Property: Handling of the Character Faces elements.
Definition at line 168 of file fbfbxoptions.h.
| FBPropertyElementAction CharacterExtensions |
Read Write Property: Handling of the Character Extensions.
Definition at line 169 of file fbfbxoptions.h.
| FBPropertyElementAction Constraints |
Read Write Property: Handling of the Constraints elements.
Definition at line 170 of file fbfbxoptions.h.
| FBPropertyElementAction Devices |
Read Write Property: Handling of the Devices elements.
Definition at line 171 of file fbfbxoptions.h.
| FBPropertyElementAction Groups |
Read Write Property: Handling of the Groups elements.
Definition at line 172 of file fbfbxoptions.h.
| FBPropertyElementAction KeyingGroups |
Read Write Property: Handling of the Keying Groups elements.
Definition at line 173 of file fbfbxoptions.h.
| FBPropertyElementAction Lights |
Read Write Property: Handling of the Lights elements.
Definition at line 174 of file fbfbxoptions.h.
| FBPropertyElementAction Materials |
Read Write Property: Handling of the Materials elements.
Definition at line 175 of file fbfbxoptions.h.
| FBPropertyElementAction Models |
Read Write Property: Handling of the Models elements.
Definition at line 176 of file fbfbxoptions.h.
| FBPropertyElementAction Notes |
Read Write Property: Handling of the Notes elements.
Definition at line 177 of file fbfbxoptions.h.
| FBPropertyElementAction OpticalData |
Read Write Property: Handling of the Optical Data elements.
Definition at line 178 of file fbfbxoptions.h.
| FBPropertyElementAction PhysicalProperties |
Read Write Property: Handling of the Physical Properties elements.
Definition at line 179 of file fbfbxoptions.h.
| FBPropertyElementAction Poses |
Read Write Property: Handling of the Poses elements.
Definition at line 180 of file fbfbxoptions.h.
| FBPropertyElementAction Scripts |
Read Write Property: Handling of the Scripts elements.
Definition at line 181 of file fbfbxoptions.h.
| FBPropertyElementAction Sets |
Read Write Property: Handling of the Sets elements.
Definition at line 182 of file fbfbxoptions.h.
| FBPropertyElementAction Shaders |
Read Write Property: Handling of the Shaders elements.
Definition at line 183 of file fbfbxoptions.h.
| FBPropertyElementAction Solvers |
Read Write Property: Handling of the Solvers elements.
Definition at line 184 of file fbfbxoptions.h.
| FBPropertyElementAction Story |
Read Write Property: Handling of the Story elements.
Definition at line 185 of file fbfbxoptions.h.
| FBPropertyElementAction Textures |
Read Write Property: Handling of the Textures elements.
Definition at line 186 of file fbfbxoptions.h.
| FBPropertyElementAction Video |
Read Write Property: Handling of the Video elements.
Definition at line 187 of file fbfbxoptions.h.
Read Write Property: Handling of the Actor Faces animation.
Definition at line 195 of file fbfbxoptions.h.
Read Write Property: Handling of the Bones animation.
Definition at line 196 of file fbfbxoptions.h.
Read Write Property: Handling of the Cameras animation.
Definition at line 197 of file fbfbxoptions.h.
Read Write Property: Handling of the Characters animation.
Definition at line 198 of file fbfbxoptions.h.
Read Write Property: Handling of the Character Faces animation.
Definition at line 199 of file fbfbxoptions.h.
Read Write Property: Handling of the Constraints animation.
Definition at line 200 of file fbfbxoptions.h.
Read Write Property: Handling of the Devices animation.
Definition at line 201 of file fbfbxoptions.h.
Read Write Property: Handling of the Lights animation.
Definition at line 202 of file fbfbxoptions.h.
Read Write Property: Handling of the Materials animation.
Definition at line 203 of file fbfbxoptions.h.
Read Write Property: Handling of the Models animation.
Definition at line 204 of file fbfbxoptions.h.
Read Write Property: Handling of the Notes animation.
Definition at line 205 of file fbfbxoptions.h.
Read Write Property: Handling of the Physical Properties animation.
Definition at line 206 of file fbfbxoptions.h.
Read Write Property: Handling of the Shaders animation.
Definition at line 207 of file fbfbxoptions.h.
Read Write Property: Handling of the Solvers animation.
Definition at line 208 of file fbfbxoptions.h.
Read Write Property: Handling of the Textures animation.
Definition at line 209 of file fbfbxoptions.h.
Read Write Property: Set to true if the character should be saved when call FBApplication::SaveCharacterRigAndAnimation.
Definition at line 215 of file fbfbxoptions.h.
Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
Definition at line 216 of file fbfbxoptions.h.
Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
Definition at line 217 of file fbfbxoptions.h.
Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplication::SaveCharacterRigAndAnimation.
Definition at line 218 of file fbfbxoptions.h.
| FBPropertyCharacterLoadAnimationMethod TransferMethod |
Read Write Property: How should the animation should be transfered on the target rig.
Definition at line 226 of file fbfbxoptions.h.
Read Write Property: Set to true if animation on character extensions should also be transferred.
Definition at line 227 of file fbfbxoptions.h.
Read Write Property: Set to true if the character extensions (and their children) should be saved when call FBApplication::SaveCharacterRigAndAnimation.
Definition at line 228 of file fbfbxoptions.h.
Read Write Property: Set to true if we should change the limits on the target rig.
Definition at line 229 of file fbfbxoptions.h.
Read Write Property: Set to true if we should reset the character hierarchy.
Definition at line 230 of file fbfbxoptions.h.
Read Write Property: Set to true if we should remove constraint reference.
Definition at line 231 of file fbfbxoptions.h.
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 232 of file fbfbxoptions.h.
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 233 of file fbfbxoptions.h.
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 234 of file fbfbxoptions.h.
Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed, Compression, UseTakeName, OneTakePerFile.
Definition at line 240 of file fbfbxoptions.h.
Read Write Property: Set to true if want to pop up options dialog for detail settings.
Definition at line 241 of file fbfbxoptions.h.
The documentation for this class was generated from the following file:
- fbsdk/fbfbxoptions.h
