SelectabilityControl

class HPS::SelectabilityControl : public HPS::Control 

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.

Public Functions

inline virtual HPS::Type ObjectType() const

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.

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_that – An rvalue reference to a SelectabilityControl to take the impl from.
Returns: A reference to this SelectabilityControl.

SelectabilityControl &operator=(SelectabilityControl const &in_that)

Share the underlying smart-pointer of the SelectabilityControl source.

Parameters: in_that – The SelectabilityControl source of the assignment.
Returns: A reference to this SelectabilityControl.

explicit SelectabilityControl(SegmentKey &in_seg): Initializes a control tied to the segment in_seg.

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_that – An rvalue reference to a SelectabilityControl to take the impl from.

SelectabilityControl(SelectabilityControl const &in_that): Initializes a control tied to the same object as in_that.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

~SelectabilityControl(): Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::SelectabilityControl