
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportSTLOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportSTLOptionsKit in_kit) |
Check if the source ExportSTLOptionsKit is equivalent to this ExportSTLOptionsKit. More... | |
ExportSTLOptionsKit () | |
The default constructor creates an empty ExportSTLOptionsKit object. More... | |
ExportSTLOptionsKit (HPS.Exchange.ExportSTLOptionsKit in_kit) | |
The copy constructor creates a new ExportSTLOptionsKit object that contains the same settings as the source ExportSTLOptionsKit. 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.ExportSTLOptionsKit in_kit) |
Copies the source ExportSTLOptionsKit into this ExportSTLOptionsKit. More... | |
HPS.Exchange.ExportSTLOptionsKit | SetBinary (bool in_state) |
Sets whether to write STL data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bBinaryFile. More... | |
HPS.Exchange.ExportSTLOptionsKit | SetCurrentTessellationRetention (bool in_state) |
Sets whether to keep the current tessellation. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bKeepCurrentTessellation. More... | |
HPS.Exchange.ExportSTLOptionsKit | SetMaximumEdgeLength (double in_length) |
Sets the maximum length of triangle edges in the tessellation generated for BRep data. This is only relevant if the tessellation level is set to Tessellation.Level.UserDefined. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_dMaximalTriangleEdgeLength. More... | |
HPS.Exchange.ExportSTLOptionsKit | SetTessellationAccuracy (HPS.Exchange.Tessellation.Accuracy in_type) |
Sets the accuracy of the tessellation that will be generated for BRep data. More... | |
HPS.Exchange.ExportSTLOptionsKit | SetTessellationLevel (HPS.Exchange.Tessellation.Level in_level) |
Sets the predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eTessellationLevelOfDetail. More... | |
HPS.Exchange.ExportSTLOptionsKit | SetTessellationLevel (HPS.Exchange.Tessellation.Chord.Limit in_limit_type, double in_limit, double in_angle_tolerance) |
Sets the user defined quality of the tessellation that will be generated for BRep data using the standard or accurate tessellation algorithm. This implicitly sets A3DRWParamsExportStlData::m_eTessellationLevel to kA3DTessLODUserDefined. More... | |
void | Show (out HPS.Exchange.ExportSTLOptionsKit out_kit) |
Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit. More... | |
bool | ShowBinary (out bool out_state) |
Shows the binary export setting. More... | |
bool | ShowCurrentTessellationRetention (out bool out_state) |
Shows the current tessellation retention setting. More... | |
bool | ShowMaximumEdgeLength (out double out_length) |
Shows the tessellation maximum edge length setting. More... | |
bool | ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type) |
Shows the tessellation accuracy setting. More... | |
bool | ShowTessellationLevel (out HPS.Exchange.Tessellation.Type out_type, out HPS.Exchange.Tessellation.Level out_level, out HPS.Exchange.Tessellation.Chord.Limit out_limit_type, out double out_limit, out double out_angle_tolerance) |
Shows the tessellation level setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetBinary () |
Removes the binary export setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetCurrentTessellationRetention () |
Removes the current tessellation retention setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetEverything () |
Removes all settings from this ExportSTLOptionsKit. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetMaximumEdgeLength () |
Removes the tessellation maximum edge length setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetTessellationAccuracy () |
Removes the tessellation accuracy setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetTessellationLevel () |
Removes the tessellation level 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.ExportSTLOptionsKit | GetDefault () |
Creates an ExportSTLOptionsKit 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.ExportSTL. More... | |
static bool | operator!= (HPS.Exchange.ExportSTLOptionsKit a, HPS.Exchange.ExportSTLOptionsKit b) |
static bool | operator== (HPS.Exchange.ExportSTLOptionsKit a, HPS.Exchange.ExportSTLOptionsKit 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.ExportSTLOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange. Calling HPS.Exchange.ExportSTLOptionsKit.GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ExportSTLOptionsKit object.
|
inline |
The copy constructor creates a new ExportSTLOptionsKit object that contains the same settings as the source ExportSTLOptionsKit.
- Parameters
-
in_kit The source ExportSTLOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ExportSTLOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportSTLOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportSTLOptionsKit is equivalent to this ExportSTLOptionsKit.
- Parameters
-
in_kit The source ExportSTLOptionsKit to compare to this ExportSTLOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates an ExportSTLOptionsKit 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.ExportSTL.
- Returns
- An ExportSTLOptionsKit 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 ExportSTLOptionsKit into this ExportSTLOptionsKit.
- Parameters
-
in_kit The source ExportSTLOptionsKit to copy.
|
inline |
Sets whether to write STL data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bBinaryFile.
- Parameters
-
in_state Whether to write STL data in binary form.
- Returns
- A reference to this ExportSTLOptionsKit.
Default value
|
inline |
Sets whether to keep the current tessellation. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bKeepCurrentTessellation.
- Parameters
-
in_state Whether to keep the current tessellation.
- Returns
- A reference to this ExportSTLOptionsKit.
Default value
|
inline |
Sets the maximum length of triangle edges in the tessellation generated for BRep data. This is only relevant if the tessellation level is set to Tessellation.Level.UserDefined. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_dMaximalTriangleEdgeLength.
- Parameters
-
in_length The maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative.
- Returns
- A reference to this ExportSTLOptionsKit.
Default value
|
inline |
Sets the accuracy of the tessellation that will be generated for BRep data.
- Parameters
-
in_type The accuracy to use for tessellation generation.
- Returns
- A reference to this ExportSTLOptionsKit.
Default value
|
inline |
Sets the predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eTessellationLevelOfDetail.
- Parameters
-
in_level The predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm.
- Returns
- A reference to this ExportSTLOptionsKit.
Default value
|
inline |
Sets the user defined quality of the tessellation that will be generated for BRep data using the standard or accurate tessellation algorithm. This implicitly sets A3DRWParamsExportStlData::m_eTessellationLevel to kA3DTessLODUserDefined.
- Parameters
-
in_limit_type The type of the chord limit to be specified. in_limit Either the ratio of the tessellation chord height to the bounding box height which should be in the range [50, 10000], or the maximum distance between the surface definition and the tessellation approximation, depending on the preceding argument. in_angle_tolerance The maximum angle in degrees between two consecutive wire elements in the generated tessellation which should be in the range [10, 40]. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_dAngleToleranceDeg.
- Returns
- A reference to this ExportSTLOptionsKit.
|
inline |
Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit.
- Parameters
-
out_kit The ExportSTLOptionsKit to populate with the contents of this ExportSTLOptionsKit.
|
inline |
Shows the binary export setting.
- Parameters
-
out_state Whether to write STL data in binary form.
- Returns
- true if a binary export setting was specified, false otherwise.
|
inline |
Shows the current tessellation retention setting.
- Parameters
-
out_state Whether to keep the current tessellation.
- Returns
- true if a current tessellation retention setting was specified, false otherwise.
|
inline |
Shows the tessellation maximum edge length setting.
- Parameters
-
out_length The tessellation maximum edge length setting.
- Returns
- true if a tessellation maximum edge length setting was specified, false otherwise.
|
inline |
Shows the tessellation accuracy setting.
- Parameters
-
out_type The type of the tessellation accuracy which was specified.
- Returns
- true if a tessellation accuracy setting was specified, false otherwise.
|
inline |
Shows the tessellation level setting.
- Parameters
-
out_type The type of the tessellation level setting which was specified. out_level The predefined quality of the tessellation that will be generated for BRep data using the standard tessellaiton algorithm. This is only valid if out_type is Tessellation.Type.Standard. out_limit_type The type of chord limit which was specified. This is only valid if out_type is Tessellation.Type.Custom. out_limit The chord limit to use to generate tessellation for BRep data. Its interpretation depends on the preceding argument. This is only valid if out_type is Tessellation.Type.Custom. out_angle_tolerance The maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation.Type.Custom.
- Returns
- true if a tessellation level setting was specified, false otherwise.
|
inline |
Removes the binary export setting.
- Returns
- A reference to this ExportSTLOptionsKit.
|
inline |
Removes the current tessellation retention setting.
- Returns
- A reference to this ExportSTLOptionsKit.
|
inline |
Removes all settings from this ExportSTLOptionsKit.
- Returns
- A reference to this ExportSTLOptionsKit.
|
inline |
Removes the tessellation maximum edge length setting.
- Returns
- A reference to this ExportSTLOptionsKit.
|
inline |
Removes the tessellation accuracy setting.
- Returns
- A reference to this ExportSTLOptionsKit.
|
inline |
Removes the tessellation level setting.
- Returns
- A reference to this ExportSTLOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs