CuttingSectionAttributeControl
-
class
CuttingSectionAttributeControl
: public HPS::Control 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.
Public Functions
-
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.
-
CuttingSectionAttributeControl
(CuttingSectionAttributeControl const &in_that) Initializes a control tied to the same object as in_that.
-
explicit
CuttingSectionAttributeControl
(SegmentKey &in_seg) Initializes a control tied to the segment in_seg.
-
inline virtual HPS::Type
ObjectType
() const 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.
-
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 &
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 &
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 &
SetCappingUsage
(CuttingSection::CappingUsage in_usage) Sets the cutting section capping usage.
Parameters: in_usage – The cutting section capping usage. Returns: A reference to this object.
-
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 &
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 &
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 &
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
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
ShowCappingUsage
(CuttingSection::CappingUsage &out_usage) const Shows the cutting section capping usage setting.
Parameters: out_level – The cutting section capping usage. Returns: true if a cutting section capping usage setting was specified, false otherwise.
-
bool
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
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
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
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.
-
CuttingSectionAttributeControl &
UnsetCappingLevel
() Removes the cutting section capping level setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
CuttingSectionAttributeControl &
UnsetCappingUsage
() Removes the cutting section capping usage setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
CuttingSectionAttributeControl &
UnsetCuttingLevel
() Removes the cutting section cutting level setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
CuttingSectionAttributeControl &
UnsetEdgeWeight
() Removes the cutting section cut edge weight setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
CuttingSectionAttributeControl &
UnsetEverything
() Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
CuttingSectionAttributeControl &
UnsetMaterialPreference
() Removes the material preference for cut geometry setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
CuttingSectionAttributeControl &
UnsetTolerance
() Removes the cutting section capping tolerance setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CuttingSectionAttributeKit::GetDefault().
Returns: A reference to this object.
-
~CuttingSectionAttributeControl
() Releases a reference to the database object this control is tied to.
-