#include <hps.h>

Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::CuttingSectionAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various cutting section attributes. This table lists default values for the various segment attributes accessible from HPS::CuttingSectionAttributeControl.
Constructor & Destructor Documentation
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl | ( | CuttingSectionAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl | ( | CuttingSectionAttributeControl && | in_that | ) |
The move constructor creates a CuttingSectionAttributeControl by transferring the underlying impl of the rvalue reference to this CuttingSectionAttributeControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a CuttingSectionAttributeControl to take the impl from.
HPS::CuttingSectionAttributeControl::~CuttingSectionAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
|
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 HPS::Control.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::operator= | ( | CuttingSectionAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CuttingSectionAttributeControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a CuttingSectionAttributeControl to take the impl from.
- Returns
- A reference to this CuttingSectionAttributeControl.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::operator= | ( | CuttingSectionAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the CuttingSectionAttributeControl source.
- Parameters
-
in_that The CuttingSectionAttributeControl source of the assignment.
- Returns
- A reference to this CuttingSectionAttributeControl.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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.
bool HPS::CuttingSectionAttributeControl::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::CuttingSectionAttributeControl::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::CuttingSectionAttributeControl::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::CuttingSectionAttributeControl::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::CuttingSectionAttributeControl::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.
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetCappingLevel | ( | ) |
Removes the cutting section capping level setting.
- Returns
- A reference to this object.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetCuttingLevel | ( | ) |
Removes the cutting section cutting level setting.
- Returns
- A reference to this object.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetEdgeWeight | ( | ) |
Removes the cutting section cut edge weight setting.
- Returns
- A reference to this object.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::UnsetMaterialPreference | ( | ) |
Removes the material preference for cut geometry setting.
- Returns
- A reference to this object.
CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::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