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. More...
Public Member Functions | |
override void | Dispose () |
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 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... | |
void | Show (out HPS.Exchange.ExportSTLOptionsKit out_kit) |
Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit. More... | |
override bool | Empty () |
Indicates whether this ExportSTLOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Exchange.ExportSTLOptionsKit in_kit) |
Check if the source ExportSTLOptionsKit is equivalent to 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#ae50c4e70d9faa7dd7fd1c7948bff60f6">A3DRWParamsExportStlData::m_bBinaryFile</ulink>. 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a46e17ddb4aefca9ebc45db1092c58229">A3DRWParamsExportStlData::m_eTessellationLevelOfDetail</ulink>. 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a46e17ddb4aefca9ebc45db1092c58229">A3DRWParamsExportStlData::m_eTessellationLevel</ulink> to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/group__a3d__read.html#ggac1fe96a5b9772683a41182babe1559f4ab5aec16efd29ca9df5969341c5c0a245">kA3DTessLODUserDefined</ulink>. 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 | SetCurrentTessellationRetention (bool in_state) |
Sets whether to keep the current tessellation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#ac9abb807d07a3e1cd510c3255d8f28eb">A3DRWParamsExportStlData::m_bKeepCurrentTessellation</ulink>. 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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a970a7e29cdfe377c7e9a7b5b769e87ab">A3DRWParamsExportStlData::m_dMaximalTriangleEdgeLength</ulink>. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetBinary () |
Removes the binary export setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetTessellationLevel () |
Removes the tessellation level setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetTessellationAccuracy () |
Removes the tessellation accuracy setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetCurrentTessellationRetention () |
Removes the current tessellation retention setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetMaximumEdgeLength () |
Removes the tessellation maximum edge length setting. More... | |
HPS.Exchange.ExportSTLOptionsKit | UnsetEverything () |
Removes all settings from this ExportSTLOptionsKit. More... | |
bool | ShowBinary (out bool out_state) |
Shows the binary export 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... | |
bool | ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type) |
Shows the tessellation accuracy 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... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
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 | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
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.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_export_s_t_l_options_kit" kindref="compound">ExportSTLOptionsKit</ref> to copy. |
|
inlinevirtual |
Indicates whether this ExportSTLOptionsKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportSTLOptionsKit is equivalent to this ExportSTLOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_export_s_t_l_options_kit" kindref="compound">ExportSTLOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_exchange_1_1_export_s_t_l_options_kit" kindref="compound">ExportSTLOptionsKit</ref>. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source ExportSTLOptionsKit into this ExportSTLOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_export_s_t_l_options_kit" kindref="compound">ExportSTLOptionsKit</ref> to copy. |
|
inline |
Sets whether to write STL data in binary form. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#ae50c4e70d9faa7dd7fd1c7948bff60f6">A3DRWParamsExportStlData::m_bBinaryFile</ulink>.
in_state | Whether to write STL data in binary form. |
Default value
|
inline |
Sets whether to keep the current tessellation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#ac9abb807d07a3e1cd510c3255d8f28eb">A3DRWParamsExportStlData::m_bKeepCurrentTessellation</ulink>.
in_state | Whether to keep the current tessellation. |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a970a7e29cdfe377c7e9a7b5b769e87ab">A3DRWParamsExportStlData::m_dMaximalTriangleEdgeLength</ulink>.
in_length | The maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative. |
Default value
|
inline |
Sets the accuracy of the tessellation that will be generated for BRep data.
in_type | The accuracy to use for tessellation generation. |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a46e17ddb4aefca9ebc45db1092c58229">A3DRWParamsExportStlData::m_eTessellationLevelOfDetail</ulink>.
in_level | The predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm. |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a46e17ddb4aefca9ebc45db1092c58229">A3DRWParamsExportStlData::m_eTessellationLevel</ulink> to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/group__a3d__read.html#ggac1fe96a5b9772683a41182babe1559f4ab5aec16efd29ca9df5969341c5c0a245">kA3DTessLODUserDefined</ulink>.
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_stl_data.html#a35aaea20089e9b5f377262eee7c230c3">A3DRWParamsExportStlData::m_dAngleToleranceDeg</ulink>. |
|
inline |
Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_exchange_1_1_export_s_t_l_options_kit" kindref="compound">ExportSTLOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_export_s_t_l_options_kit" kindref="compound">ExportSTLOptionsKit</ref>. |
|
inline |
Shows the binary export setting.
out_state | Whether to write STL data in binary form. |
|
inline |
Shows the current tessellation retention setting.
out_state | Whether to keep the current tessellation. |
|
inline |
Shows the tessellation maximum edge length setting.
out_length | The tessellation maximum edge length setting. |
|
inline |
Shows the tessellation accuracy setting.
out_type | The type of the tessellation accuracy which was specified. |
|
inline |
Shows the tessellation level setting.
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 <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0aeb6d8ae6f20283755b339c0dc273988b" kindref="member">Tessellation::Type::Standard</ref>. |
out_limit_type | The type of chord limit which was specified. This is only valid if out_type is <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0a90589c47f06eb971d548591f23c285af" kindref="member">Tessellation::Type::Custom</ref>. |
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 <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0a90589c47f06eb971d548591f23c285af" kindref="member">Tessellation::Type::Custom</ref>. |
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 <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0a90589c47f06eb971d548591f23c285af" kindref="member">Tessellation::Type::Custom</ref>. |
|
inline |
Removes the binary export setting.
|
inline |
Removes the current tessellation retention setting.
|
inline |
Removes all settings from this ExportSTLOptionsKit.
|
inline |
Removes the tessellation maximum edge length setting.
|
inline |
Removes the tessellation accuracy setting.
|
inline |
Removes the tessellation level setting.