
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this TessellationOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.TessellationOptionsKit in_kit) |
Check if the source TessellationOptionsKit is equivalent to this TessellationOptionsKit. 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.TessellationOptionsKit in_kit) |
Copies the source TessellationOptionsKit into this TessellationOptionsKit. More... | |
HPS.Exchange.TessellationOptionsKit | SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures, double in_accurate_grid_maximum_stitch_length) |
Sets the accuracy of the tessellation that will be generated for BRep data. More... | |
HPS.Exchange.TessellationOptionsKit | SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures) |
Sets the accuracy of the tessellation that will be generated for BRep data. More... | |
HPS.Exchange.TessellationOptionsKit | SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals) |
Sets the accuracy of the tessellation that will be generated for BRep data. More... | |
HPS.Exchange.TessellationOptionsKit | SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type) |
Sets the accuracy of the tessellation that will be generated for BRep data. More... | |
HPS.Exchange.TessellationOptionsKit | SetLevel (HPS.Exchange.Tessellation.Level in_level) |
Sets the predefined quality of the tessellation that will be generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_eTessellationLevelOfDetail. More... | |
HPS.Exchange.TessellationOptionsKit | SetLevel (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. This implicitly sets A3DRWParamsTessellationData::m_eTessellationLevel to kA3DTessLODUserDefined. More... | |
HPS.Exchange.TessellationOptionsKit | SetMaximumEdgeLength (double in_length) |
Sets the maximum length of triangle edges in the tessellation generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength. More... | |
HPS.Exchange.TessellationOptionsKit | SetUVPointPreservation (bool in_state) |
Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_bKeepUVPoints. More... | |
void | Show (out HPS.Exchange.TessellationOptionsKit out_kit) |
Copies this TessellationOptionsKit into the given TessellationOptionsKit. More... | |
bool | ShowAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type, out bool out_accurate_normals, out bool out_accurate_surface_curvatures, out double out_accurate_grid_maximum_stitch_length) |
Shows the accuracy setting. More... | |
bool | ShowLevel (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 level setting. More... | |
bool | ShowMaximumEdgeLength (out double out_length) |
Shows the maximum edge length setting. More... | |
bool | ShowUVPointPreservation (out bool out_state) |
Shows the UV preservation setting. More... | |
TessellationOptionsKit () | |
The default constructor creates an empty TessellationOptionsKit object. More... | |
TessellationOptionsKit (HPS.Exchange.TessellationOptionsKit in_kit) | |
The copy constructor creates a new TessellationOptionsKit object that contains the same settings as the source TessellationOptionsKit. More... | |
HPS.Exchange.TessellationOptionsKit | UnsetAccuracy () |
Removes the accuracy setting. More... | |
HPS.Exchange.TessellationOptionsKit | UnsetEverything () |
Removes all settings from this TessellationOptionsKit. More... | |
HPS.Exchange.TessellationOptionsKit | UnsetLevel () |
Removes the level setting. More... | |
HPS.Exchange.TessellationOptionsKit | UnsetMaximumEdgeLength () |
Removes the maximum edge length setting. More... | |
HPS.Exchange.TessellationOptionsKit | UnsetUVPointPreservation () |
Removes the UV preservation 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.TessellationOptionsKit | GetDefault () |
Creates an TessellationOptionsKit 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.Tessellation. More... | |
static bool | operator!= (HPS.Exchange.TessellationOptionsKit a, HPS.Exchange.TessellationOptionsKit b) |
static bool | operator== (HPS.Exchange.TessellationOptionsKit a, HPS.Exchange.TessellationOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The TessellationOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange.
Constructor & Destructor Documentation
◆ TessellationOptionsKit() [1/2]
|
inline |
The default constructor creates an empty TessellationOptionsKit object.
◆ TessellationOptionsKit() [2/2]
|
inline |
The copy constructor creates a new TessellationOptionsKit object that contains the same settings as the source TessellationOptionsKit.
- Parameters
-
in_kit The source TessellationOptionsKit to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this TessellationOptionsKit has any values set on it.
- Returns
- true if no values are set on this TessellationOptionsKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source TessellationOptionsKit is equivalent to this TessellationOptionsKit.
- Parameters
-
in_kit The source TessellationOptionsKit to compare to this TessellationOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
Creates an TessellationOptionsKit 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.Tessellation.
- Returns
- An TessellationOptionsKit 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 TessellationOptionsKit into this TessellationOptionsKit.
- Parameters
-
in_kit The source TessellationOptionsKit to copy.
◆ SetAccuracy() [1/4]
|
inline |
Sets the accuracy of the tessellation that will be generated for BRep data.
- Parameters
-
in_type The accuracy to use for tessellation generation. in_accurate_normals Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation. in_accurate_surface_curvatures Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures. in_accurate_grid_maximum_stitch_length Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if in_type is set to Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_dAccurateTessellationWithGridMaximumStitchLength.
- Returns
- A reference to this TessellationOptionsKit.
◆ SetAccuracy() [2/4]
|
inline |
Sets the accuracy of the tessellation that will be generated for BRep data.
- Parameters
-
in_type The accuracy to use for tessellation generation. in_accurate_normals Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation. in_accurate_surface_curvatures Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.
- Returns
- A reference to this TessellationOptionsKit.
◆ SetAccuracy() [3/4]
|
inline |
Sets the accuracy of the tessellation that will be generated for BRep data.
- Parameters
-
in_type The accuracy to use for tessellation generation. in_accurate_normals Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.
- Returns
- A reference to this TessellationOptionsKit.
◆ SetAccuracy() [4/4]
|
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 TessellationOptionsKit.
◆ SetLevel() [1/2]
|
inline |
Sets the predefined quality of the tessellation that will be generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_eTessellationLevelOfDetail.
- Parameters
-
in_level The predefined quality of the tessellation that will be generated for BRep data.
- Returns
- A reference to this TessellationOptionsKit.
◆ SetLevel() [2/2]
|
inline |
Sets the user defined quality of the tessellation that will be generated for BRep data. This implicitly sets A3DRWParamsTessellationData::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 A3DRWParamsTessellationData::m_dAngleToleranceDeg.
- Returns
- A reference to this TessellationOptionsKit.
◆ SetMaximumEdgeLength()
|
inline |
Sets the maximum length of triangle edges in the tessellation generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength.
- Parameters
-
in_length The maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative, and if set to 0.0, the length will not be used when generating the tessellation.
- Returns
- A reference to this TessellationOptionsKit.
◆ SetUVPointPreservation()
|
inline |
Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_bKeepUVPoints.
- Parameters
-
in_state Whether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
- Returns
- A reference to this TessellationOptionsKit.
◆ Show()
|
inline |
Copies this TessellationOptionsKit into the given TessellationOptionsKit.
- Parameters
-
out_kit The TessellationOptionsKit to populate with the contents of this TessellationOptionsKit.
◆ ShowAccuracy()
|
inline |
Shows the accuracy setting.
- Parameters
-
out_type The type of the accuracy which was specified. out_accurate_normals Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is different than Tessellation.Accuracy.Standard. out_accurate_surface_curvatures Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if out_type is different than Tessellation.Accuracy.Standard. out_accurate_grid_maximum_stitch_length Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if out_type is Tessellation.Accuracy.GridAccurate.
- Returns
- true if an accuracy setting was specified, false otherwise.
◆ ShowLevel()
|
inline |
Shows the level setting.
- Parameters
-
out_type The type of the level setting which was specified. out_level The predefined quality of the tessellation that will be generated for BRep data. 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 level setting was specified, false otherwise.
◆ ShowMaximumEdgeLength()
|
inline |
Shows the maximum edge length setting.
- Parameters
-
out_length The maximum edge length setting.
- Returns
- true if a maximum edge length setting was specified, false otherwise.
◆ ShowUVPointPreservation()
|
inline |
Shows the UV preservation setting.
- Parameters
-
out_state Whether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
- Returns
- true if a UV preservation setting was specified, false otherwise.
◆ UnsetAccuracy()
|
inline |
Removes the accuracy setting.
- Returns
- A reference to this TessellationOptionsKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this TessellationOptionsKit.
- Returns
- A reference to this TessellationOptionsKit.
◆ UnsetLevel()
|
inline |
Removes the level setting.
- Returns
- A reference to this TessellationOptionsKit.
◆ UnsetMaximumEdgeLength()
|
inline |
Removes the maximum edge length setting.
- Returns
- A reference to this TessellationOptionsKit.
◆ UnsetUVPointPreservation()
|
inline |
Removes the UV preservation setting.
- Returns
- A reference to this TessellationOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs