The HPS::Exchange::ExportXMLOptionsKit class is a user space object. More...
#include <sprk_exchange.h>
Public Member Functions | |
ExportXMLOptionsKit () | |
The default constructor creates an empty ExportXMLOptionsKit object. More... | |
ExportXMLOptionsKit (ExportXMLOptionsKit const &in_kit) | |
The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit. More... | |
ExportXMLOptionsKit (ExportXMLOptionsKit &&in_that) | |
The move constructor creates an ExportXMLOptionsKit by transferring the underlying object of the rvalue reference to this ExportXMLOptionsKit. More... | |
virtual | ~ExportXMLOptionsKit () |
HPS::Type | ObjectType () const |
void | Set (ExportXMLOptionsKit const &in_kit) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More... | |
void | Show (ExportXMLOptionsKit &out_kit) const |
Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit. More... | |
ExportXMLOptionsKit & | operator= (ExportXMLOptionsKit const &in_kit) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More... | |
ExportXMLOptionsKit & | operator= (ExportXMLOptionsKit &&in_that) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportXMLOptionsKit. More... | |
bool | Empty () const |
Indicates whether this ExportXMLOptionsKit has any values set on it. More... | |
bool | Equals (ExportXMLOptionsKit const &in_kit) const |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More... | |
bool | operator== (ExportXMLOptionsKit const &in_kit) const |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More... | |
bool | operator!= (ExportXMLOptionsKit const &in_kit) const |
Check if the source ExportXMLOptionsKit is not equivalent to this ExportXMLOptionsKit. More... | |
ExportXMLOptionsKit & | SetMetadata (bool in_state) |
Sets whether to export metadata. More... | |
ExportXMLOptionsKit & | SetTransformations (bool in_state) |
Sets whether to export transformations. More... | |
ExportXMLOptionsKit & | SetMaterials (bool in_state) |
Sets whether to export materials. More... | |
ExportXMLOptionsKit & | UnsetMetadata () |
Removes the metadata export setting. More... | |
ExportXMLOptionsKit & | UnsetTransformations () |
Removes the transformation export setting. More... | |
ExportXMLOptionsKit & | UnsetMaterials () |
Removes the material export setting. More... | |
ExportXMLOptionsKit & | UnsetEverything () |
Removes all settings from this ExportXMLOptionsKit. More... | |
bool | ShowMetadata (bool &out_state) const |
Shows the metadata export setting. More... | |
bool | ShowTransformations (bool &out_state) const |
Shows the transformation export setting. More... | |
bool | ShowMaterials (bool &out_state) const |
Shows the material export setting. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
static ExportXMLOptionsKit | GetDefault () |
Creates an ExportXMLOptionsKit which contains the default settings. More... | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeExportXMLOptionsKit |
The HPS::Exchange::ExportXMLOptionsKit class is a user space object.
It contains settings controlling how XML data is exported via Exchange. Calling HPS::Exchange::ExportXMLOptionsKit::GetDefault() will return an options kit with values found in here.
HPS::Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit | ( | ) |
The default constructor creates an empty ExportXMLOptionsKit object.
HPS::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. |
HPS::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 |
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
|
virtual |
Indicates whether this ExportXMLOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::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. |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
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.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
|
inlinevirtual |
bool HPS::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& HPS::Exchange::ExportXMLOptionsKit::operator= | ( | ExportXMLOptionsKit const & | in_kit | ) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to copy. |
ExportXMLOptionsKit& HPS::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 HPS::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. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
void HPS::Exchange::ExportXMLOptionsKit::Set | ( | ExportXMLOptionsKit const & | in_kit | ) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.
in_kit | The source ExportXMLOptionsKit to copy. |
ExportXMLOptionsKit& HPS::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& HPS::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& HPS::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 HPS::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 HPS::Exchange::ExportXMLOptionsKit::ShowMaterials | ( | bool & | out_state | ) | const |
Shows the material export setting.
out_state | Whether to export materials. |
bool HPS::Exchange::ExportXMLOptionsKit::ShowMetadata | ( | bool & | out_state | ) | const |
Shows the metadata export setting.
out_state | Whether to export metadata. |
bool HPS::Exchange::ExportXMLOptionsKit::ShowTransformations | ( | bool & | out_state | ) | const |
Shows the transformation export setting.
out_state | Whether to export transformations. |
|
virtualinherited |
This function returns the true type of the underlying object.
This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.
ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportXMLOptionsKit.
ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetMaterials | ( | ) |
Removes the material export setting.
ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetMetadata | ( | ) |
Removes the metadata export setting.
ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetTransformations | ( | ) |
Removes the transformation export setting.
|
static |