#include <sprk_exchange.h>
|
enum | UpdateType { Synchronous,
Asynchronous
} |
|
The Exchange::ExportSTLOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange. Calling Exchange::ExportSTLOptionsKit::GetDefault() will return an options kit with values found in here.
Exchange::ExportSTLOptionsKit::ExportSTLOptionsKit |
( |
| ) |
|
bool Exchange::ExportSTLOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
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.
Type Exchange::ExportSTLOptionsKit::ObjectType |
( |
| ) |
const |
|
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 Object.
ExportSTLOptionsKit& Exchange::ExportSTLOptionsKit::SetCurrentTessellationRetention |
( |
bool |
in_state | ) |
|
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.
- See also
- Default value
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.
- See also
- Default value
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.
- See also
- Default value
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.
bool Exchange::ExportSTLOptionsKit::ShowBinary |
( |
bool & |
out_state | ) |
const |
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.
bool Exchange::ExportSTLOptionsKit::ShowCurrentTessellationRetention |
( |
bool & |
out_state | ) |
const |
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.
bool Exchange::ExportSTLOptionsKit::ShowMaximumEdgeLength |
( |
double & |
out_length | ) |
const |
Shows the tessellation maximum edge length setting.
- Parameters
-
out_lenth | The tessellation maximum edge length setting. |
- Returns
- true if a tessellation maximum edge length setting was specified, false otherwise.
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.
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.
Removes the current tessellation retention setting.
- Returns
- A reference to this ExportSTLOptionsKit.
Removes the tessellation maximum edge length setting.
- Returns
- A reference to this ExportSTLOptionsKit.
The documentation for this class was generated from the following file: