SelectabilityKit

class HPS::SelectabilityKit : public HPS::Kit 

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.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

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

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.

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

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.

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.

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

SelectabilityKit(): Initializes an empty kit.

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

void Set(SelectabilityKit const &in_kit)

Copies all settings from the source SelectabilityKit into this object.

Parameters: in_kit – The source SelectabilityKit to copy.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

SelectabilityKit &UnsetEdges()

Removes the selectability setting from edges.

Returns: A reference to this object.

SelectabilityKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

SelectabilityKit &UnsetFaces()

Removes the selectability setting from faces.

Returns: A reference to this object.

SelectabilityKit &UnsetGeometry()

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

Returns: A reference to this object.

SelectabilityKit &UnsetLights()

Removes the selectability setting from lights.

Returns: A reference to this object.

SelectabilityKit &UnsetLines()

Removes the selectability setting from lines.

Returns: A reference to this object.

SelectabilityKit &UnsetMarkers()

Removes the selectability setting from markers.

Returns: A reference to this object.

SelectabilityKit &UnsetText()

Removes the selectability setting from text.

Returns: A reference to this object.

SelectabilityKit &UnsetVertices()

Removes the selectability setting from vertices.

Returns: A reference to this object.

SelectabilityKit &UnsetWindows()

Removes the selectability setting from windows.

Returns: A reference to this object.

virtual ~SelectabilityKit(): Destroy this kit.

Public Static Functions

static SelectabilityKit GetDefault()

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.

Public Static Attributes

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