Inheritance diagram for HPS::CutGeometryGatheringOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

 CutGeometryGatheringOptionsKit ()
 
 CutGeometryGatheringOptionsKit (CutGeometryGatheringOptionsKit const &in_kit)
 
 CutGeometryGatheringOptionsKit (CutGeometryGatheringOptionsKit &&in_that)
 
bool Empty () const
 
bool Equals (CutGeometryGatheringOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CutGeometryGatheringOptionsKit const &in_kit) const
 
CutGeometryGatheringOptionsKitoperator= (CutGeometryGatheringOptionsKit &&in_that)
 
CutGeometryGatheringOptionsKitoperator= (CutGeometryGatheringOptionsKit const &in_kit)
 
bool operator== (CutGeometryGatheringOptionsKit const &in_kit) const
 
void Set (CutGeometryGatheringOptionsKit const &in_kit)
 
CutGeometryGatheringOptionsKitSetColor (bool in_color)
 
CutGeometryGatheringOptionsKitSetCuttingSection (CuttingSectionKey const &in_cutter)
 
CutGeometryGatheringOptionsKitSetLevel (CuttingSection::GatheringLevel in_level)
 
CutGeometryGatheringOptionsKitSetOffset (size_t in_offset)
 
void Show (CutGeometryGatheringOptionsKit &out_kit) const
 
bool ShowColor (bool &out_color) const
 
bool ShowCuttingSection (CuttingSectionKey &out_cutter) const
 
bool ShowLevel (CuttingSection::GatheringLevel &out_level) const
 
bool ShowOffset (size_t &out_offset) const
 
CutGeometryGatheringOptionsKitUnsetColor ()
 
CutGeometryGatheringOptionsKitUnsetCuttingSection ()
 
CutGeometryGatheringOptionsKitUnsetEverything ()
 
CutGeometryGatheringOptionsKitUnsetLevel ()
 
CutGeometryGatheringOptionsKitUnsetOffset ()
 
- 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 CutGeometryGatheringOptionsKit 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::CutGeometryGatheringOptionsKit
 
- 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)
 

Constructor & Destructor Documentation

◆ CutGeometryGatheringOptionsKit() [1/3]

HPS::CutGeometryGatheringOptionsKit::CutGeometryGatheringOptionsKit ( )

The default constructor creates an empty CutGeometryGatheringOptionsKit object.

◆ CutGeometryGatheringOptionsKit() [2/3]

HPS::CutGeometryGatheringOptionsKit::CutGeometryGatheringOptionsKit ( CutGeometryGatheringOptionsKit const &  in_kit)

The copy constructor creates a new CutGeometryGatheringOptionsKit object that contains the same settings as the source CutGeometryGatheringOptionsKit.

Parameters
in_kitThe source CutGeometryGatheringOptionsKit to copy.

◆ CutGeometryGatheringOptionsKit() [3/3]

HPS::CutGeometryGatheringOptionsKit::CutGeometryGatheringOptionsKit ( CutGeometryGatheringOptionsKit &&  in_that)

The move constructor creates a CutGeometryGatheringOptionsKit by transferring the underlying impl of the rvalue reference to this CutGeometryGatheringOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a CutGeometryGatheringOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::CutGeometryGatheringOptionsKit::Empty ( ) const
virtual

Indicates whether this CutGeometryGatheringOptionsKit has any values set on it.

Returns
true if no values are set on this CutGeometryGatheringOptionsKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

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

◆ GetDefault()

static CutGeometryGatheringOptionsKit HPS::CutGeometryGatheringOptionsKit::GetDefault ( )
static

Creates a CutGeometryGatheringOptionsKit 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 CutGeometryGatheringOptionsKit with the default settings.

◆ ObjectType()

HPS::Type HPS::CutGeometryGatheringOptionsKit::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::CutGeometryGatheringOptionsKit::operator!= ( CutGeometryGatheringOptionsKit const &  in_kit) const

Check if the source CutGeometryGatheringOptionsKit is not equivalent to this CutGeometryGatheringOptionsKit.

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

◆ operator=() [1/2]

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::operator= ( CutGeometryGatheringOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this CutGeometryGatheringOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a CutGeometryGatheringOptionsKit to take the impl from.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ operator=() [2/2]

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

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters
in_kitThe source CutGeometryGatheringOptionsKit to copy.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ operator==()

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

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

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

◆ Set()

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

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters
in_kitThe source CutGeometryGatheringOptionsKit to copy.

◆ SetColor()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::SetColor ( bool  in_color)

Sets whether the implicit color is collected with the capping geometry.

Parameters
in_colorWhether the color is collected.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ SetCuttingSection()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::SetCuttingSection ( CuttingSectionKey const &  in_cutter)

Sets a single cutting section for which to collect capping geometry. If this is not specified, caps for all cutting sections will be collected.

Parameters
in_cutterA single cutting section that is interesting for capping geometry collection.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ SetLevel()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::SetLevel ( CuttingSection::GatheringLevel  in_level)

Sets the level at which to collect the capping geometry.

Parameters
in_levelWhether the capping geometry should be collected from just a single segment or an entire subtree.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ SetOffset()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::SetOffset ( size_t  in_offset)

If a single cutting section is specified, this sets the plane offset into that section. If this is not set, all planes in that section will be collected.

Parameters
in_offsetAn offset for a single plane in a cutting section.
Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ Show()

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

Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit.

Parameters
out_kitThe CutGeometryGatheringOptionsKit to populate with the contents of this CutGeometryGatheringOptionsKit.

◆ ShowColor()

bool HPS::CutGeometryGatheringOptionsKit::ShowColor ( bool &  out_color) const

Shows the color gathering preference whe collecting capping geometry.

Parameters
out_colorWhether the implicit color of the capping geometry should be collected along with the geometry.
Returns
true if a color gathering preference was set, false otherwise.

◆ ShowCuttingSection()

bool HPS::CutGeometryGatheringOptionsKit::ShowCuttingSection ( CuttingSectionKey out_cutter) const

Shows a cutting section that is interesting for capping geometry collection.

Parameters
out_cutterA cutting section that is interesting for capping geometry collection.
Returns
true if a cutting section was set, false otherwise.

◆ ShowLevel()

bool HPS::CutGeometryGatheringOptionsKit::ShowLevel ( CuttingSection::GatheringLevel out_level) const

Shows the level at which to collect the capping geometry.

Parameters
out_levelWhether the capping geometry should be collected from just a single segment or an entire subtree.
Returns
true if a level was set, false otherwise.

◆ ShowOffset()

bool HPS::CutGeometryGatheringOptionsKit::ShowOffset ( size_t &  out_offset) const

Shows an offset for a single plane in a cutting section.

Parameters
out_offsetAn offset for a single plane in a cutting section.
Returns
true if an offset was set, false otherwise.

◆ UnsetColor()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::UnsetColor ( )

Removes the color setting when collecting the capping geometry.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetCuttingSection()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::UnsetCuttingSection ( )

Removes a single cutting section for which to collect capping geometry.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetEverything()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::UnsetEverything ( )

Removes all settings from this CutGeometryGatheringOptionsKit.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetLevel()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::UnsetLevel ( )

Removes the level setting at which to collect the capping geometry.

Returns
A reference to this CutGeometryGatheringOptionsKit.

◆ UnsetOffset()

CutGeometryGatheringOptionsKit& HPS::CutGeometryGatheringOptionsKit::UnsetOffset ( )

Removes an offset for a single plane in a cutting section.

Returns
A reference to this CutGeometryGatheringOptionsKit.

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