#include <hps.h>

Inheritance diagram for HPS::SelectabilityKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (SelectabilityKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (SelectabilityKit const &in_kit) const
 
SelectabilityKitoperator= (SelectabilityKit &&in_that)
 
SelectabilityKitoperator= (SelectabilityKit const &in_kit)
 
bool operator== (SelectabilityKit const &in_kit) const
 
 SelectabilityKit ()
 
 SelectabilityKit (SelectabilityKit const &in_kit)
 
 SelectabilityKit (SelectabilityKit &&in_that)
 
void Set (SelectabilityKit const &in_kit)
 
SelectabilityKitSetEdges (Selectability::Value in_val)
 
SelectabilityKitSetEdges (bool in_val)
 
SelectabilityKitSetEverything (Selectability::Value in_val)
 
SelectabilityKitSetEverything (bool in_val)
 
SelectabilityKitSetFaces (Selectability::Value in_val)
 
SelectabilityKitSetFaces (bool in_val)
 
SelectabilityKitSetGeometry (Selectability::Value in_val)
 
SelectabilityKitSetGeometry (bool in_val)
 
SelectabilityKitSetLights (Selectability::Value in_val)
 
SelectabilityKitSetLights (bool in_val)
 
SelectabilityKitSetLines (Selectability::Value in_val)
 
SelectabilityKitSetLines (bool in_val)
 
SelectabilityKitSetMarkers (Selectability::Value in_val)
 
SelectabilityKitSetMarkers (bool in_val)
 
SelectabilityKitSetText (Selectability::Value in_val)
 
SelectabilityKitSetText (bool in_val)
 
SelectabilityKitSetVertices (Selectability::Value in_val)
 
SelectabilityKitSetVertices (bool in_val)
 
SelectabilityKitSetWindows (Selectability::Value in_val)
 
SelectabilityKitSetWindows (bool in_val)
 
void Show (SelectabilityKit &out_kit) const
 
bool ShowEdges (Selectability::Value &out_val) const
 
bool ShowFaces (Selectability::Value &out_val) const
 
bool ShowLights (Selectability::Value &out_val) const
 
bool ShowLines (Selectability::Value &out_val) const
 
bool ShowMarkers (Selectability::Value &out_val) const
 
bool ShowText (Selectability::Value &out_val) const
 
bool ShowVertices (Selectability::Value &out_val) const
 
bool ShowWindows (Selectability::Value &out_val) const
 
SelectabilityKitUnsetEdges ()
 
SelectabilityKitUnsetEverything ()
 
SelectabilityKitUnsetFaces ()
 
SelectabilityKitUnsetGeometry ()
 
SelectabilityKitUnsetLights ()
 
SelectabilityKitUnsetLines ()
 
SelectabilityKitUnsetMarkers ()
 
SelectabilityKitUnsetText ()
 
SelectabilityKitUnsetVertices ()
 
SelectabilityKitUnsetWindows ()
 
virtual ~SelectabilityKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static SelectabilityKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SelectabilityKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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_kitThe 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_thatAn rvalue reference to a SelectabilityKit to take the impl from.

◆ ~SelectabilityKit()

virtual HPS::SelectabilityKit::~SelectabilityKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ 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_kitThe source SelectabilityKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

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

◆ ObjectType()

HPS::Type HPS::SelectabilityKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::Kit.

◆ operator!=()

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

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

Parameters
in_kitThe 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_thatAn 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_kitThe 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_kitThe source SelectabilityKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies all settings from the source SelectabilityKit into this object.

Parameters
in_kitThe 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_valThe 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_valWhether 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_kitThe 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_valThe 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_valThe 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_valThe 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_valThe 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_valThe 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_valThe 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_valThe 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_valThe level of selectability.
Returns
true if the setting is valid, false otherwise.

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

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