#include <sprk_exchange.h>
|
static const HPS::Type | staticType = HPS::Type::ExchangeExportSTLOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ ExportSTLOptionsKit() [1/3]
HPS::Exchange::ExportSTLOptionsKit::ExportSTLOptionsKit |
( |
| ) |
|
◆ ExportSTLOptionsKit() [2/3]
◆ ExportSTLOptionsKit() [3/3]
◆ Empty()
bool HPS::Exchange::ExportSTLOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
◆ 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.
- Returns
- An ExportSTLOptionsKit with the default settings.
◆ ObjectType()
HPS::Type HPS::Exchange::ExportSTLOptionsKit::ObjectType |
( |
| ) |
const |
|
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.
◆ operator!=()
bool HPS::Exchange::ExportSTLOptionsKit::operator!= |
( |
ExportSTLOptionsKit const & |
in_kit | ) |
const |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
bool HPS::Exchange::ExportSTLOptionsKit::operator== |
( |
ExportSTLOptionsKit const & |
in_kit | ) |
const |
◆ Set()
◆ SetBinary()
◆ SetCurrentTessellationRetention()
ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::SetCurrentTessellationRetention |
( |
bool |
in_state | ) |
|
◆ SetMaximumEdgeLength()
ExportSTLOptionsKit& 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.
- 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
◆ SetTessellationAccuracy()
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
◆ SetTessellationLevel() [1/2]
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
◆ SetTessellationLevel() [2/2]
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.
◆ SetUnits()
Sets the units to associate with the STL export. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eExportUnit. This function will result in a scale being applied to the exported model. The CADModel will NOT have a unit associated with it, since STL is a unit-less format. For example: exporting a cube with a 1mm side with Units set to Meter, will cause the side of the cube to shrink by a factor of 1000, since every unit in the file, which used to correspond to one mm, now corresponds to a meter. This is useful in the case where the STL file needs to be loaded in a scene alongside another model, so that the units of the two models can match.
- Parameters
-
in_units | The units to associate with the export. Passing Units::Unknown will preserve the original units. |
- Returns
- A reference to this ExportSTLOptionsKit.
- See also
- Default value
◆ Show()
◆ ShowBinary()
bool HPS::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.
◆ ShowCurrentTessellationRetention()
bool HPS::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.
◆ ShowMaximumEdgeLength()
bool HPS::Exchange::ExportSTLOptionsKit::ShowMaximumEdgeLength |
( |
double & |
out_length | ) |
const |
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.
◆ ShowTessellationAccuracy()
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.
◆ ShowTessellationLevel()
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.
◆ ShowUnits()
bool HPS::Exchange::ExportSTLOptionsKit::ShowUnits |
( |
Units & |
out_units | ) |
const |
Shows the binary export setting.
- Parameters
-
out_state | The units that will be associated with this export. |
- Returns
- true if a units export setting was specified, false otherwise.
◆ UnsetBinary()
◆ UnsetCurrentTessellationRetention()
Removes the current tessellation retention setting.
- Returns
- A reference to this ExportSTLOptionsKit.
◆ UnsetEverything()
◆ UnsetMaximumEdgeLength()
Removes the tessellation maximum edge length setting.
- Returns
- A reference to this ExportSTLOptionsKit.
◆ UnsetTessellationAccuracy()
◆ UnsetTessellationLevel()
◆ UnsetUnits()
The documentation for this class was generated from the following file: