Inheritance diagram for HPS.SelectabilityKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SelectabilityKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 SelectabilityKit ()
 
 SelectabilityKit (HPS.SelectabilityKit in_kit)
 
void Set (HPS.SelectabilityKit in_kit)
 
HPS.SelectabilityKit SetEdges (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetEdges (bool in_val)
 
HPS.SelectabilityKit SetEverything (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetEverything (bool in_val)
 
HPS.SelectabilityKit SetFaces (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetFaces (bool in_val)
 
HPS.SelectabilityKit SetGeometry (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetGeometry (bool in_val)
 
HPS.SelectabilityKit SetLights (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetLights (bool in_val)
 
HPS.SelectabilityKit SetLines (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetLines (bool in_val)
 
HPS.SelectabilityKit SetMarkers (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetMarkers (bool in_val)
 
HPS.SelectabilityKit SetText (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetText (bool in_val)
 
HPS.SelectabilityKit SetVertices (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetVertices (bool in_val)
 
HPS.SelectabilityKit SetWindows (HPS.Selectability.Value in_val)
 
HPS.SelectabilityKit SetWindows (bool in_val)
 
void Show (out HPS.SelectabilityKit out_kit)
 
bool ShowEdges (out HPS.Selectability.Value out_val)
 
bool ShowFaces (out HPS.Selectability.Value out_val)
 
bool ShowLights (out HPS.Selectability.Value out_val)
 
bool ShowLines (out HPS.Selectability.Value out_val)
 
bool ShowMarkers (out HPS.Selectability.Value out_val)
 
bool ShowText (out HPS.Selectability.Value out_val)
 
bool ShowVertices (out HPS.Selectability.Value out_val)
 
bool ShowWindows (out HPS.Selectability.Value out_val)
 
HPS.SelectabilityKit UnsetEdges ()
 
HPS.SelectabilityKit UnsetEverything ()
 
HPS.SelectabilityKit UnsetFaces ()
 
HPS.SelectabilityKit UnsetGeometry ()
 
HPS.SelectabilityKit UnsetLights ()
 
HPS.SelectabilityKit UnsetLines ()
 
HPS.SelectabilityKit UnsetMarkers ()
 
HPS.SelectabilityKit UnsetText ()
 
HPS.SelectabilityKit UnsetVertices ()
 
HPS.SelectabilityKit UnsetWindows ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.SelectabilityKit GetDefault ()
 
static bool operator!= (HPS.SelectabilityKit a, HPS.SelectabilityKit b)
 
static bool operator== (HPS.SelectabilityKit a, HPS.SelectabilityKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SelectabilityKit() [1/2]

HPS.SelectabilityKit.SelectabilityKit ( )
inline

Initializes an empty kit.

◆ SelectabilityKit() [2/2]

HPS.SelectabilityKit.SelectabilityKit ( HPS.SelectabilityKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.SelectabilityKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.SelectabilityKit.Equals ( HPS.SelectabilityKit  in_kit)
inline

Check if the source SelectabilityKit is equivalent to this object.

Parameters
in_kitThe source SelectabilityKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.SelectabilityKit HPS.SelectabilityKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.SelectabilityKit.ObjectType ( )
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.Kit.

◆ Set()

void HPS.SelectabilityKit.Set ( HPS.SelectabilityKit  in_kit)
inline

Copies all settings from the source SelectabilityKit into this object.

Parameters
in_kitThe source SelectabilityKit to copy.

◆ SetEdges() [1/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetEdges ( HPS.Selectability.Value  in_val)
inline

Controls whether edges can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetEdges() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetEdges ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetEverything ( HPS.Selectability.Value  in_val)
inline

Sets the selectability of all geometry, subgeometry and windows.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetEverything() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetEverything ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetFaces ( HPS.Selectability.Value  in_val)
inline

Controls whether faces can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetFaces() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetFaces ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetGeometry ( HPS.Selectability.Value  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetGeometry ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetLights ( HPS.Selectability.Value  in_val)
inline

Controls whether lights can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetLights() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetLights ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetLines ( HPS.Selectability.Value  in_val)
inline

Controls whether lines can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetLines() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetLines ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetMarkers ( HPS.Selectability.Value  in_val)
inline

Controls whether markers can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetMarkers() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetMarkers ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetText ( HPS.Selectability.Value  in_val)
inline

Controls whether text can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetText() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetText ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetVertices ( HPS.Selectability.Value  in_val)
inline

Controls whether vertices can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetVertices() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetVertices ( bool  in_val)
inline

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]

HPS.SelectabilityKit HPS.SelectabilityKit.SetWindows ( HPS.Selectability.Value  in_val)
inline

Controls whether windows can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.

◆ SetWindows() [2/2]

HPS.SelectabilityKit HPS.SelectabilityKit.SetWindows ( bool  in_val)
inline

Controls whether windows can be selected by selection actions.

Parameters
in_valWhether visible windows should be selectable.
Returns
A reference to this object.

◆ Show()

void HPS.SelectabilityKit.Show ( out HPS.SelectabilityKit  out_kit)
inline

Copies all settings from this SelectabilityKit into the given SelectabilityKit.

Parameters
out_kitThe SelectabilityKit to populate with the contents of this object.

◆ ShowEdges()

bool HPS.SelectabilityKit.ShowEdges ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowFaces ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowLights ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowLines ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowMarkers ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowText ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowVertices ( out HPS.Selectability.Value  out_val)
inline

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.SelectabilityKit.ShowWindows ( out HPS.Selectability.Value  out_val)
inline

Shows whether windows can be selected by selection actions.

Parameters
out_valThe level of selectability.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEdges()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetEdges ( )
inline

Removes the selectability setting from edges.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetFaces()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetFaces ( )
inline

Removes the selectability setting from faces.

Returns
A reference to this object.

◆ UnsetGeometry()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetGeometry ( )
inline

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

Returns
A reference to this object.

◆ UnsetLights()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetLights ( )
inline

Removes the selectability setting from lights.

Returns
A reference to this object.

◆ UnsetLines()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetLines ( )
inline

Removes the selectability setting from lines.

Returns
A reference to this object.

◆ UnsetMarkers()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetMarkers ( )
inline

Removes the selectability setting from markers.

Returns
A reference to this object.

◆ UnsetText()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetText ( )
inline

Removes the selectability setting from text.

Returns
A reference to this object.

◆ UnsetVertices()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetVertices ( )
inline

Removes the selectability setting from vertices.

Returns
A reference to this object.

◆ UnsetWindows()

HPS.SelectabilityKit HPS.SelectabilityKit.UnsetWindows ( )
inline

Removes the selectability setting from windows.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.SelectabilityKit.cs