HPS::CuttingSectionAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::CuttingSectionAttributeControl:
HPS::Control HPS::Object

Public Member Functions

 CuttingSectionAttributeControl (SegmentKey &in_seg)
 
 CuttingSectionAttributeControl (CuttingSectionAttributeControl const &in_that)
 
 CuttingSectionAttributeControl (CuttingSectionAttributeControl &&in_that)
 
HPS::Type ObjectType () const
 
CuttingSectionAttributeControloperator= (CuttingSectionAttributeControl &&in_that)
 
CuttingSectionAttributeControloperator= (CuttingSectionAttributeControl const &in_that)
 
CuttingSectionAttributeControlSetCappingLevel (CuttingSection::CappingLevel in_level)
 
CuttingSectionAttributeControlSetCappingUsage (CuttingSection::CappingUsage in_usage)
 
CuttingSectionAttributeControlSetCuttingLevel (CuttingSection::CuttingLevel in_level)
 
CuttingSectionAttributeControlSetEdgeWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
 
CuttingSectionAttributeControlSetMaterialPreference (CuttingSection::MaterialPreference in_preference)
 
CuttingSectionAttributeControlSetTolerance (float in_tolerance, CuttingSection::ToleranceUnits in_units)
 
bool ShowCappingLevel (CuttingSection::CappingLevel &out_level) const
 
bool ShowCappingUsage (CuttingSection::CappingUsage &out_usage) const
 
bool ShowCuttingLevel (CuttingSection::CuttingLevel &out_level) const
 
bool ShowEdgeWeight (float &out_weight, Line::SizeUnits &out_units) const
 
bool ShowMaterialPreference (CuttingSection::MaterialPreference &out_preference) const
 
bool ShowTolerance (float &out_tolerance, CuttingSection::ToleranceUnits &out_units) const
 
virtual HPS::Type Type () const
 
CuttingSectionAttributeControlUnsetCappingLevel ()
 
CuttingSectionAttributeControlUnsetCappingUsage ()
 
CuttingSectionAttributeControlUnsetCuttingLevel ()
 
CuttingSectionAttributeControlUnsetEdgeWeight ()
 
CuttingSectionAttributeControlUnsetEverything ()
 
CuttingSectionAttributeControlUnsetMaterialPreference ()
 
CuttingSectionAttributeControlUnsetTolerance ()
 
 ~CuttingSectionAttributeControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (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

◆ CuttingSectionAttributeControl() [1/3]

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ CuttingSectionAttributeControl() [2/3]

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl ( CuttingSectionAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ CuttingSectionAttributeControl() [3/3]

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_thatAn rvalue reference to a CuttingSectionAttributeControl to take the impl from.

◆ ~CuttingSectionAttributeControl()

HPS::CuttingSectionAttributeControl::~CuttingSectionAttributeControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::CuttingSectionAttributeControl::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::Control.

◆ operator=() [1/2]

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_thatAn rvalue reference to a CuttingSectionAttributeControl to take the impl from.
Returns
A reference to this CuttingSectionAttributeControl.

◆ operator=() [2/2]

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::operator= ( CuttingSectionAttributeControl const &  in_that)

Share the underlying smart-pointer of the CuttingSectionAttributeControl source.

Parameters
in_thatThe CuttingSectionAttributeControl source of the assignment.
Returns
A reference to this CuttingSectionAttributeControl.

◆ SetCappingLevel()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetCappingLevel ( CuttingSection::CappingLevel  in_level)

Sets the cutting section capping level.

Parameters
in_levelThe cutting section capping level.
Returns
A reference to this object.

◆ SetCappingUsage()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetCappingUsage ( CuttingSection::CappingUsage  in_usage)

Sets the cutting section capping usage.

Parameters
in_usageThe cutting section capping usage.
Returns
A reference to this object.

◆ SetCuttingLevel()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetCuttingLevel ( CuttingSection::CuttingLevel  in_level)

Sets the cutting section cutting level.

Parameters
in_levelThe cutting section cutting level.
Returns
A reference to this object.

◆ SetEdgeWeight()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetEdgeWeight ( float  in_weight,
Line::SizeUnits  in_units = Line::SizeUnits::ScaleFactor 
)

Sets the cut edge weight.

Parameters
in_weightThe edge weight to apply for cut edges.
in_unitsThe units of the weight given.
Returns
A reference to this object.

◆ SetMaterialPreference()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetMaterialPreference ( CuttingSection::MaterialPreference  in_preference)

Sets the material preference for cut geometry.

Parameters
in_preferenceThe material preference for cut geometry.
Returns
A reference to this object.

◆ SetTolerance()

CuttingSectionAttributeControl& HPS::CuttingSectionAttributeControl::SetTolerance ( float  in_tolerance,
CuttingSection::ToleranceUnits  in_units 
)

Sets the tolerance for closing loops when processing capping faces.

Parameters
in_toleranceThe tolerance to use.
in_unitsHow to interpret the given tolerance.
Returns
A reference to this object.

◆ ShowCappingLevel()

bool HPS::CuttingSectionAttributeControl::ShowCappingLevel ( CuttingSection::CappingLevel out_level) const

Shows the cutting section capping level setting.

Parameters
out_levelThe cutting section capping level.
Returns
true if a cutting section capping level setting was specified, false otherwise.

◆ ShowCappingUsage()

bool HPS::CuttingSectionAttributeControl::ShowCappingUsage ( CuttingSection::CappingUsage out_usage) const

Shows the cutting section capping usage setting.

Parameters
out_levelThe cutting section capping usage.
Returns
true if a cutting section capping usage setting was specified, false otherwise.

◆ ShowCuttingLevel()

bool HPS::CuttingSectionAttributeControl::ShowCuttingLevel ( CuttingSection::CuttingLevel out_level) const

Shows the cutting section cutting level setting.

Parameters
out_levelThe cutting section cutting level.
Returns
true if a cutting section cutting level setting was specified, false otherwise.

◆ ShowEdgeWeight()

bool HPS::CuttingSectionAttributeControl::ShowEdgeWeight ( float &  out_weight,
Line::SizeUnits out_units 
) const

Shows the weight of cut edges.

Parameters
out_weightThe weight value for cut edges.
out_unitsThe units applied to in_weight.
Returns
true if the setting is valid, false otherwise.

◆ ShowMaterialPreference()

bool HPS::CuttingSectionAttributeControl::ShowMaterialPreference ( CuttingSection::MaterialPreference out_preference) const

Shows the orientation of colors and radii of cylinders.

Parameters
out_preferenceThe material preference for cut geometry.
Returns
true if a material preference for cut geometry was specified, false otherwise.

◆ ShowTolerance()

bool HPS::CuttingSectionAttributeControl::ShowTolerance ( float &  out_tolerance,
CuttingSection::ToleranceUnits out_units 
) const

Shows the tolerance for closing loops when processing capping faces.

Parameters
out_toleranceThe tolerance to use.
out_unitsThe units for the tolerance.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::CuttingSectionAttributeControl::Type ( ) const
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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetCappingLevel()

CuttingSectionAttributeControl& HPS::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.

◆ UnsetCappingUsage()

CuttingSectionAttributeControl& HPS::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.

◆ UnsetCuttingLevel()

CuttingSectionAttributeControl& HPS::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.

◆ UnsetEdgeWeight()

CuttingSectionAttributeControl& HPS::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.

◆ UnsetEverything()

CuttingSectionAttributeControl& HPS::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.

◆ UnsetMaterialPreference()

CuttingSectionAttributeControl& HPS::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.

◆ UnsetTolerance()

CuttingSectionAttributeControl& HPS::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.

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