
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportXMLOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportXMLOptionsKit in_kit) |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More... | |
ExportXMLOptionsKit () | |
The default constructor creates an empty ExportXMLOptionsKit object. More... | |
ExportXMLOptionsKit (HPS.Exchange.ExportXMLOptionsKit in_kit) | |
The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Exchange.ExportXMLOptionsKit in_kit) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More... | |
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. More... | |
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. More... | |
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. More... | |
void | Show (out HPS.Exchange.ExportXMLOptionsKit out_kit) |
Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit. More... | |
bool | ShowMaterials (out bool out_state) |
Shows the material export setting. More... | |
bool | ShowMetadata (out bool out_state) |
Shows the metadata export setting. More... | |
bool | ShowTransformations (out bool out_state) |
Shows the transformation export setting. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetEverything () |
Removes all settings from this ExportXMLOptionsKit. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetMaterials () |
Removes the material export setting. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetMetadata () |
Removes the metadata export setting. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetTransformations () |
Removes the transformation export setting. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
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. More... | |
Static Public Member Functions | |
static HPS.Exchange.ExportXMLOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b) |
static bool | operator== (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ExportXMLOptionsKit object.
|
inline |
The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit.
- Parameters
-
in_kit The source ExportXMLOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ExportXMLOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportXMLOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.
- Parameters
-
in_kit The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
- Returns
- An ExportXMLOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
|
inline |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.
- Parameters
-
in_kit The source ExportXMLOptionsKit to copy.
|
inline |
Sets whether to export materials. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportColorMaterial.
- Parameters
-
in_state Whether to export materials.
- Returns
- A reference to this ExportXMLOptionsKit.
Default value
|
inline |
Sets whether to export metadata. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportMetadata.
- Parameters
-
in_state Whether to export metadata.
- Returns
- A reference to this ExportXMLOptionsKit.
Default value
|
inline |
Sets whether to export transformations. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportTransformations.
- Parameters
-
in_state Whether to export transformations.
- Returns
- A reference to this ExportXMLOptionsKit.
Default value
|
inline |
Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.
- Parameters
-
out_kit The ExportXMLOptionsKit to populate with the contents of this ExportXMLOptionsKit.
|
inline |
Shows the material export setting.
- Parameters
-
out_state Whether to export materials.
- Returns
- true if a material export setting was specified, false otherwise.
|
inline |
Shows the metadata export setting.
- Parameters
-
out_state Whether to export metadata.
- Returns
- true if a metadata export setting was specified, false otherwise.
|
inline |
Shows the transformation export setting.
- Parameters
-
out_state Whether to export transformations.
- Returns
- true if a transformation export setting was specified, false otherwise.
|
inline |
Removes all settings from this ExportXMLOptionsKit.
- Returns
- A reference to this ExportXMLOptionsKit.
|
inline |
Removes the material export setting.
- Returns
- A reference to this ExportXMLOptionsKit.
|
inline |
Removes the metadata export setting.
- Returns
- A reference to this ExportXMLOptionsKit.
|
inline |
Removes the transformation export setting.
- Returns
- A reference to this ExportXMLOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs