HPS::SelectabilityControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::SelectabilityControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
SelectabilityControloperator= (SelectabilityControl &&in_that)
 
SelectabilityControloperator= (SelectabilityControl const &in_that)
 
 SelectabilityControl (SegmentKey &in_seg)
 
 SelectabilityControl (SelectabilityControl const &in_that)
 
 SelectabilityControl (SelectabilityControl &&in_that)
 
SelectabilityControlSetEdges (Selectability::Value in_val)
 
SelectabilityControlSetEdges (bool in_val)
 
SelectabilityControlSetEverything (Selectability::Value in_val)
 
SelectabilityControlSetEverything (bool in_val)
 
SelectabilityControlSetFaces (Selectability::Value in_val)
 
SelectabilityControlSetFaces (bool in_val)
 
SelectabilityControlSetGeometry (Selectability::Value in_val)
 
SelectabilityControlSetGeometry (bool in_val)
 
SelectabilityControlSetLights (Selectability::Value in_val)
 
SelectabilityControlSetLights (bool in_val)
 
SelectabilityControlSetLines (Selectability::Value in_val)
 
SelectabilityControlSetLines (bool in_val)
 
SelectabilityControlSetMarkers (Selectability::Value in_val)
 
SelectabilityControlSetMarkers (bool in_val)
 
SelectabilityControlSetText (Selectability::Value in_val)
 
SelectabilityControlSetText (bool in_val)
 
SelectabilityControlSetVertices (Selectability::Value in_val)
 
SelectabilityControlSetVertices (bool in_val)
 
SelectabilityControlSetWindows (Selectability::Value in_val)
 
SelectabilityControlSetWindows (bool in_val)
 
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
 
virtual HPS::Type Type () const
 
SelectabilityControlUnsetEdges ()
 
SelectabilityControlUnsetEverything ()
 
SelectabilityControlUnsetFaces ()
 
SelectabilityControlUnsetGeometry ()
 
SelectabilityControlUnsetLights ()
 
SelectabilityControlUnsetLines ()
 
SelectabilityControlUnsetMarkers ()
 
SelectabilityControlUnsetText ()
 
SelectabilityControlUnsetVertices ()
 
SelectabilityControlUnsetWindows ()
 
 ~SelectabilityControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 Attributes

static const HPS::Type staticType = HPS::Type::SelectabilityControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The SelectabilityControl class is a smart pointer that is tied to a database object. This object allows you to set and unset the selectability of the various types of geometry, such as faces, lines, markers, and vertices.

Default values for the various fields of SelectabilityControl can be found here.

Constructor & Destructor Documentation

◆ SelectabilityControl() [1/3]

HPS::SelectabilityControl::SelectabilityControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ SelectabilityControl() [2/3]

HPS::SelectabilityControl::SelectabilityControl ( SelectabilityControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ SelectabilityControl() [3/3]

HPS::SelectabilityControl::SelectabilityControl ( SelectabilityControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a SelectabilityControl to take the impl from.

◆ ~SelectabilityControl()

HPS::SelectabilityControl::~SelectabilityControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::SelectabilityControl::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::Control.

◆ operator=() [1/2]

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

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

Parameters
in_thatAn rvalue reference to a SelectabilityControl to take the impl from.
Returns
A reference to this SelectabilityControl.

◆ operator=() [2/2]

SelectabilityControl& HPS::SelectabilityControl::operator= ( SelectabilityControl const &  in_that)

Share the underlying smart-pointer of the SelectabilityControl source.

Parameters
in_thatThe SelectabilityControl source of the assignment.
Returns
A reference to this SelectabilityControl.

◆ SetEdges() [1/2]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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]

SelectabilityControl& HPS::SelectabilityControl::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.

◆ ShowEdges()

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

◆ Type()

virtual HPS::Type HPS::SelectabilityControl::Type ( ) const
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetEdges()

SelectabilityControl& HPS::SelectabilityControl::UnsetEdges ( )

Removes the selectability setting from edges. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

SelectabilityControl& HPS::SelectabilityControl::UnsetEverything ( )

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetFaces()

SelectabilityControl& HPS::SelectabilityControl::UnsetFaces ( )

Removes the selectability setting from faces. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetGeometry()

SelectabilityControl& HPS::SelectabilityControl::UnsetGeometry ( )

Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text. If the control is attached to a WindowKey this function restores the default value of these settings as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetLights()

SelectabilityControl& HPS::SelectabilityControl::UnsetLights ( )

Removes the selectability setting from lights. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetLines()

SelectabilityControl& HPS::SelectabilityControl::UnsetLines ( )

Removes the selectability setting from lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetMarkers()

SelectabilityControl& HPS::SelectabilityControl::UnsetMarkers ( )

Removes the selectability setting from markers. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetText()

SelectabilityControl& HPS::SelectabilityControl::UnsetText ( )

Removes the selectability setting from text. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetVertices()

SelectabilityControl& HPS::SelectabilityControl::UnsetVertices ( )

Removes the selectability setting from vertices. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

◆ UnsetWindows()

SelectabilityControl& HPS::SelectabilityControl::UnsetWindows ( )

Removes the selectability setting from windows. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SelectabilityKit::GetDefault().

Returns
A reference to this object.

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