REFERENCE MANUAL
#include <sprk_exchange.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportU3DOptionsKit const &in_kit) const |
ExportU3DOptionsKit () | |
ExportU3DOptionsKit (ExportU3DOptionsKit const &in_kit) | |
ExportU3DOptionsKit (ExportU3DOptionsKit &&in_that) | |
Type | ObjectType () const |
bool | operator!= (ExportU3DOptionsKit const &in_kit) const |
ExportU3DOptionsKit & | operator= (ExportU3DOptionsKit const &in_kit) |
ExportU3DOptionsKit & | operator= (ExportU3DOptionsKit &&in_that) |
bool | operator== (ExportU3DOptionsKit const &in_kit) const |
void | Set (ExportU3DOptionsKit const &in_kit) |
ExportU3DOptionsKit & | SetCompression (unsigned char in_level) |
ExportU3DOptionsKit & | SetVersion (U3D::Version in_version) |
void | Show (ExportU3DOptionsKit &out_kit) const |
bool | ShowCompression (unsigned char &out_level) const |
bool | ShowVersion (U3D::Version &out_version) const |
ExportU3DOptionsKit & | UnsetCompression () |
ExportU3DOptionsKit & | UnsetEverything () |
ExportU3DOptionsKit & | UnsetVersion () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static ExportU3DOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The Exchange::ExportU3DOptionsKit class is a user space object. It contains settings controlling how U3D data is exported via Exchange. Calling Exchange::ExportU3DOptionsKit::GetDefault() will return an options kit with values found in here.
Exchange::ExportU3DOptionsKit::ExportU3DOptionsKit | ( | ) |
The default constructor creates an empty ExportU3DOptionsKit object.
Exchange::ExportU3DOptionsKit::ExportU3DOptionsKit | ( | ExportU3DOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportU3DOptionsKit object that contains the same settings as the source ExportU3DOptionsKit.
in_kit | The source ExportU3DOptionsKit to copy. |
Exchange::ExportU3DOptionsKit::ExportU3DOptionsKit | ( | ExportU3DOptionsKit && | in_that | ) |
The move constructor creates an ExportU3DOptionsKit by transferring the underlying object of the rvalue reference to this ExportU3DOptionsKit.
in_that | An rvalue reference to an ExportU3DOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportU3DOptionsKit has any values set on it.
Reimplemented from Object.
bool Exchange::ExportU3DOptionsKit::Equals | ( | ExportU3DOptionsKit const & | in_kit | ) | const |
Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.
in_kit | The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit. |
|
static |
Creates an ExportU3DOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File::ExportU3D.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Exchange::ExportU3DOptionsKit::operator!= | ( | ExportU3DOptionsKit const & | in_kit | ) | const |
Check if the source ExportU3DOptionsKit is not equivalent to this ExportU3DOptionsKit.
in_kit | The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit. |
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::operator= | ( | ExportU3DOptionsKit const & | in_kit | ) |
Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.
in_kit | The source ExportU3DOptionsKit to copy. |
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::operator= | ( | ExportU3DOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportU3DOptionsKit.
in_that | An rvalue reference to an ExportU3DOptionsKit to take the underlying object from. |
bool Exchange::ExportU3DOptionsKit::operator== | ( | ExportU3DOptionsKit const & | in_kit | ) | const |
Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.
in_kit | The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit. |
void Exchange::ExportU3DOptionsKit::Set | ( | ExportU3DOptionsKit const & | in_kit | ) |
Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.
in_kit | The source ExportU3DOptionsKit to copy. |
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::SetCompression | ( | unsigned char | in_level | ) |
Sets the level of compression to apply to tessellations in the U3D data for export. If no compression level is set, no compression will be applied. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_ucMeshQualityValue.
in_level | The level of compression to apply to tessellations in the U3D data for export. This value should be in the range [0, 100]. |
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::SetVersion | ( | U3D::Version | in_version | ) |
Sets the version of the U3D data to export. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_eU3DVersion.
in_version | The version of the U3D data to export. |
void Exchange::ExportU3DOptionsKit::Show | ( | ExportU3DOptionsKit & | out_kit | ) | const |
Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.
out_kit | The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit. |
bool Exchange::ExportU3DOptionsKit::ShowCompression | ( | unsigned char & | out_level | ) | const |
Shows the compression setting.
out_level | The level of compression to apply to tessellations in the U3D data for export. |
bool Exchange::ExportU3DOptionsKit::ShowVersion | ( | U3D::Version & | out_version | ) | const |
Shows the version setting.
out_version | The version of the U3D data to export. |
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::UnsetCompression | ( | ) |
Removes the compression setting.
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportU3DOptionsKit.
ExportU3DOptionsKit& Exchange::ExportU3DOptionsKit::UnsetVersion | ( | ) |
Removes the version setting.