
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportU3DOptionsKit in_kit) |
ExportU3DOptionsKit () | |
ExportU3DOptionsKit (HPS.Exchange.ExportU3DOptionsKit in_kit) | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.Exchange.ExportU3DOptionsKit in_kit) |
HPS.Exchange.ExportU3DOptionsKit | SetCompression (byte in_level) |
HPS.Exchange.ExportU3DOptionsKit | SetVersion (HPS.Exchange.U3D.Version in_version) |
void | Show (out HPS.Exchange.ExportU3DOptionsKit out_kit) |
bool | ShowCompression (out byte out_level) |
bool | ShowVersion (out HPS.Exchange.U3D.Version out_version) |
HPS.Exchange.ExportU3DOptionsKit | UnsetCompression () |
HPS.Exchange.ExportU3DOptionsKit | UnsetEverything () |
HPS.Exchange.ExportU3DOptionsKit | UnsetVersion () |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
virtual HPS.Type | Type () |
Static Public Member Functions | |
static HPS.Exchange.ExportU3DOptionsKit | GetDefault () |
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
◆ ExportU3DOptionsKit() [1/2]
|
inline |
The default constructor creates an empty ExportU3DOptionsKit object.
◆ ExportU3DOptionsKit() [2/2]
|
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
◆ Empty()
|
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.
◆ Equals()
|
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.
◆ GetDefault()
|
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.
◆ ObjectType()
|
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.
◆ Set()
|
inline |
Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.
- Parameters
-
in_kit The source ExportU3DOptionsKit to copy.
◆ SetCompression()
|
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.
◆ SetVersion()
|
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.
- See also
- Default value
◆ Show()
|
inline |
Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.
- Parameters
-
out_kit The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit.
◆ ShowCompression()
|
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.
◆ ShowVersion()
|
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.
◆ UnsetCompression()
|
inline |
Removes the compression setting.
- Returns
- A reference to this ExportU3DOptionsKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this ExportU3DOptionsKit.
- Returns
- A reference to this ExportU3DOptionsKit.
◆ UnsetVersion()
|
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