Public Member Functions | List of all members
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)
 
CuttingSectionAttributeControloperator= (CuttingSectionAttributeControl &&in_that)
 
 ~CuttingSectionAttributeControl ()
 
HPS::Type ObjectType () const
 
CuttingSectionAttributeControloperator= (CuttingSectionAttributeControl const &in_that)
 
CuttingSectionAttributeControlSetCuttingLevel (CuttingSection::CuttingLevel in_level)
 
CuttingSectionAttributeControlSetCappingLevel (CuttingSection::CappingLevel in_level)
 
CuttingSectionAttributeControlSetMaterialPreference (CuttingSection::MaterialPreference in_preference)
 
CuttingSectionAttributeControlUnsetCuttingLevel ()
 
CuttingSectionAttributeControlUnsetCappingLevel ()
 
CuttingSectionAttributeControlUnsetMaterialPreference ()
 
CuttingSectionAttributeControlUnsetEverything ()
 
bool ShowCuttingLevel (CuttingSection::CuttingLevel &out_level) const
 
bool ShowCappingLevel (CuttingSection::CappingLevel &out_level) const
 
bool ShowMaterialPreference (CuttingSection::MaterialPreference &out_preference) const
 
- Public Member Functions inherited from HPS::Control
 Control (Control const &in_that)=default
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

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

HPS::CuttingSectionAttributeControl::CuttingSectionAttributeControl ( SegmentKey in_seg)
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_thatAn 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

HPS::Type HPS::CuttingSectionAttributeControl::ObjectType ( ) const
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_thatAn 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_thatThe 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_levelThe 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_levelThe cutting section cutting level.
Returns
A reference to this object.
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.
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.
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.
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.
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::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.

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