Open Reality Reference Guide
|
|
1 #ifndef __FBFBXOPTIONS_H__
2 #define __FBFBXOPTIONS_H__
47 #include <kaydaradef.h>
52 #define FBSDK_DLL K_DLLIMPORT
57 #ifdef FBSDKUseNamespace
58 namespace FBSDKNamespace {
66 enum FBElementAction {
67 kFBElementActionSave ,
68 kFBElementActionAppend ,
69 kFBElementActionMerge ,
70 kFBElementActionDiscard,
76 enum FBTakeSpanOnLoad {
85 enum FBCharacterLoadAnimationMethod {
86 kFBCharacterLoadConnect ,
87 kFBCharacterLoadCopy ,
88 kFBCharacterLoadRetarget ,
89 kFBCharacterLoadPlotIfSampled ,
94 enum FBFileFormatAndVersion
105 kFBDefaultFormatAndVersion = kFBFBX2020
112 enum FBOptionsContext {
113 kFBOptionsContextSave ,
114 kFBOptionsContextSaveSelection ,
115 kFBOptionsContextLoad ,
116 kFBOptionsContextMultiLoad ,
117 kFBOptionsContextMerge,
133 FBFbxOptions(
bool pLoad,
const char * pFilePathToLoad = NULL, HIObject pObject = NULL);
140 void SetAll( FBElementAction pElementAction,
bool pAnimation );
426 #ifdef FBSDKUseNamespace
FBPropertyBool ProcessAnimationOnExtension
Read Write Property: Set to true if animation on character extensions should also be transferred.
void SetFromString(const char *pString, FBOptionsContext context)
Set all options from string Set all parameters from a formatted string (previously serialized with Sa...
FBStringList GetMultiLoadNamespaceList()
Returns the list of namespaces that will be used when merging multiple scenes (see FBApplication::Fil...
FBPropertyElementAction Bones
Read Write Property: Handling of the Bones elements.
void SaveToString(FBString &pString, FBOptionsContext context)
Serialize all options to a string Serialize all options to a string specifying a context.
void SetTakeDestinationName(int pTakeIndex, const char *pDestinationName)
Take Destination Name upon save or load.
FBPropertyElementAction Scripts
Read Write Property: Handling of the Scripts elements.
FBPropertyBool CamerasAnimation
Read Write Property: Handling of the Cameras animation.
FBPropertyBool SaveCharacterExtensions
Read Write Property: Set to true if the character extensions (and their children) should be saved whe...
FBPropertyBool IgnoreConflicts
Read Write Property: Set to true to ignore conflicts between objects in character extensions and obje...
FBPropertyBool CharacterFacesAnimation
Read Write Property: Handling of the Character Faces animation.
const char * GetTakeDestinationName(int pTakeIndex) const
Take Destination Name upon save or load.
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
FBPropertyFileFormatAndVersion FileFormatAndVersion
Read Write Property: File format and version chosen to save the scene.
FBPropertyBool ResetHierarchy
Read Write Property: Set to true if we should reset the character hierarchy.
FBPropertyBool TransportSettings
Read Write Property: Consider transport control settings.
FBPropertyElementAction Constraints
Read Write Property: Handling of the Constraints elements.
FBPropertyBool RemoveEmptyLayer
Read Write property: Remove empty animation layers that are in additive mode, without child or parent...
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
FBPropertyBool SaveSelectedModelsOnly
Read Write Property: Indicate that only the selected models will be saved.
FBPropertyElementAction Audio
Read Write Property: Handling of the Audio elements.
FBPropertyElementAction Story
Read Write Property: Handling of the Story elements.
FBPropertyBool BonesAnimation
Read Write Property: Handling of the Bones animation.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
FBPropertyBool SaveCharacter
Read Write Property: Set to true if the character should be saved when call FBApplication::SaveCharac...
FBPropertyElementAction Groups
Read Write Property: Handling of the Groups elements.
FBPropertyElementAction KeyingGroups
Read Write Property: Handling of the Keying Groups elements.
FBPropertyBool GlobalLightingSettings
Read Write Property: Consider global Lighting settings.
FBPropertyBool StoryAnimation
Read Write Property: Handling of the Story animation (animatable properties on story objects).
FBPropertyBool SetPropertyStaticIfPossible
Read Write Property: Set to false if want to keep properties' animated flag even when they are not re...
FBPropertyBool ModelsAnimation
Read Write Property: Handling of the Models animation.
FBPropertyBool RemoveConstraintReference
Read Write Property: Set to true if we should remove constraint reference.
FBPropertyInt CacheSize
Read Write Property: The Cached buffer size used to accelerate IO system.
FBPropertyElementAction Textures
Read Write Property: Handling of the Textures elements.
FBPropertyElementAction Actors
Read Write Property: Handling of the Actors elements.
FBPropertyBool LightsAnimation
Read Write Property: Handling of the Lights animation.
FBPropertyBool UseASCIIFormat
Read Write Property: Indicate if the resulting FBX file will be in binary or ASCII mode.
void SetMultiLoadNamespaceList(const FBStringList &pMultiLoadNamespaceList)
Sets the list of namespaces that will be used when merging multiple scenes (see FBApplication::FileMe...
FBPropertyElementAction Devices
Read Write Property: Handling of the Devices elements.
FBPropertyElementAction CharacterFaces
Read Write Property: Handling of the Character Faces elements.
FBPropertyBool ConsiderMuteSolo
Read Write property: Consider the mute/solo settings to identify identical layer when merging.
FBPropertyBool ResetDOF
Read Write Property: Set to true if we should change the limits on the target rig.
FBPropertyBool ReplaceControlSet
Read Write Property: Set to true if the character extensions (and their children) should be saved whe...
FBPropertyBool NotesAnimation
Read Write Property: Handling of the Notes animation.
FBPropertyElementAction Characters
Read Write Property: Handling of the Characters elements.
void SetTakeDescription(int pTakeIndex, const char *pDescription)
Take Description.
FBPropertyBool UpdateRecentFiles
Read Write Property: Set to true to update recent file list.
FBPropertyInt CompressMinSize
Read Write Property: Indicate if the minimum item size for compressing arrays.
FBFbxOptions(bool pLoad, const char *pFilePathToLoad=NULL, HIObject pObject=NULL)
Constructor.
FBPropertyElementAction Materials
Read Write Property: Handling of the Materials elements.
FBPropertyBool EmbedMedia
Read Write Property: Embed all media in the FBX file itself. When saving in ASCII mode it is not poss...
FBPropertyBool SaveControlSet
Read Write Property: Set to true if the rig (and its children) should be saved when call FBApplicatio...
FBPropertyElementAction Sets
Read Write Property: Handling of the Sets elements.
void SetTakeName(int pTakeIndex, const char *pName)
Take Original Name.
FBPropertyElementAction FileReferences
Read Write Property: Handling of the FileReferences elements.
#define __FBClassDeclare(Name, Parent)
For internal use only.
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
int GetTakeCount() const
Return the count of takes in the scene to saved or the file to loaded.
FBPropertyString NamespaceList
Read Write Property: A list of namespaces separated by '~'. On Load, duplicate the loaded objects int...
FBPropertyElementAction Shaders
Read Write Property: Handling of the Shaders elements.
FBPropertyBool ClearSelectionBeforeSave
Read Write Property: Set to true if the current selected objects shouldn't saved when call FBApplicat...
FBPropertyBool CopyCharacterExtensions
Read Write Property: pCopyMissingExtensions Set to true if the character extensions on the rig in the...
FBPropertyTakeSpanOnLoad TakeSpan
Read Write Property: Indicate how the take start and end point should be set. By default it is read f...
FBPropertyElementAction Video
Read Write Property: Handling of the Video elements.
void SetTakeSelect(int pTakeIndex, bool pSelect)
Return if true if the take will be saved or Loaded.
FBPropertyElementAction PhysicalProperties
Read Write Property: Handling of the Physical Properties elements.
FBPropertyElementAction Poses
Read Write Property: Handling of the Poses elements.
FBPropertyBool ShowOptionsDialog
Read Write Property: Set to true if want to pop up options dialog for detail settings.
FBPropertyBool BaseCameras
Read Write Property: Consider base camera settings.
FBPropertyElementAction OpticalData
Read Write Property: Handling of the Optical Data elements.
FBPropertyBool ShadersAnimation
Read Write Property: Handling of the Shaders animation.
FBPropertyBool ConstraintsAnimation
Read Write Property: Handling of the Constraints animation.
FBPropertyBool PhysicalPropertiesAnimation
Read Write Property: Handling of the Physical Properties animation.
void SetObjectsToSave(FBArrayTemplate< FBComponent * > *pObjectsToSave)
Sets the list of objects that will be saved.
FBPropertyBool CameraSwitcherSettings
Read Write Property: Consider camera switcher settings.
FBPropertyBool CompressArray
Read Write Property: Indicate if the perform compression on the arrays values.
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
FBPropertyInt CompressLevel
Read Write Property: The allowed level range for Compression is [0-9] where 0 equals no compression a...
void SetNamespaceList(const FBStringList &pNamespaceList)
SetNamespaceList upon save or load On Load, if the SetMultiLoadNamespaceList method is also called,...
FBPropertyCharacterLoadAnimationMethod TransferMethod
Read Write Property: How should the animation should be transfered on the target rig.
FBPropertyElementAction ActorFaces
Read Write Property: Handling of the Actor Faces elements.
FBStringList GetNamespaceList()
GetNamespaceList upon save or load.
FBPropertyBool SolversAnimation
Read Write Property: Handling of the Solvers animation.
FBPropertyBool MaterialsAnimation
Read Write Property: Handling of the Materials animation.
Template class to contain an array of items.
Customize file loading and saving.
const char * GetTakeName(int pTakeIndex) const
Take Original Name.
void SetTakeKeyRange(int pTakeIndex, FBTimeSpan pKeyTimeSpan)
Set take key range.
FBPropertyBool FileReferenceEdit
Read Write Property: Load/Save the edits made to referenced objects or not.
FBPropertyBool CharactersAnimation
Read Write Property: Handling of the Characters animation.
FBPropertyBool DevicesAnimation
Read Write Property: Handling of the Devices animation.
FBPropertyElementAction Cameras
Read Write Property: Handling of the Cameras elements.
FBTimeSpan GetTakeKeyRange(int pTakeIndex)
Get take key range.
FBPropertyBool FileReference
Read Write property: Load/Save scene as FileReference.
FBPropertyElementAction Lights
Read Write Property: Handling of the Lights elements.
FBPropertyElementAction Notes
Read Write Property: Handling of the Notes elements.
Property class: const char * (String).
FBPropertyBool KeepTransformHierarchy
Read Write Property: Indicate whether we keep transform hierarchy when SaveSelectedModelsOnly is true...
FBPropertyElementAction CharacterExtensions
Read Write Property: Handling of the Character Extensions.
MotionBuilder SDK base class.
FBPropertyBool ShowFileDialog
Read Write Property: Set to true if want to pop up dialog for FileName, Format, Embed,...
void SetAll(FBElementAction pElementAction, bool pAnimation)
Set All Options.
FBPropertyBool ActorFacesAnimation
Read Write Property: Handling of the Actor Faces animation.
FBPropertyElementAction Models
Read Write Property: Handling of the Models elements.
const char * GetTakeDescription(int pTakeIndex) const
Take Description.
FBPropertyBool CurrentCameraSettings
Read Write Property: Consider current camera settings.
FBPropertyBool TexturesAnimation
Read Write Property: Handling of the Textures animation.
FBPropertyElementAction Solvers
Read Write Property: Handling of the Solvers elements.
bool GetTakeSelect(int pTakeIndex) const
Return if true if the take will be saved or Loaded.
FBPropertyBool RetargetOnBaseLayer
Read Write Property: If the transfer method is retarget, set this parameter to control where the reta...