The ShellOptimizationOptionsKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::ShellOptimizationOptionsKit:

Collaboration diagram for HPS::ShellOptimizationOptionsKit:

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

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

	ShellOptimizationOptionsKit (ShellOptimizationOptionsKit &&in_that)
	The move constructor creates a ShellOptimizationOptionsKit by transferring the underlying impl of the rvalue reference to this ShellOptimizationOptionsKit thereby avoiding a copy and allocation. More...

virtual	~ShellOptimizationOptionsKit ()

HPS::Type	ObjectType () const

void	Consume (ShellOptimizationOptionsKit &in_kit)
	Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit and resets the source kit. More...

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

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

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

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

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

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

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

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

ShellOptimizationOptionsKit &	SetNormalTolerance (float in_normal_tolerance)
	Sets the tolerance to use when deciding if two normals can be merged. More...

ShellOptimizationOptionsKit &	SetTolerance (float in_tolerance, Shell::ToleranceUnits in_tolerance_units)
	Sets the tolerance to use when deciding if two vertices can be merged. More...

ShellOptimizationOptionsKit &	SetOrphanElimination (bool in_orphan_elimination)
	Sets whether orphan elimination can be used during optimization. More...

ShellOptimizationOptionsKit &	SetHandednessOptimization (Shell::HandednessOptimization in_handedness_option)
	Sets whether the optimization procedure should impact the shell's face handedness, and if so, in which way. More...

ShellOptimizationOptionsKit &	UnsetNormalTolerance ()
	Removes the normal tolerance value for this ShellOptimizationOptionsKit. More...

ShellOptimizationOptionsKit &	UnsetTolerance ()
	Removes the tolerance value for this ShellOptimizationOptionsKit. More...

ShellOptimizationOptionsKit &	UnsetOrphanElimination ()
	Removes the orphan elimination value for this ShellOptimizationOptionsKit. More...

ShellOptimizationOptionsKit &	UnsetHandednessOptimization ()
	Removes the fix handedness value for this ShellOptimizationOptionsKit. More...

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

bool	ShowNormalTolerance (float &out_normal_tolerance) const
	Shows the value of the normal tolerance for this ShellOptimizationOptionsKit. More...

bool	ShowTolerance (float &out_tolerance, Shell::ToleranceUnits &out_tolerance_units) const
	Shows the value of the tolerance and its units for this ShellOptimizationOptionsKit. More...

bool	ShowOrphanElimination (bool &out_orphan_elimination) const
	Shows the value of orphan elimination for this ShellOptimizationOptionsKit. More...

bool	ShowHandednessOptimization (Shell::HandednessOptimization &out_handedness_option) const
	Shows the value of the handedness options for this ShellOptimizationOptionsKit. 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 ShellOptimizationOptionsKit	GetDefault ()
	Creates a ShellOptimizationOptionsKit 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::ShellOptimizationOptionsKit

Detailed Description

The ShellOptimizationOptionsKit class is a user space object.

It is used for setting options for a shell optimization operation. Calling HPS::ShellOptimizationOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ ShellOptimizationOptionsKit() [1/3]

HPS::ShellOptimizationOptionsKit::ShellOptimizationOptionsKit ( )

The default constructor creates an empty ShellOptimizationOptionsKit object.

◆ ShellOptimizationOptionsKit() [2/3]

HPS::ShellOptimizationOptionsKit::ShellOptimizationOptionsKit ( ShellOptimizationOptionsKit const & in_kit )

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

Parameters

in_kit The source ShellOptimizationOptionsKit to copy.

◆ ShellOptimizationOptionsKit() [3/3]

HPS::ShellOptimizationOptionsKit::ShellOptimizationOptionsKit ( ShellOptimizationOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to a ShellOptimizationOptionsKit to take the impl from.

◆ ~ShellOptimizationOptionsKit()

virtual HPS::ShellOptimizationOptionsKit::~ShellOptimizationOptionsKit ( )

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.

◆ Consume()

void HPS::ShellOptimizationOptionsKit::Consume ( ShellOptimizationOptionsKit & in_kit )

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit and resets the source kit.

Parameters

in_kit The source ShellOptimizationOptionsKit to consume.

◆ Empty()

bool HPS::ShellOptimizationOptionsKit::Empty ( ) const

virtual

Indicates whether this ShellOptimizationOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit.

Parameters

in_kit The source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit.

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 ShellOptimizationOptionsKit HPS::ShellOptimizationOptionsKit::GetDefault ( )

static

Creates a ShellOptimizationOptionsKit 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 ShellOptimizationOptionsKit 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::ShellOptimizationOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit.

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

◆ operator=() [1/2]

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

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Parameters

in_kit The source ShellOptimizationOptionsKit to copy.

Returns: A reference to this ShellOptimizationOptionsKit.

◆ operator=() [2/2]

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

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

Parameters

in_that An rvalue reference to a ShellOptimizationOptionsKit to take the impl from.

Returns: A reference to this ShellOptimizationOptionsKit.

◆ operator==()

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

Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit.

Parameters

in_kit The source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit.

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::ShellOptimizationOptionsKit::Set ( ShellOptimizationOptionsKit const & in_kit )

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Parameters

in_kit The source ShellOptimizationOptionsKit to copy.

◆ SetHandednessOptimization()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetHandednessOptimization ( Shell::HandednessOptimization in_handedness_option )

Sets whether the optimization procedure should impact the shell's face handedness, and if so, in which way.

Parameters

in_handedness_optimization	Whether handedness should be altered during optimization.
in_handedness_option	Whether the faces' handedness should be fixed or reversed.

Returns: A reference to this object.

◆ SetNormalTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetNormalTolerance ( float in_normal_tolerance )

Sets the tolerance to use when deciding if two normals can be merged.

Parameters

in_normal_tolerance The tolerance to use during optimization, specified in degrees.

Returns: A reference to this object.

◆ SetOrphanElimination()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetOrphanElimination ( bool in_orphan_elimination )

Sets whether orphan elimination can be used during optimization.

Orphan elimination removes points that are not referenced by any face.

Parameters

in_orphan_elimination Whether orphaned points can be eliminated during optimization.

Returns: A reference to this object.

◆ SetTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetTolerance	(	float	in_tolerance,
		Shell::ToleranceUnits	in_tolerance_units
	)

Sets the tolerance to use when deciding if two vertices can be merged.

Parameters

in_tolerance	The tolerance to use during optimization.
in_tolerance_units	The units in_tolerance is specified in.

Returns: A reference to this object.

◆ Show()

void HPS::ShellOptimizationOptionsKit::Show ( ShellOptimizationOptionsKit & out_kit ) const

Copies this ShellOptimizationOptionsKit into the given ShellOptimizationOptionsKit.

Parameters

out_kit The ShellOptimizationOptionsKit to populate with the contents of this ShellOptimizationOptionsKit.

◆ ShowHandednessOptimization()

bool HPS::ShellOptimizationOptionsKit::ShowHandednessOptimization ( Shell::HandednessOptimization & out_handedness_option ) const

Shows the value of the handedness options for this ShellOptimizationOptionsKit.

Parameters

out_handedness_optimization	The handedness optimization value for this ShellOptimizationOptionsKit.
out_handedness_option	The handedness option value for this ShellOptimizationOptionsKit.

Returns: true if fix handedness was set, false otherwise.

◆ ShowNormalTolerance()

bool HPS::ShellOptimizationOptionsKit::ShowNormalTolerance ( float & out_normal_tolerance ) const

Shows the value of the normal tolerance for this ShellOptimizationOptionsKit.

Parameters

out_normal_tolerance The normal tolerance for this ShellOptimizationOptionsKit.

Returns: true if normal tolerance was set, false otherwise.

◆ ShowOrphanElimination()

bool HPS::ShellOptimizationOptionsKit::ShowOrphanElimination ( bool & out_orphan_elimination ) const

Shows the value of orphan elimination for this ShellOptimizationOptionsKit.

Parameters

out_orphan_elimination The orphan elimination value for this ShellOptimizationOptionsKit.

Returns: true if orphan elimination was set, false otherwise.

◆ ShowTolerance()

bool HPS::ShellOptimizationOptionsKit::ShowTolerance	(	float &	out_tolerance,
		Shell::ToleranceUnits &	out_tolerance_units
	)		const

Shows the value of the tolerance and its units for this ShellOptimizationOptionsKit.

Parameters

out_tolerance	The tolerance for this ShellOptimizationOptionsKit.
out_tolerance_units	The units out_tolerance is specified in.

Returns: true if tolerance 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.

◆ UnsetEverything()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetEverything ( )

Removes all settings from this ShellOptimizationOptionsKit.

Returns: A reference to this ShellOptimizationOptionsKit.

◆ UnsetHandednessOptimization()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetHandednessOptimization ( )

Removes the fix handedness value for this ShellOptimizationOptionsKit.

Returns: A reference to this object.

◆ UnsetNormalTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetNormalTolerance ( )

Removes the normal tolerance value for this ShellOptimizationOptionsKit.

Returns: A reference to this object.

◆ UnsetOrphanElimination()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetOrphanElimination ( )

Removes the orphan elimination value for this ShellOptimizationOptionsKit.

Returns: A reference to this object.

◆ UnsetTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetTolerance ( )

Removes the tolerance value for this ShellOptimizationOptionsKit.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::ShellOptimizationOptionsKit::staticType = HPS::Type::ShellOptimizationOptionsKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShellOptimizationOptionsKit() [1/3]

◆ ShellOptimizationOptionsKit() [2/3]

◆ ShellOptimizationOptionsKit() [3/3]

◆ ~ShellOptimizationOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetHandednessOptimization()

◆ SetNormalTolerance()

◆ SetOrphanElimination()

◆ SetTolerance()

◆ Show()

◆ ShowHandednessOptimization()

◆ ShowNormalTolerance()

◆ ShowOrphanElimination()

◆ ShowTolerance()

◆ Type()

◆ UnsetEverything()

◆ UnsetHandednessOptimization()

◆ UnsetNormalTolerance()

◆ UnsetOrphanElimination()

◆ UnsetTolerance()

Member Data Documentation

◆ staticType