#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportSTLOptionsKit:

Public Member Functions
bool	Empty () const

bool	Equals (ExportSTLOptionsKit const &in_kit) const

	ExportSTLOptionsKit ()

	ExportSTLOptionsKit (ExportSTLOptionsKit const &in_kit)

	ExportSTLOptionsKit (ExportSTLOptionsKit &&in_that)

HPS::Type	ObjectType () const

bool	operator!= (ExportSTLOptionsKit const &in_kit) const

ExportSTLOptionsKit &	operator= (ExportSTLOptionsKit const &in_kit)

ExportSTLOptionsKit &	operator= (ExportSTLOptionsKit &&in_that)

bool	operator== (ExportSTLOptionsKit const &in_kit) const

void	Set (ExportSTLOptionsKit const &in_kit)

ExportSTLOptionsKit &	SetBinary (bool in_state)

ExportSTLOptionsKit &	SetCurrentTessellationRetention (bool in_state)

ExportSTLOptionsKit &	SetMaximumEdgeLength (double in_length)

ExportSTLOptionsKit &	SetTessellationAccuracy (Tessellation::Accuracy in_type)

ExportSTLOptionsKit &	SetTessellationLevel (Tessellation::Level in_level)

ExportSTLOptionsKit &	SetTessellationLevel (Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance)

ExportSTLOptionsKit &	SetUnits (Units in_units)

void	Show (ExportSTLOptionsKit &out_kit) const

bool	ShowBinary (bool &out_state) const

bool	ShowCurrentTessellationRetention (bool &out_state) const

bool	ShowMaximumEdgeLength (double &out_length) const

bool	ShowTessellationAccuracy (Tessellation::Accuracy &out_type) const

bool	ShowTessellationLevel (Tessellation::Type &out_type, Tessellation::Level &out_level, Tessellation::Chord::Limit &out_limit_type, double &out_limit, double &out_angle_tolerance) const

bool	ShowUnits (Units &out_units) const

ExportSTLOptionsKit &	UnsetBinary ()

ExportSTLOptionsKit &	UnsetCurrentTessellationRetention ()

ExportSTLOptionsKit &	UnsetEverything ()

ExportSTLOptionsKit &	UnsetMaximumEdgeLength ()

ExportSTLOptionsKit &	UnsetTessellationAccuracy ()

ExportSTLOptionsKit &	UnsetTessellationLevel ()

ExportSTLOptionsKit &	UnsetUnits ()

Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Member Functions
static ExportSTLOptionsKit	GetDefault ()

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ExchangeExportSTLOptionsKit

Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit

Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)

	SprocketKit (SprocketKit &&in_that)

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

◆ ExportSTLOptionsKit() [1/3]

HPS::Exchange::ExportSTLOptionsKit::ExportSTLOptionsKit ( )

The default constructor creates an empty ExportSTLOptionsKit object.

◆ ExportSTLOptionsKit() [2/3]

HPS::Exchange::ExportSTLOptionsKit::ExportSTLOptionsKit ( ExportSTLOptionsKit const & in_kit )

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.

◆ ExportSTLOptionsKit() [3/3]

HPS::Exchange::ExportSTLOptionsKit::ExportSTLOptionsKit ( ExportSTLOptionsKit && in_that )

The move constructor creates an ExportSTLOptionsKit by transferring the underlying object of the rvalue reference to this ExportSTLOptionsKit.

Parameters

in_that An rvalue reference to an ExportSTLOptionsKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Exchange::ExportSTLOptionsKit::Empty ( ) const

virtual

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.

◆ Equals()

bool HPS::Exchange::ExportSTLOptionsKit::Equals ( ExportSTLOptionsKit const & in_kit ) const

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.

◆ GetDefault()

static ExportSTLOptionsKit HPS::Exchange::ExportSTLOptionsKit::GetDefault ( )

static

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

Check if the source ExportSTLOptionsKit is not equivalent to this ExportSTLOptionsKit.

Parameters

in_kit The source ExportSTLOptionsKit to compare to this ExportSTLOptionsKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::operator= ( ExportSTLOptionsKit const & in_kit )

Copies the source ExportSTLOptionsKit into this ExportSTLOptionsKit.

Parameters

in_kit The source ExportSTLOptionsKit to copy.

Returns: A reference to this ExportSTLOptionsKit.

◆ operator=() [2/2]

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::operator= ( ExportSTLOptionsKit && in_that )

The move assignment operator transfers the underlying object of the rvalue reference to this ExportSTLOptionsKit.

Parameters

in_that An rvalue reference to an ExportSTLOptionsKit to take the underlying object from.

Returns: A reference to this ExportSTLOptionsKit.

◆ operator==()

bool HPS::Exchange::ExportSTLOptionsKit::operator== ( ExportSTLOptionsKit const & in_kit ) const

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.

◆ Set()

void HPS::Exchange::ExportSTLOptionsKit::Set ( ExportSTLOptionsKit const & in_kit )

Copies the source ExportSTLOptionsKit into this ExportSTLOptionsKit.

Parameters

in_kit The source ExportSTLOptionsKit to copy.

◆ SetBinary()

ExportSTLOptionsKit& 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.

Parameters

in_state Whether to write STL data in binary form.

Returns: A reference to this ExportSTLOptionsKit.

See also: Default value

◆ SetCurrentTessellationRetention()

ExportSTLOptionsKit& 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.

Parameters

in_state Whether to keep the current tessellation.

Returns: A reference to this ExportSTLOptionsKit.

See also: Default value

◆ 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()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::SetTessellationAccuracy ( Tessellation::Accuracy in_type )

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]

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::SetTessellationLevel ( 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.

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]

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::SetTessellationLevel	(	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.

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()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::SetUnits ( Units in_units )

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()

void HPS::Exchange::ExportSTLOptionsKit::Show ( ExportSTLOptionsKit & out_kit ) const

Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit.

Parameters

out_kit The ExportSTLOptionsKit to populate with the contents of this ExportSTLOptionsKit.

◆ 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()

bool HPS::Exchange::ExportSTLOptionsKit::ShowTessellationAccuracy ( Tessellation::Accuracy & out_type ) const

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()

bool HPS::Exchange::ExportSTLOptionsKit::ShowTessellationLevel	(	Tessellation::Type &	out_type,
		Tessellation::Level &	out_level,
		Tessellation::Chord::Limit &	out_limit_type,
		double &	out_limit,
		double &	out_angle_tolerance
	)		const

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()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetBinary ( )

Removes the binary export setting.

Returns: A reference to this ExportSTLOptionsKit.

◆ UnsetCurrentTessellationRetention()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetCurrentTessellationRetention ( )

Removes the current tessellation retention setting.

Returns: A reference to this ExportSTLOptionsKit.

◆ UnsetEverything()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetEverything ( )

Removes all settings from this ExportSTLOptionsKit.

Returns: A reference to this ExportSTLOptionsKit.

◆ UnsetMaximumEdgeLength()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetMaximumEdgeLength ( )

Removes the tessellation maximum edge length setting.

Returns: A reference to this ExportSTLOptionsKit.

◆ UnsetTessellationAccuracy()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetTessellationAccuracy ( )

Removes the tessellation accuracy setting.

Returns: A reference to this ExportSTLOptionsKit.

◆ UnsetTessellationLevel()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetTessellationLevel ( )

Removes the tessellation level setting.

Returns: A reference to this ExportSTLOptionsKit.

◆ UnsetUnits()

ExportSTLOptionsKit& HPS::Exchange::ExportSTLOptionsKit::UnsetUnits ( )

Removes the units export setting.

Returns: A reference to this ExportSTLOptionsKit.

The documentation for this class was generated from the following file:

include/sprk_exchange.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExportSTLOptionsKit() [1/3]

◆ ExportSTLOptionsKit() [2/3]

◆ ExportSTLOptionsKit() [3/3]

Member Function Documentation

◆ Empty()

◆ Equals()

◆ GetDefault()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetBinary()

◆ SetCurrentTessellationRetention()

◆ SetMaximumEdgeLength()

◆ SetTessellationAccuracy()

◆ SetTessellationLevel() [1/2]

◆ SetTessellationLevel() [2/2]

◆ SetUnits()

◆ Show()

◆ ShowBinary()

◆ ShowCurrentTessellationRetention()

◆ ShowMaximumEdgeLength()

◆ ShowTessellationAccuracy()

◆ ShowTessellationLevel()

◆ ShowUnits()

◆ UnsetBinary()

◆ UnsetCurrentTessellationRetention()

◆ UnsetEverything()

◆ UnsetMaximumEdgeLength()

◆ UnsetTessellationAccuracy()

◆ UnsetTessellationLevel()

◆ UnsetUnits()