#include <hps.h>

Static Public Member Functions | |
static CuttingSectionAttributeKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::CuttingSectionAttributeKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The HPS::CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections. Calling HPS::CuttingSectionAttributeKit::GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit | ( | ) |
Initializes an empty kit.
HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit | ( | CuttingSectionAttributeKit const & | in_kit | ) |
The copy constructor creates a new CuttingSectionAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit | ( | CuttingSectionAttributeKit && | in_that | ) |
The move constructor creates a CuttingSectionAttributeKit by transferring the underlying impl of the rvalue reference to this CuttingSectionAttributeKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a CuttingSectionAttributeKit to take the impl from.
|
virtual |
Destroy this kit.
Member Function Documentation
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS::Object.
bool HPS::CuttingSectionAttributeKit::Equals | ( | CuttingSectionAttributeKit const & | in_kit | ) | const |
Check if the source CuttingSectionAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source CuttingSectionAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
Creates a CuttingSectionAttributeKit 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.
- Returns
- A CuttingSectionAttributeKit with the default settings.
bool HPS::CuttingSectionAttributeKit::operator!= | ( | CuttingSectionAttributeKit const & | in_kit | ) | const |
Check if the source CuttingSectionAttributeKit is not equivalent to this object.
- Parameters
-
in_kit The source CuttingSectionAttributeKit to compare to this object.
- Returns
- true if the objects are not equivalent, false otherwise.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::operator= | ( | CuttingSectionAttributeKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionAttributeKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a CuttingSectionAttributeKit to take the impl from.
- Returns
- A reference to this CuttingSectionAttributeKit.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::operator= | ( | CuttingSectionAttributeKit const & | in_kit | ) |
Copies the source CuttingSectionAttributeKit into this object.
- Parameters
-
in_kit The source CuttingSectionAttributeKit to copy.
- Returns
- A reference to this object.
bool HPS::CuttingSectionAttributeKit::operator== | ( | CuttingSectionAttributeKit const & | in_kit | ) | const |
Check if the source CuttingSectionAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source CuttingSectionAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::CuttingSectionAttributeKit::Set | ( | CuttingSectionAttributeKit const & | in_kit | ) |
Copies all settings from the source CuttingSectionAttributeKit into this object.
- Parameters
-
in_kit The source CuttingSectionAttributeKit to copy.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetCappingLevel | ( | CuttingSection::CappingLevel | in_level | ) |
Sets the cutting section capping level.
- Parameters
-
in_level The cutting section capping level.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetCuttingLevel | ( | CuttingSection::CuttingLevel | in_level | ) |
Sets the cutting section cutting level.
- Parameters
-
in_level The cutting section cutting level.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetEdgeWeight | ( | float | in_weight, |
Line::SizeUnits | in_units = Line::SizeUnits::ScaleFactor |
||
) |
Sets the cut edge weight.
- Parameters
-
in_weight The edge weight to apply for cut edges. in_units The units of the weight given.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetMaterialPreference | ( | CuttingSection::MaterialPreference | in_preference | ) |
Sets the material preference for cut geometry.
- Parameters
-
in_preference The material preference for cut geometry.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetTolerance | ( | float | in_tolerance, |
CuttingSection::ToleranceUnits | in_units | ||
) |
Sets the tolerance for closing loops when processing capping faces.
- Parameters
-
in_tolerance The tolerance to use. in_units How to interpret the given tolerance.
- Returns
- A reference to this object.
void HPS::CuttingSectionAttributeKit::Show | ( | CuttingSectionAttributeKit & | out_kit | ) | const |
Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit.
- Parameters
-
out_kit The CuttingSectionAttributeKit to populate with the contents of this object.
bool HPS::CuttingSectionAttributeKit::ShowCappingLevel | ( | CuttingSection::CappingLevel & | out_level | ) | const |
Shows the cutting section capping level setting.
- Parameters
-
out_level The cutting section capping level.
- Returns
- true if a cutting section capping level setting was specified, false otherwise.
bool HPS::CuttingSectionAttributeKit::ShowCuttingLevel | ( | CuttingSection::CuttingLevel & | out_level | ) | const |
Shows the cutting section cutting level setting.
- Parameters
-
out_level The cutting section cutting level.
- Returns
- true if a cutting section cutting level setting was specified, false otherwise.
bool HPS::CuttingSectionAttributeKit::ShowEdgeWeight | ( | float & | out_weight, |
Line::SizeUnits & | out_units | ||
) | const |
Shows the weight of cut edges.
- Parameters
-
out_weight The weight value for cut edges. out_units The units applied to in_weight.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::CuttingSectionAttributeKit::ShowMaterialPreference | ( | CuttingSection::MaterialPreference & | out_preference | ) | const |
Shows the orientation of colors and radii of cylinders.
- Parameters
-
out_preference The material preference for cut geometry.
- Returns
- true if a material preference for cut geometry was specified, false otherwise.
bool HPS::CuttingSectionAttributeKit::ShowTolerance | ( | float & | out_tolerance, |
CuttingSection::ToleranceUnits & | out_units | ||
) | const |
Shows the tolerance for closing loops when processing capping faces.
- Parameters
-
out_tolerance The tolerance to use. out_units The units for the tolerance.
- Returns
- true if the setting is valid, false otherwise.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCappingLevel | ( | ) |
Removes the cutting section capping level setting.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCuttingLevel | ( | ) |
Removes the cutting section cutting level setting.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetEdgeWeight | ( | ) |
Removes the cutting section cut edge weight setting.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetMaterialPreference | ( | ) |
Removes the material preference for cut geometry setting.
- Returns
- A reference to this object.
CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetTolerance | ( | ) |
Removes the cutting section capping tolerance setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h