
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportU3DOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportU3DOptionsKit in_kit) |
Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit. More... | |
ExportU3DOptionsKit () | |
The default constructor creates an empty ExportU3DOptionsKit object. More... | |
ExportU3DOptionsKit (HPS.Exchange.ExportU3DOptionsKit in_kit) | |
The copy constructor creates a new ExportU3DOptionsKit object that contains the same settings as the source ExportU3DOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More... | |
void | Set (HPS.Exchange.ExportU3DOptionsKit in_kit) |
Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit. More... | |
HPS.Exchange.ExportU3DOptionsKit | SetCompression (byte 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. More... | |
HPS.Exchange.ExportU3DOptionsKit | SetVersion (HPS.Exchange.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. More... | |
void | Show (out HPS.Exchange.ExportU3DOptionsKit out_kit) |
Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit. More... | |
bool | ShowCompression (out byte out_level) |
Shows the compression setting. More... | |
bool | ShowVersion (out HPS.Exchange.U3D.Version out_version) |
Shows the version setting. More... | |
HPS.Exchange.ExportU3DOptionsKit | UnsetCompression () |
Removes the compression setting. More... | |
HPS.Exchange.ExportU3DOptionsKit | UnsetEverything () |
Removes all settings from this ExportU3DOptionsKit. More... | |
HPS.Exchange.ExportU3DOptionsKit | UnsetVersion () |
Removes the version setting. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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.ExportU3DOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.Exchange.ExportU3DOptionsKit a, HPS.Exchange.ExportU3DOptionsKit b) |
static bool | operator== (HPS.Exchange.ExportU3DOptionsKit a, HPS.Exchange.ExportU3DOptionsKit 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.ExportU3DOptionsKit class is a user space object. It contains settings controlling how U3D data is exported via Exchange. Calling HPS.Exchange.ExportU3DOptionsKit.GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ExportU3DOptionsKit object.
|
inline |
The copy constructor creates a new ExportU3DOptionsKit object that contains the same settings as the source ExportU3DOptionsKit.
- Parameters
-
in_kit The source ExportU3DOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ExportU3DOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportU3DOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.
- Parameters
-
in_kit The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
- Returns
- An ExportU3DOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived 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 ExportU3DOptionsKit into this ExportU3DOptionsKit.
- Parameters
-
in_kit The source ExportU3DOptionsKit to copy.
|
inline |
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.
- Parameters
-
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].
- Returns
- A reference to this ExportU3DOptionsKit.
|
inline |
Sets the version of the U3D data to export. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_eU3DVersion.
- Parameters
-
in_version The version of the U3D data to export.
- Returns
- A reference to this ExportU3DOptionsKit.
Default value
|
inline |
Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.
- Parameters
-
out_kit The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit.
|
inline |
Shows the compression setting.
- Parameters
-
out_level The level of compression to apply to tessellations in the U3D data for export.
- Returns
- true if a compression setting was specified, false otherwise.
|
inline |
Shows the version setting.
- Parameters
-
out_version The version of the U3D data to export.
- Returns
- true if a version setting was specified, false otherwise.
|
inline |
Removes the compression setting.
- Returns
- A reference to this ExportU3DOptionsKit.
|
inline |
Removes all settings from this ExportU3DOptionsKit.
- Returns
- A reference to this ExportU3DOptionsKit.
|
inline |
Removes the version setting.
- Returns
- A reference to this ExportU3DOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs