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

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.SelectabilityKit in_kit)

Check if the source SelectabilityKit is equivalent to this object.

Param in_kit: The source SelectabilityKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

SelectabilityKit (): Initializes an empty kit.

SelectabilityKit (HPS.SelectabilityKit in_kit)

The copy constructor creates a new SelectabilityKit object that contains the same settings as the source object.

Param in_kit: The source object to copy.

void Set (HPS.SelectabilityKit in_kit)

Copies all settings from the source SelectabilityKit into this object.

Param in_kit: The source SelectabilityKit to copy.

HPS.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.SelectabilityKit 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.

void Show (out HPS.SelectabilityKit out_kit)

Copies all settings from this SelectabilityKit into the given SelectabilityKit.

Param out_kit: The SelectabilityKit to populate with the contents of 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.SelectabilityKit UnsetEdges ()

Removes the selectability setting from edges.

Return: A reference to this object.

HPS.SelectabilityKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.SelectabilityKit UnsetFaces ()

Removes the selectability setting from faces.

Return: A reference to this object.

HPS.SelectabilityKit UnsetGeometry ()

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

Return: A reference to this object.

HPS.SelectabilityKit UnsetLights ()

Removes the selectability setting from lights.

Return: A reference to this object.

HPS.SelectabilityKit UnsetLines ()

Removes the selectability setting from lines.

Return: A reference to this object.

HPS.SelectabilityKit UnsetMarkers ()

Removes the selectability setting from markers.

Return: A reference to this object.

HPS.SelectabilityKit UnsetText ()

Removes the selectability setting from text.

Return: A reference to this object.

HPS.SelectabilityKit UnsetVertices ()

Removes the selectability setting from vertices.

Return: A reference to this object.

HPS.SelectabilityKit UnsetWindows ()

Removes the selectability setting from windows.

Return: A reference to this object.

Public Static Functions

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

Return: A SelectabilityKit with the default settings.

bool operator!= (HPS.SelectabilityKit a, HPS.SelectabilityKit b)

bool operator== (HPS.SelectabilityKit a, HPS.SelectabilityKit b)