The HPS::SelectabilityKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::SelectabilityKit:

Collaboration diagram for HPS::SelectabilityKit:

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

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

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

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

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

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

SelectabilityKit &	SetWindows (Selectability::Value in_val)
	Controls whether windows can be selected by selection actions. More...

SelectabilityKit &	SetWindows (bool in_val)
	Controls whether windows can be selected by selection actions. More...

SelectabilityKit &	SetEdges (Selectability::Value in_val)
	Controls whether edges can be selected by selection actions. More...

SelectabilityKit &	SetEdges (bool in_val)
	Controls whether edges can be selected by selection actions. More...

SelectabilityKit &	SetFaces (Selectability::Value in_val)
	Controls whether faces can be selected by selection actions. More...

SelectabilityKit &	SetFaces (bool in_val)
	Controls whether faces can be selected by selection actions. More...

SelectabilityKit &	SetLights (Selectability::Value in_val)
	Controls whether lights can be selected by selection actions. More...

SelectabilityKit &	SetLights (bool in_val)
	Controls whether lights can be selected by selection actions. More...

SelectabilityKit &	SetLines (Selectability::Value in_val)
	Controls whether lines can be selected by selection actions. More...

SelectabilityKit &	SetLines (bool in_val)
	Controls whether lines can be selected by selection actions. More...

SelectabilityKit &	SetMarkers (Selectability::Value in_val)
	Controls whether markers can be selected by selection actions. More...

SelectabilityKit &	SetMarkers (bool in_val)
	Controls whether markers can be selected by selection actions. More...

SelectabilityKit &	SetVertices (Selectability::Value in_val)
	Controls whether vertices can be selected by selection actions. More...

SelectabilityKit &	SetVertices (bool in_val)
	Controls whether vertices can be selected by selection actions. More...

SelectabilityKit &	SetText (Selectability::Value in_val)
	Controls whether text can be selected by selection actions. More...

SelectabilityKit &	SetText (bool in_val)
	Controls whether text can be selected by selection actions. More...

SelectabilityKit &	SetGeometry (Selectability::Value in_val)
	Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More...

SelectabilityKit &	SetGeometry (bool in_val)
	Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More...

SelectabilityKit &	SetEverything (Selectability::Value in_val)
	Sets the selectability of all geometry, subgeometry and windows. More...

SelectabilityKit &	SetEverything (bool in_val)
	Sets the selectability of all geometry, subgeometry and windows. More...

SelectabilityKit &	UnsetWindows ()
	Removes the selectability setting from windows. More...

SelectabilityKit &	UnsetEdges ()
	Removes the selectability setting from edges. More...

SelectabilityKit &	UnsetFaces ()
	Removes the selectability setting from faces. More...

SelectabilityKit &	UnsetLights ()
	Removes the selectability setting from lights. More...

SelectabilityKit &	UnsetLines ()
	Removes the selectability setting from lines. More...

SelectabilityKit &	UnsetMarkers ()
	Removes the selectability setting from markers. More...

SelectabilityKit &	UnsetVertices ()
	Removes the selectability setting from vertices. More...

SelectabilityKit &	UnsetText ()
	Removes the selectability setting from text. More...

SelectabilityKit &	UnsetGeometry ()
	Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text. More...

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

bool	ShowWindows (Selectability::Value &out_val) const
	Shows whether windows can be selected by selection actions. More...

bool	ShowEdges (Selectability::Value &out_val) const
	Shows whether edges can be selected by selection actions. More...

bool	ShowFaces (Selectability::Value &out_val) const
	Shows whether faces can be selected by selection actions. More...

bool	ShowLights (Selectability::Value &out_val) const
	Shows whether lights can be selected by selection actions. More...

bool	ShowLines (Selectability::Value &out_val) const
	Shows whether lines can be selected by selection actions. More...

bool	ShowMarkers (Selectability::Value &out_val) const
	Shows whether markers can be selected by selection actions. More...

bool	ShowVertices (Selectability::Value &out_val) const
	Shows whether vertices can be selected by selection actions. More...

bool	ShowText (Selectability::Value &out_val) const
	Shows whether text can be selected by selection actions. 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 SelectabilityKit	GetDefault ()
	Creates a SelectabilityKit 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::SelectabilityKit

Detailed Description

The HPS::SelectabilityKit class is a user space object, useful for carrying a group attribute settings.

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

Constructor & Destructor Documentation

◆ SelectabilityKit() [1/3]

HPS::SelectabilityKit::SelectabilityKit ( )

Initializes an empty kit.

◆ SelectabilityKit() [2/3]

HPS::SelectabilityKit::SelectabilityKit ( SelectabilityKit const & in_kit )

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

Parameters

in_kit The source object to copy.

◆ SelectabilityKit() [3/3]

HPS::SelectabilityKit::SelectabilityKit ( SelectabilityKit && in_that )

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

Parameters

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

◆ ~SelectabilityKit()

virtual HPS::SelectabilityKit::~SelectabilityKit ( )

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::SelectabilityKit::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::SelectabilityKit::Equals ( SelectabilityKit const & in_kit ) const

Check if the source SelectabilityKit is equivalent to this object.

Parameters

in_kit The source SelectabilityKit 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 SelectabilityKit HPS::SelectabilityKit::GetDefault ( )

static

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source SelectabilityKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this SelectabilityKit.

◆ operator=() [2/2]

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

Copies the source SelectabilityKit into this object.

Parameters

in_kit The source SelectabilityKit to copy.

Returns: A reference to this object.

◆ operator==()

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

Check if the source SelectabilityKit is equivalent to this object.

Parameters

in_kit The source SelectabilityKit 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::SelectabilityKit::Set ( SelectabilityKit const & in_kit )

Copies all settings from the source SelectabilityKit into this object.

Parameters

in_kit The source SelectabilityKit to copy.

◆ SetEdges() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetEdges ( Selectability::Value in_val )

Controls whether edges can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetEdges() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetEdges ( bool in_val )

Controls whether edges can be selected by selection actions.

Parameters

in_val Whether visible edges should be selectable.

Returns: A reference to this object.

◆ SetEverything() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetEverything ( Selectability::Value in_val )

Sets the selectability of all geometry, subgeometry and windows.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetEverything() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetEverything ( bool in_val )

Sets the selectability of all geometry, subgeometry and windows.

Parameters

in_val Whether everything visible should be selectable.

Returns: A reference to this object.

◆ SetFaces() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetFaces ( Selectability::Value in_val )

Controls whether faces can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetFaces() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetFaces ( bool in_val )

Controls whether faces can be selected by selection actions.

Parameters

in_val Whether visible faces should be selectable.

Returns: A reference to this object.

◆ SetGeometry() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetGeometry ( Selectability::Value in_val )

Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetGeometry() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetGeometry ( bool in_val )

Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text.

Parameters

in_val Whether visible geometry should be selectable.

Returns: A reference to this object.

◆ SetLights() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetLights ( Selectability::Value in_val )

Controls whether lights can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetLights() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetLights ( bool in_val )

Controls whether lights can be selected by selection actions.

Parameters

in_val Whether visible lights should be selectable.

Returns: A reference to this object.

◆ SetLines() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetLines ( Selectability::Value in_val )

Controls whether lines can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetLines() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetLines ( bool in_val )

Controls whether lines can be selected by selection actions.

Parameters

in_val Whether visible lines should be selectable.

Returns: A reference to this object.

◆ SetMarkers() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetMarkers ( Selectability::Value in_val )

Controls whether markers can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetMarkers() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetMarkers ( bool in_val )

Controls whether markers can be selected by selection actions.

Parameters

in_val Whether visible markers should be selectable.

Returns: A reference to this object.

◆ SetText() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetText ( Selectability::Value in_val )

Controls whether text can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetText() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetText ( bool in_val )

Controls whether text can be selected by selection actions.

Parameters

in_val Whether visible text should be selectable.

Returns: A reference to this object.

◆ SetVertices() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetVertices ( Selectability::Value in_val )

Controls whether vertices can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetVertices() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetVertices ( bool in_val )

Controls whether vertices can be selected by selection actions.

Parameters

in_val Whether visible vertices should be selectable.

Returns: A reference to this object.

◆ SetWindows() [1/2]

SelectabilityKit& HPS::SelectabilityKit::SetWindows ( Selectability::Value in_val )

Controls whether windows can be selected by selection actions.

Parameters

in_val The level of selectability.

Returns: A reference to this object.

◆ SetWindows() [2/2]

SelectabilityKit& HPS::SelectabilityKit::SetWindows ( bool in_val )

Controls whether windows can be selected by selection actions.

Parameters

in_val Whether visible windows should be selectable.

Returns: A reference to this object.

◆ Show()

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

Copies all settings from this SelectabilityKit into the given SelectabilityKit.

Parameters

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

◆ ShowEdges()

bool HPS::SelectabilityKit::ShowEdges ( Selectability::Value & out_val ) const

Shows whether edges can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowFaces()

bool HPS::SelectabilityKit::ShowFaces ( Selectability::Value & out_val ) const

Shows whether faces can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowLights()

bool HPS::SelectabilityKit::ShowLights ( Selectability::Value & out_val ) const

Shows whether lights can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowLines()

bool HPS::SelectabilityKit::ShowLines ( Selectability::Value & out_val ) const

Shows whether lines can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowMarkers()

bool HPS::SelectabilityKit::ShowMarkers ( Selectability::Value & out_val ) const

Shows whether markers can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowText()

bool HPS::SelectabilityKit::ShowText ( Selectability::Value & out_val ) const

Shows whether text can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowVertices()

bool HPS::SelectabilityKit::ShowVertices ( Selectability::Value & out_val ) const

Shows whether vertices can be selected by selection actions.

Parameters

out_val The level of selectability.

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

◆ ShowWindows()

bool HPS::SelectabilityKit::ShowWindows ( Selectability::Value & out_val ) const

Shows whether windows can be selected by selection actions.

Parameters

out_val The level of selectability.

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.

◆ UnsetEdges()

SelectabilityKit& HPS::SelectabilityKit::UnsetEdges ( )

Removes the selectability setting from edges.

Returns: A reference to this object.

◆ UnsetEverything()

SelectabilityKit& HPS::SelectabilityKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetFaces()

SelectabilityKit& HPS::SelectabilityKit::UnsetFaces ( )

Removes the selectability setting from faces.

Returns: A reference to this object.

◆ UnsetGeometry()

SelectabilityKit& HPS::SelectabilityKit::UnsetGeometry ( )

Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text.

Returns: A reference to this object.

◆ UnsetLights()

SelectabilityKit& HPS::SelectabilityKit::UnsetLights ( )

Removes the selectability setting from lights.

Returns: A reference to this object.

◆ UnsetLines()

SelectabilityKit& HPS::SelectabilityKit::UnsetLines ( )

Removes the selectability setting from lines.

Returns: A reference to this object.

◆ UnsetMarkers()

SelectabilityKit& HPS::SelectabilityKit::UnsetMarkers ( )

Removes the selectability setting from markers.

Returns: A reference to this object.

◆ UnsetText()

SelectabilityKit& HPS::SelectabilityKit::UnsetText ( )

Removes the selectability setting from text.

Returns: A reference to this object.

◆ UnsetVertices()

SelectabilityKit& HPS::SelectabilityKit::UnsetVertices ( )

Removes the selectability setting from vertices.

Returns: A reference to this object.

◆ UnsetWindows()

SelectabilityKit& HPS::SelectabilityKit::UnsetWindows ( )

Removes the selectability setting from windows.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::SelectabilityKit::staticType = HPS::Type::SelectabilityKit

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

◆ SelectabilityKit() [1/3]

◆ SelectabilityKit() [2/3]

◆ SelectabilityKit() [3/3]

◆ ~SelectabilityKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetEdges() [1/2]

◆ SetEdges() [2/2]

◆ SetEverything() [1/2]

◆ SetEverything() [2/2]

◆ SetFaces() [1/2]

◆ SetFaces() [2/2]

◆ SetGeometry() [1/2]

◆ SetGeometry() [2/2]

◆ SetLights() [1/2]

◆ SetLights() [2/2]

◆ SetLines() [1/2]

◆ SetLines() [2/2]

◆ SetMarkers() [1/2]

◆ SetMarkers() [2/2]

◆ SetText() [1/2]

◆ SetText() [2/2]

◆ SetVertices() [1/2]

◆ SetVertices() [2/2]

◆ SetWindows() [1/2]

◆ SetWindows() [2/2]

◆ Show()

◆ ShowEdges()

◆ ShowFaces()

◆ ShowLights()

◆ ShowLines()

◆ ShowMarkers()

◆ ShowText()

◆ ShowVertices()

◆ ShowWindows()

◆ Type()

◆ UnsetEdges()

◆ UnsetEverything()

◆ UnsetFaces()

◆ UnsetGeometry()

◆ UnsetLights()

◆ UnsetLines()

◆ UnsetMarkers()

◆ UnsetText()

◆ UnsetVertices()

◆ UnsetWindows()

Member Data Documentation

◆ staticType