Scene::LoadData Struct Reference
#include <scene.h >
Data structure to hold file import/load options, and diagnostic data.
Definition at line 71 of file scene.h .
enum UpdateFilter { updateGeometries = 0x00000001,
updateCameras = 0x00000002,
updateAll = 0xffffffff,
updateNone = 0x00000000
} This is used to determine which elements in the current scene get merged/updated with data from an imported scene. More...
enum IncludeFilter {
includeGeometries = 0x00000001,
includeCameras = 0x00000002,
includeMaterials = 0x00000004,
includeLights = 0x00000008,
includeCurves = 0x00000010,
includeSelectionSets = 0x00000020,
includeTransformationPalettes = 0x00000040,
includeAll = 0xffffffff,
includeNone = 0x00000000
} This is used to determine which types of scene elements should get loaded/merged into the scene. More...
int & IncludeFilter ()
A bit-field that indicates what types of scene elements should be included in the load operation. More...
int & UpdateFilter ()
A bit-field that indicates what types of scene elements should be updated in the load operation. More...
bool & Merge ()
Indicates if the loaded data should be merged into the current scene. More...
void AddDiagnosticMessage (const QString &sMessage)
While loading scenes, Mudbox can append diagnostic messages to this data structure. More...
void LogDiagnosticMessages () const
Convenience method to print diagnostic messages to the log. More...
LoadData (bool bMerge=false, int eIncludeFilter=includeAll , int eUpdateFilter=updateNone )
Constructor based on merge, include, and update options. More...
LoadData (int eUpdateFilter, bool bMerge=false)
Constructor based on update and merge options. More...
bool IncludeGeometries () const
Convenience method to determine if geometries should be included in the load operation. More...
bool IncludeCameras () const
Convenience method to determine if cameras should be included in the load operation. More...
bool IncludeMaterials () const
Convenience method to determine if materials should be included in the load operation. More...
bool IncludeLights () const
Convenience method to determine if lights should be included in the load operation. More...
bool IncludeCurves () const
Convenience method to determine if curves should be included in the load operation. More...
bool IncludeSelectionSets () const
Convenience method to determine if selection sets should be included in the load operation. More...
bool IncludeTransformationPalettes () const
Convenience method to determine if transformation palettes should be included in the load operation. More...
bool UpdateGeometries () const
Convenience method to determine if matching geometries should be updated in the load operation. More...
bool UpdateCameras () const
Convenience method to determine if matching cameras should be updated in the load operation. More...
static LoadData ByInclude (bool bGeoms, bool bCams, bool bMats, bool bLights, bool bCurves, bool bSets, bool bPalettes)
Convenience method to construct a LoadData object based on what to include. More...
static LoadData & ByMerge (bool bMerge=false)
Convenience method to return a LoadData object based on merge mode. More...
This is used to determine which elements in the current scene get merged/updated with data from an imported scene.
Currently matching is done via names. For example, if there is a geometry named "Sphere" in the current scene, it will be matched with a geometry named "Sphere" in an imported scene, if it exists.
Enumerator updateGeometries
Update matching geometries via the Transfer Details function.
updateCameras
Update matching cameras.
updateAll
Update all elements.
updateNone
Update no elements.
Definition at line 77 of file scene.h .
Update matching geometries via the Transfer Details function.
This is used to determine which types of scene elements should get loaded/merged into the scene.
Enumerator includeGeometries
Include geometries.
includeCameras
Include cameras.
includeMaterials
Include materials.
includeLights
Include lights.
includeCurves
Include curves.
includeSelectionSets
Include selection sets.
includeTransformationPalettes
Include transformation palettes.
includeAll
Inlude all scene elements.
includeNone
Include no elements.
Definition at line 86 of file scene.h .
Inlude all scene elements.
Include transformation palettes.
Constructor based on merge, include, and update options.
Constructor based on update and merge options.
A bit-field that indicates what types of scene elements should be included in the load operation.
Definition at line 101 of file scene.h .
101 {
return m_eIncludeFilter; }
A bit-field that indicates what types of scene elements should be updated in the load operation.
Definition at line 105 of file scene.h .
105 {
return m_eUpdateFilter; }
Indicates if the loaded data should be merged into the current scene.
Definition at line 108 of file scene.h .
While loading scenes, Mudbox can append diagnostic messages to this data structure.
Definition at line 111 of file scene.h .
111 { m_aDiagnosticMessages.
push_back ( sMessage ); }
void push_back(const T &t)
void LogDiagnosticMessages
(
)
const
Convenience method to print diagnostic messages to the log.
static LoadData ByInclude
(
bool
bGeoms ,
bool
bCams ,
bool
bMats ,
bool
bLights ,
bool
bCurves ,
bool
bSets ,
bool
bPalettes
)
static
Convenience method to construct a LoadData object based on what to include.
static LoadData & ByMerge
(
bool
bMerge = false
)
static
Convenience method to return a LoadData object based on merge mode.
Sets the update filter to updateNone, and the include filter to includeAll Not thread-safe!
bool IncludeGeometries
(
)
const
inline
Convenience method to determine if geometries should be included in the load operation.
Definition at line 131 of file scene.h .
bool IncludeCameras
(
)
const
inline
Convenience method to determine if cameras should be included in the load operation.
Definition at line 134 of file scene.h .
bool IncludeMaterials
(
)
const
inline
Convenience method to determine if materials should be included in the load operation.
Definition at line 137 of file scene.h .
bool IncludeLights
(
)
const
inline
Convenience method to determine if lights should be included in the load operation.
Definition at line 140 of file scene.h .
bool IncludeCurves
(
)
const
inline
Convenience method to determine if curves should be included in the load operation.
Definition at line 143 of file scene.h .
bool IncludeSelectionSets
(
)
const
inline
Convenience method to determine if selection sets should be included in the load operation.
Definition at line 146 of file scene.h .
bool IncludeTransformationPalettes
(
)
const
inline
Convenience method to determine if transformation palettes should be included in the load operation.
Definition at line 149 of file scene.h .
Include transformation palettes.
bool UpdateGeometries
(
)
const
inline
Convenience method to determine if matching geometries should be updated in the load operation.
Definition at line 152 of file scene.h .
Update matching geometries via the Transfer Details function.
bool UpdateCameras
(
)
const
inline
Convenience method to determine if matching cameras should be updated in the load operation.
Definition at line 155 of file scene.h .
The documentation for this struct was generated from the following file: