#include <hps.h>

Inheritance diagram for HPS::CuttingSectionAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

 CuttingSectionAttributeKit ()
 
 CuttingSectionAttributeKit (CuttingSectionAttributeKit const &in_kit)
 
 CuttingSectionAttributeKit (CuttingSectionAttributeKit &&in_that)
 
bool Empty () const
 
bool Equals (CuttingSectionAttributeKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CuttingSectionAttributeKit const &in_kit) const
 
CuttingSectionAttributeKitoperator= (CuttingSectionAttributeKit &&in_that)
 
CuttingSectionAttributeKitoperator= (CuttingSectionAttributeKit const &in_kit)
 
bool operator== (CuttingSectionAttributeKit const &in_kit) const
 
void Set (CuttingSectionAttributeKit const &in_kit)
 
CuttingSectionAttributeKitSetCappingLevel (CuttingSection::CappingLevel in_level)
 
CuttingSectionAttributeKitSetCappingUsage (CuttingSection::CappingUsage in_usage)
 
CuttingSectionAttributeKitSetCuttingLevel (CuttingSection::CuttingLevel in_level)
 
CuttingSectionAttributeKitSetEdgeWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
 
CuttingSectionAttributeKitSetMaterialPreference (CuttingSection::MaterialPreference in_preference)
 
CuttingSectionAttributeKitSetTolerance (float in_tolerance, CuttingSection::ToleranceUnits in_units)
 
void Show (CuttingSectionAttributeKit &out_kit) const
 
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
 
CuttingSectionAttributeKitUnsetCappingLevel ()
 
CuttingSectionAttributeKitUnsetCappingUsage ()
 
CuttingSectionAttributeKitUnsetCuttingLevel ()
 
CuttingSectionAttributeKitUnsetEdgeWeight ()
 
CuttingSectionAttributeKitUnsetEverything ()
 
CuttingSectionAttributeKitUnsetMaterialPreference ()
 
CuttingSectionAttributeKitUnsetTolerance ()
 
virtual ~CuttingSectionAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- 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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static CuttingSectionAttributeKit 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::CuttingSectionAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (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

◆ CuttingSectionAttributeKit() [1/3]

HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit ( )

Initializes an empty kit.

◆ CuttingSectionAttributeKit() [2/3]

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_kitThe source object to copy.

◆ CuttingSectionAttributeKit() [3/3]

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

◆ ~CuttingSectionAttributeKit()

virtual HPS::CuttingSectionAttributeKit::~CuttingSectionAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::CuttingSectionAttributeKit::Empty ( ) const
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.

◆ Equals()

bool HPS::CuttingSectionAttributeKit::Equals ( CuttingSectionAttributeKit const &  in_kit) const

Check if the source CuttingSectionAttributeKit is equivalent to this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static CuttingSectionAttributeKit HPS::CuttingSectionAttributeKit::GetDefault ( )
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.

◆ ObjectType()

HPS::Type HPS::CuttingSectionAttributeKit::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::Kit.

◆ operator!=()

bool HPS::CuttingSectionAttributeKit::operator!= ( CuttingSectionAttributeKit const &  in_kit) const

Check if the source CuttingSectionAttributeKit is not equivalent to this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::operator= ( CuttingSectionAttributeKit const &  in_kit)

Copies the source CuttingSectionAttributeKit into this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::CuttingSectionAttributeKit::operator== ( CuttingSectionAttributeKit const &  in_kit) const

Check if the source CuttingSectionAttributeKit is equivalent to this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::CuttingSectionAttributeKit::Set ( CuttingSectionAttributeKit const &  in_kit)

Copies all settings from the source CuttingSectionAttributeKit into this object.

Parameters
in_kitThe source CuttingSectionAttributeKit to copy.

◆ SetCappingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::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()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::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()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::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()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::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()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::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()

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

◆ Show()

void HPS::CuttingSectionAttributeKit::Show ( CuttingSectionAttributeKit out_kit) const

Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit.

Parameters
out_kitThe CuttingSectionAttributeKit to populate with the contents of this object.

◆ ShowCappingLevel()

bool HPS::CuttingSectionAttributeKit::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::CuttingSectionAttributeKit::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::CuttingSectionAttributeKit::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::CuttingSectionAttributeKit::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::CuttingSectionAttributeKit::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::CuttingSectionAttributeKit::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.

◆ UnsetCappingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCappingLevel ( )

Removes the cutting section capping level setting.

Returns
A reference to this object.

◆ UnsetCappingUsage()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCappingUsage ( )

Removes the cutting section capping usage setting.

Returns
A reference to this object.

◆ UnsetCuttingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCuttingLevel ( )

Removes the cutting section cutting level setting.

Returns
A reference to this object.

◆ UnsetEdgeWeight()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetEdgeWeight ( )

Removes the cutting section cut edge weight setting.

Returns
A reference to this object.

◆ UnsetEverything()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMaterialPreference()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetMaterialPreference ( )

Removes the material preference for cut geometry setting.

Returns
A reference to this object.

◆ UnsetTolerance()

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: