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

override void Dispose ()

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

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

SelectabilityControl (HPS.SelectabilityControl in_that): Initializes a control tied to the same object as in_that.

HPS.SelectabilityControl SetEdges (bool in_val)

Controls whether edges can be selected by selection actions.

Param in_val: Whether visible edges should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetEdges (HPS.Selectability.Value in_val)

Controls whether edges can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetEverything (bool in_val)

Sets the selectability of all geometry, subgeometry and windows.

Param in_val: Whether everything visible should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetEverything (HPS.Selectability.Value in_val)

Sets the selectability of all geometry, subgeometry and windows.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetFaces (bool in_val)

Controls whether faces can be selected by selection actions.

Param in_val: Whether visible faces should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetFaces (HPS.Selectability.Value in_val)

Controls whether faces can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetGeometry (bool in_val)

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

Param in_val: Whether visible geometry should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetGeometry (HPS.Selectability.Value in_val)

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

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetLights (bool in_val)

Controls whether lights can be selected by selection actions.

Param in_val: Whether visible lights should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetLights (HPS.Selectability.Value in_val)

Controls whether lights can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetLines (bool in_val)

Controls whether lines can be selected by selection actions.

Param in_val: Whether visible lines should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetLines (HPS.Selectability.Value in_val)

Controls whether lines can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetMarkers (bool in_val)

Controls whether markers can be selected by selection actions.

Param in_val: Whether visible markers should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetMarkers (HPS.Selectability.Value in_val)

Controls whether markers can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetText (bool in_val)

Controls whether text can be selected by selection actions.

Param in_val: Whether visible text should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetText (HPS.Selectability.Value in_val)

Controls whether text can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetVertices (bool in_val)

Controls whether vertices can be selected by selection actions.

Param in_val: Whether visible vertices should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetVertices (HPS.Selectability.Value in_val)

Controls whether vertices can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

HPS.SelectabilityControl SetWindows (bool in_val)

Controls whether windows can be selected by selection actions.

Param in_val: Whether visible windows should be selectable.
Return: A reference to this object.

HPS.SelectabilityControl SetWindows (HPS.Selectability.Value in_val)

Controls whether windows can be selected by selection actions.

Param in_val: The level of selectability.
Return: A reference to this object.

bool ShowEdges (out HPS.Selectability.Value out_val)

Shows whether edges can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowFaces (out HPS.Selectability.Value out_val)

Shows whether faces can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowLights (out HPS.Selectability.Value out_val)

Shows whether lights can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowLines (out HPS.Selectability.Value out_val)

Shows whether lines can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowMarkers (out HPS.Selectability.Value out_val)

Shows whether markers can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowText (out HPS.Selectability.Value out_val)

Shows whether text can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowVertices (out HPS.Selectability.Value out_val)

Shows whether vertices can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

bool ShowWindows (out HPS.Selectability.Value out_val)

Shows whether windows can be selected by selection actions.

Param out_val: The level of selectability.
Return: true if the setting is valid, false otherwise.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.

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

Return: A reference to this object.