REFERENCE MANUAL
#include <sprk_exchange.h>
Static Public Member Functions | |
static ExportXMLOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The Exchange::ExportXMLOptionsKit class is a user space object. It contains settings controlling how XML data is exported via Exchange. Calling Exchange::ExportXMLOptionsKit::GetDefault() will return an options kit with values found in here.
Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit | ( | ) |
The default constructor creates an empty ExportXMLOptionsKit object.
Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit | ( | ExportXMLOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to copy. |
Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit | ( | ExportXMLOptionsKit && | in_that | ) |
The move constructor creates an ExportXMLOptionsKit by transferring the underlying object of the rvalue reference to this ExportXMLOptionsKit.
in_that | An rvalue reference to an ExportXMLOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportXMLOptionsKit has any values set on it.
Reimplemented from Object.
bool Exchange::ExportXMLOptionsKit::Equals | ( | ExportXMLOptionsKit const & | in_kit | ) | const |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit. |
|
static |
Creates an ExportXMLOptionsKit 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::ExportXML.
|
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::ExportXMLOptionsKit::operator!= | ( | ExportXMLOptionsKit const & | in_kit | ) | const |
Check if the source ExportXMLOptionsKit is not equivalent to this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit. |
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::operator= | ( | ExportXMLOptionsKit const & | in_kit | ) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to copy. |
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::operator= | ( | ExportXMLOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportXMLOptionsKit.
in_that | An rvalue reference to an ExportXMLOptionsKit to take the underlying object from. |
bool Exchange::ExportXMLOptionsKit::operator== | ( | ExportXMLOptionsKit const & | in_kit | ) | const |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit. |
void Exchange::ExportXMLOptionsKit::Set | ( | ExportXMLOptionsKit const & | in_kit | ) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to copy. |
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::SetMaterials | ( | bool | in_state | ) |
Sets whether to export materials. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportColorMaterial.
in_state | Whether to export materials. |
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::SetMetadata | ( | bool | in_state | ) |
Sets whether to export metadata. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportMetadata.
in_state | Whether to export metadata. |
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::SetTransformations | ( | bool | in_state | ) |
Sets whether to export transformations. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportTransformations.
in_state | Whether to export transformations. |
void Exchange::ExportXMLOptionsKit::Show | ( | ExportXMLOptionsKit & | out_kit | ) | const |
Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.
out_kit | The ExportXMLOptionsKit to populate with the contents of this ExportXMLOptionsKit. |
bool Exchange::ExportXMLOptionsKit::ShowMaterials | ( | bool & | out_state | ) | const |
Shows the material export setting.
out_state | Whether to export materials. |
bool Exchange::ExportXMLOptionsKit::ShowMetadata | ( | bool & | out_state | ) | const |
Shows the metadata export setting.
out_state | Whether to export metadata. |
bool Exchange::ExportXMLOptionsKit::ShowTransformations | ( | bool & | out_state | ) | const |
Shows the transformation export setting.
out_state | Whether to export transformations. |
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportXMLOptionsKit.
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::UnsetMaterials | ( | ) |
Removes the material export setting.
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::UnsetMetadata | ( | ) |
Removes the metadata export setting.
ExportXMLOptionsKit& Exchange::ExportXMLOptionsKit::UnsetTransformations | ( | ) |
Removes the transformation export setting.