#include <hps.h>

Inheritance diagram for HPS::CutGeometryGatheringOptionsKit:

Collaboration diagram for HPS::CutGeometryGatheringOptionsKit:

Public Member Functions
	CutGeometryGatheringOptionsKit ()
	The default constructor creates an empty CutGeometryGatheringOptionsKit object. More...

	CutGeometryGatheringOptionsKit (CutGeometryGatheringOptionsKit const &in_kit)
	The copy constructor creates a new CutGeometryGatheringOptionsKit object that contains the same settings as the source CutGeometryGatheringOptionsKit. More...

	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. More...

CutGeometryGatheringOptionsKit &	operator= (CutGeometryGatheringOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CutGeometryGatheringOptionsKit thereby avoiding a copy. More...

virtual	~CutGeometryGatheringOptionsKit ()

HPS::Type	ObjectType () const

void	Set (CutGeometryGatheringOptionsKit const &in_kit)
	Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit. More...

void	Show (CutGeometryGatheringOptionsKit &out_kit) const
	Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit. More...

CutGeometryGatheringOptionsKit &	operator= (CutGeometryGatheringOptionsKit const &in_kit)
	Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit. More...

bool	Empty () const
	Indicates whether this CutGeometryGatheringOptionsKit has any values set on it. More...

bool	Equals (CutGeometryGatheringOptionsKit const &in_kit) const
	Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit. More...

bool	operator== (CutGeometryGatheringOptionsKit const &in_kit) const
	Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit. More...

bool	operator!= (CutGeometryGatheringOptionsKit const &in_kit) const
	Check if the source CutGeometryGatheringOptionsKit is not equivalent to this CutGeometryGatheringOptionsKit. More...

CutGeometryGatheringOptionsKit &	SetCuttingSection (CuttingSectionKey const &in_cutter)
	Sets a single cutting section for which to collect capping geometry. More...

CutGeometryGatheringOptionsKit &	SetOffset (size_t in_offset)
	If a single cutting section is specified, this sets the plane offset into that section. More...

CutGeometryGatheringOptionsKit &	SetLevel (CuttingSection::GatheringLevel in_level)
	Sets the level at which to collect the capping geometry. More...

CutGeometryGatheringOptionsKit &	SetColor (bool in_color)
	Sets whether the implicit color is collected with the capping geometry. More...

CutGeometryGatheringOptionsKit &	UnsetCuttingSection ()
	Removes a single cutting section for which to collect capping geometry. More...

CutGeometryGatheringOptionsKit &	UnsetOffset ()
	Removes an offset for a single plane in a cutting section. More...

CutGeometryGatheringOptionsKit &	UnsetLevel ()
	Removes the level setting at which to collect the capping geometry. More...

CutGeometryGatheringOptionsKit &	UnsetColor ()
	Removes the color setting when collecting the capping geometry. More...

CutGeometryGatheringOptionsKit &	UnsetEverything ()
	Removes all settings from this CutGeometryGatheringOptionsKit. More...

bool	ShowCuttingSection (CuttingSectionKey &out_cutter) const
	Shows a cutting section that is interesting for capping geometry collection. More...

bool	ShowOffset (size_t &out_offset) const
	Shows an offset for a single plane in a cutting section. More...

bool	ShowLevel (CuttingSection::GatheringLevel &out_level) const
	Shows the level at which to collect the capping geometry. More...

bool	ShowColor (bool &out_color) const
	Shows the color gathering preference whe collecting capping geometry. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static CutGeometryGatheringOptionsKit	GetDefault ()
	Creates a CutGeometryGatheringOptionsKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::CutGeometryGatheringOptionsKit

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

◆ ~CutGeometryGatheringOptionsKit()

virtual HPS::CutGeometryGatheringOptionsKit::~CutGeometryGatheringOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ 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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::CutGeometryGatheringOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

◆ 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_that An 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_kit The 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_kit The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.

Parameters

in_kit The 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_color Whether 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_cutter A 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_level Whether 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_offset An 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_kit The 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_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.

◆ ShowCuttingSection()

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

◆ ShowLevel()

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

◆ ShowOffset()

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

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ 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.

Member Data Documentation

◆ staticType

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

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ CutGeometryGatheringOptionsKit() [1/3]

◆ CutGeometryGatheringOptionsKit() [2/3]

◆ CutGeometryGatheringOptionsKit() [3/3]

◆ ~CutGeometryGatheringOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetColor()

◆ SetCuttingSection()

◆ SetLevel()

◆ SetOffset()

◆ Show()

◆ ShowColor()

◆ ShowCuttingSection()

◆ ShowLevel()

◆ ShowOffset()

◆ Type()

◆ UnsetColor()

◆ UnsetCuttingSection()

◆ UnsetEverything()

◆ UnsetLevel()

◆ UnsetOffset()

Member Data Documentation

◆ staticType