The HPS::CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections. More...

#include <hps.h>

Inheritance diagram for HPS::CuttingSectionAttributeKit:

[legend]

Collaboration diagram for HPS::CuttingSectionAttributeKit:

[legend]

Public Member Functions
	CuttingSectionAttributeKit ()
	Initializes an empty kit. More...

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

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

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

virtual	~CuttingSectionAttributeKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (CuttingSectionAttributeKit const &in_kit)
	Copies all settings from the source CuttingSectionAttributeKit into this object. More...

void	Show (CuttingSectionAttributeKit &out_kit) const
	Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit. More...

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

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

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

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

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

CuttingSectionAttributeKit &	SetEdgeWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
	Sets the cut edge weight. More...

CuttingSectionAttributeKit &	SetTolerance (float in_tolerance, CuttingSection::ToleranceUnits in_units)
	Sets the tolerance for closing loops when processing capping faces. More...

CuttingSectionAttributeKit &	SetCuttingLevel (CuttingSection::CuttingLevel in_level)
	Sets the cutting section cutting level. More...

CuttingSectionAttributeKit &	SetCappingLevel (CuttingSection::CappingLevel in_level)
	Sets the cutting section capping level. More...

CuttingSectionAttributeKit &	SetMaterialPreference (CuttingSection::MaterialPreference in_preference)
	Sets the material preference for cut geometry. More...

CuttingSectionAttributeKit &	UnsetEdgeWeight ()
	Removes the cutting section cut edge weight setting. More...

CuttingSectionAttributeKit &	UnsetTolerance ()
	Removes the cutting section capping tolerance setting. More...

CuttingSectionAttributeKit &	UnsetCuttingLevel ()
	Removes the cutting section cutting level setting. More...

CuttingSectionAttributeKit &	UnsetCappingLevel ()
	Removes the cutting section capping level setting. More...

CuttingSectionAttributeKit &	UnsetMaterialPreference ()
	Removes the material preference for cut geometry setting. More...

CuttingSectionAttributeKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowCuttingLevel (CuttingSection::CuttingLevel &out_level) const
	Shows the cutting section cutting level setting. More...

bool	ShowCappingLevel (CuttingSection::CappingLevel &out_level) const
	Shows the cutting section capping level setting. More...

bool	ShowMaterialPreference (CuttingSection::MaterialPreference &out_preference) const
	Shows the orientation of colors and radii of cylinders. More...

bool	ShowEdgeWeight (float &out_weight, Line::SizeUnits &out_units) const
	Shows the weight of cut edges. More...

bool	ShowTolerance (float &out_tolerance, CuttingSection::ToleranceUnits &out_units) const
	Shows the tolerance for closing loops when processing capping faces. 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 CuttingSectionAttributeKit	GetDefault ()
	Creates a CuttingSectionAttributeKit 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::CuttingSectionAttributeKit

Detailed Description

The HPS::CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections.

Calling HPS::CuttingSectionAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ CuttingSectionAttributeKit() [1/3]

HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit ( )

Initializes an empty kit.

◆ CuttingSectionAttributeKit() [2/3]

HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit ( CuttingSectionAttributeKit const & in_kit )

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

Parameters

in_kit The source object to copy.

◆ CuttingSectionAttributeKit() [3/3]

HPS::CuttingSectionAttributeKit::CuttingSectionAttributeKit ( CuttingSectionAttributeKit && in_that )

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

Parameters

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

◆ ~CuttingSectionAttributeKit()

virtual HPS::CuttingSectionAttributeKit::~CuttingSectionAttributeKit ( )

virtual

Destroy this kit.

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::CuttingSectionAttributeKit::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source CuttingSectionAttributeKit is equivalent to this object.

Parameters

in_kit The source CuttingSectionAttributeKit to compare to this object.

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

static

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

Check if the source CuttingSectionAttributeKit is not equivalent to this object.

Parameters

in_kit The source CuttingSectionAttributeKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this CuttingSectionAttributeKit.

◆ operator=() [2/2]

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

Copies the source CuttingSectionAttributeKit into this object.

Parameters

in_kit The source CuttingSectionAttributeKit to copy.

Returns: A reference to this object.

◆ operator==()

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

Check if the source CuttingSectionAttributeKit is equivalent to this object.

Parameters

in_kit The source CuttingSectionAttributeKit to compare to this object.

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

Copies all settings from the source CuttingSectionAttributeKit into this object.

Parameters

in_kit The source CuttingSectionAttributeKit to copy.

◆ SetCappingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetCappingLevel ( CuttingSection::CappingLevel in_level )

Sets the cutting section capping level.

Parameters

in_level The cutting section capping level.

Returns: A reference to this object.

◆ SetCuttingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetCuttingLevel ( CuttingSection::CuttingLevel in_level )

Sets the cutting section cutting level.

Parameters

in_level The cutting section cutting level.

Returns: A reference to this object.

◆ SetEdgeWeight()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetEdgeWeight	(	float	in_weight,
		Line::SizeUnits	in_units = `Line::SizeUnits::ScaleFactor`
	)

Sets the cut edge weight.

Parameters

in_weight	The edge weight to apply for cut edges.
in_units	The units of the weight given.

Returns: A reference to this object.

◆ SetMaterialPreference()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetMaterialPreference ( CuttingSection::MaterialPreference in_preference )

Sets the material preference for cut geometry.

Parameters

in_preference The material preference for cut geometry.

Returns: A reference to this object.

◆ SetTolerance()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::SetTolerance	(	float	in_tolerance,
		CuttingSection::ToleranceUnits	in_units
	)

Sets the tolerance for closing loops when processing capping faces.

Parameters

in_tolerance	The tolerance to use.
in_units	How to interpret the given tolerance.

Returns: A reference to this object.

◆ Show()

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

Copies all settings from this CuttingSectionAttributeKit into the given CuttingSectionAttributeKit.

Parameters

out_kit The CuttingSectionAttributeKit to populate with the contents of this object.

◆ ShowCappingLevel()

bool HPS::CuttingSectionAttributeKit::ShowCappingLevel ( CuttingSection::CappingLevel & out_level ) const

Shows the cutting section capping level setting.

Parameters

out_level The cutting section capping level.

Returns: true if a cutting section capping level setting was specified, false otherwise.

◆ ShowCuttingLevel()

bool HPS::CuttingSectionAttributeKit::ShowCuttingLevel ( CuttingSection::CuttingLevel & out_level ) const

Shows the cutting section cutting level setting.

Parameters

out_level The cutting section cutting level.

Returns: true if a cutting section cutting level setting was specified, false otherwise.

◆ ShowEdgeWeight()

bool HPS::CuttingSectionAttributeKit::ShowEdgeWeight	(	float &	out_weight,
		Line::SizeUnits &	out_units
	)		const

Shows the weight of cut edges.

Parameters

out_weight	The weight value for cut edges.
out_units	The units applied to in_weight.

Returns: true if the setting is valid, false otherwise.

◆ ShowMaterialPreference()

bool HPS::CuttingSectionAttributeKit::ShowMaterialPreference ( CuttingSection::MaterialPreference & out_preference ) const

Shows the orientation of colors and radii of cylinders.

Parameters

out_preference The material preference for cut geometry.

Returns: true if a material preference for cut geometry was specified, false otherwise.

◆ ShowTolerance()

bool HPS::CuttingSectionAttributeKit::ShowTolerance	(	float &	out_tolerance,
		CuttingSection::ToleranceUnits &	out_units
	)		const

Shows the tolerance for closing loops when processing capping faces.

Parameters

out_tolerance	The tolerance to use.
out_units	The units for the tolerance.

Returns: true if the setting is valid, 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.

◆ UnsetCappingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCappingLevel ( )

Removes the cutting section capping level setting.

Returns: A reference to this object.

◆ UnsetCuttingLevel()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetCuttingLevel ( )

Removes the cutting section cutting level setting.

Returns: A reference to this object.

◆ UnsetEdgeWeight()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetEdgeWeight ( )

Removes the cutting section cut edge weight setting.

Returns: A reference to this object.

◆ UnsetEverything()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetMaterialPreference()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetMaterialPreference ( )

Removes the material preference for cut geometry setting.

Returns: A reference to this object.

◆ UnsetTolerance()

CuttingSectionAttributeKit& HPS::CuttingSectionAttributeKit::UnsetTolerance ( )

Removes the cutting section capping tolerance setting.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::CuttingSectionAttributeKit::staticType = HPS::Type::CuttingSectionAttributeKit

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

◆ CuttingSectionAttributeKit() [1/3]

◆ CuttingSectionAttributeKit() [2/3]

◆ CuttingSectionAttributeKit() [3/3]

◆ ~CuttingSectionAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetCappingLevel()

◆ SetCuttingLevel()

◆ SetEdgeWeight()

◆ SetMaterialPreference()

◆ SetTolerance()

◆ Show()

◆ ShowCappingLevel()

◆ ShowCuttingLevel()

◆ ShowEdgeWeight()

◆ ShowMaterialPreference()

◆ ShowTolerance()

◆ Type()

◆ UnsetCappingLevel()

◆ UnsetCuttingLevel()

◆ UnsetEdgeWeight()

◆ UnsetEverything()

◆ UnsetMaterialPreference()

◆ UnsetTolerance()

Member Data Documentation

◆ staticType