CutGeometryGatheringOptionsKit

class HPS::CutGeometryGatheringOptionsKit : public HPS::Kit

Public Functions

CutGeometryGatheringOptionsKit()

The default constructor creates an empty CutGeometryGatheringOptionsKit object.

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_that – An rvalue reference to a CutGeometryGatheringOptionsKit to take the impl from.

CutGeometryGatheringOptionsKit(CutGeometryGatheringOptionsKit const &in_kit)

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

Parameters

in_kit – The source CutGeometryGatheringOptionsKit to copy.

virtual bool Empty() const

Indicates whether this CutGeometryGatheringOptionsKit has any values set on it.

Returns

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

bool Equals(CutGeometryGatheringOptionsKit const &in_kit) const

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

Parameters

in_kit – The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

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.

bool operator!=(CutGeometryGatheringOptionsKit const &in_kit) const

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

Parameters

in_kit – The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

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_that – An rvalue reference to a CutGeometryGatheringOptionsKit to take the impl from.

Returns

A reference to this CutGeometryGatheringOptionsKit.

CutGeometryGatheringOptionsKit &operator=(CutGeometryGatheringOptionsKit const &in_kit)

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters

in_kit – The source CutGeometryGatheringOptionsKit to copy.

Returns

A reference to this CutGeometryGatheringOptionsKit.

bool operator==(CutGeometryGatheringOptionsKit const &in_kit) const

Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.

Parameters

in_kit – The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

void Set(CutGeometryGatheringOptionsKit const &in_kit)

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters

in_kit – The source CutGeometryGatheringOptionsKit to copy.

CutGeometryGatheringOptionsKit &SetColor(bool in_color)

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

Parameters

in_color – Whether the color is collected.

Returns

A reference to this CutGeometryGatheringOptionsKit.

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_cutter – A single cutting section that is interesting for capping geometry collection.

Returns

A reference to this CutGeometryGatheringOptionsKit.

CutGeometryGatheringOptionsKit &SetLevel(CuttingSection::GatheringLevel in_level)

Sets the level at which to collect the capping geometry.

Parameters

in_level – Whether the capping geometry should be collected from just a single segment or an entire subtree.

Returns

A reference to this CutGeometryGatheringOptionsKit.

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_offset – An offset for a single plane in a cutting section.

Returns

A reference to this CutGeometryGatheringOptionsKit.

void Show(CutGeometryGatheringOptionsKit &out_kit) const

Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit.

Parameters

out_kit – The CutGeometryGatheringOptionsKit to populate with the contents of this CutGeometryGatheringOptionsKit.

bool ShowColor(bool &out_color) const

Shows the color gathering preference whe collecting capping geometry.

Parameters

out_color – Whether 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.

bool ShowCuttingSection(CuttingSectionKey &out_cutter) const

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

Parameters

out_cutter – A cutting section that is interesting for capping geometry collection.

Returns

true if a cutting section was set, false otherwise.

bool ShowLevel(CuttingSection::GatheringLevel &out_level) const

Shows the level at which to collect the capping geometry.

Parameters

out_level – Whether the capping geometry should be collected from just a single segment or an entire subtree.

Returns

true if a level was set, false otherwise.

bool ShowOffset(size_t &out_offset) const

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

Parameters

out_offset – An offset for a single plane in a cutting section.

Returns

true if an offset was set, false otherwise.

CutGeometryGatheringOptionsKit &UnsetColor()

Removes the color setting when collecting the capping geometry.

Returns

A reference to this CutGeometryGatheringOptionsKit.

CutGeometryGatheringOptionsKit &UnsetCuttingSection()

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

Returns

A reference to this CutGeometryGatheringOptionsKit.

CutGeometryGatheringOptionsKit &UnsetEverything()

Removes all settings from this CutGeometryGatheringOptionsKit.

Returns

A reference to this CutGeometryGatheringOptionsKit.

CutGeometryGatheringOptionsKit &UnsetLevel()

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

Returns

A reference to this CutGeometryGatheringOptionsKit.

CutGeometryGatheringOptionsKit &UnsetOffset()

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

Returns

A reference to this CutGeometryGatheringOptionsKit.

virtual ~CutGeometryGatheringOptionsKit()

Public Static Functions

static CutGeometryGatheringOptionsKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CutGeometryGatheringOptionsKit