HPS.SelectabilityControl Class Reference
Inheritance diagram for HPS.SelectabilityControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
 SelectabilityControl (HPS.SegmentKey in_seg)
 
 SelectabilityControl (HPS.SelectabilityControl in_that)
 
HPS.SelectabilityControl SetEdges (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetEdges (bool in_val)
 
HPS.SelectabilityControl SetEverything (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetEverything (bool in_val)
 
HPS.SelectabilityControl SetFaces (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetFaces (bool in_val)
 
HPS.SelectabilityControl SetGeometry (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetGeometry (bool in_val)
 
HPS.SelectabilityControl SetLights (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetLights (bool in_val)
 
HPS.SelectabilityControl SetLines (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetLines (bool in_val)
 
HPS.SelectabilityControl SetMarkers (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetMarkers (bool in_val)
 
HPS.SelectabilityControl SetText (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetText (bool in_val)
 
HPS.SelectabilityControl SetVertices (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetVertices (bool in_val)
 
HPS.SelectabilityControl SetWindows (HPS.Selectability.Value in_val)
 
HPS.SelectabilityControl SetWindows (bool in_val)
 
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)
 
override HPS.Type Type ()
 
HPS.SelectabilityControl UnsetEdges ()
 
HPS.SelectabilityControl UnsetEverything ()
 
HPS.SelectabilityControl UnsetFaces ()
 
HPS.SelectabilityControl UnsetGeometry ()
 
HPS.SelectabilityControl UnsetLights ()
 
HPS.SelectabilityControl UnsetLines ()
 
HPS.SelectabilityControl UnsetMarkers ()
 
HPS.SelectabilityControl UnsetText ()
 
HPS.SelectabilityControl UnsetVertices ()
 
HPS.SelectabilityControl UnsetWindows ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SelectabilityControl() [1/2]

HPS.SelectabilityControl.SelectabilityControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ SelectabilityControl() [2/2]

HPS.SelectabilityControl.SelectabilityControl ( HPS.SelectabilityControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.SelectabilityControl.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.Control.

◆ SetEdges() [1/2]

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

◆ ShowEdges()

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

◆ Type()

override HPS.Type HPS.SelectabilityControl.Type ( )
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetEdges()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetEdges ( )
inline

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.

◆ UnsetEverything()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetEverything ( )
inline

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.

◆ UnsetFaces()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetFaces ( )
inline

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.

◆ UnsetGeometry()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetGeometry ( )
inline

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.

◆ UnsetLights()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetLights ( )
inline

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.

◆ UnsetLines()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetLines ( )
inline

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.

◆ UnsetMarkers()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetMarkers ( )
inline

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.

◆ UnsetText()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetText ( )
inline

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.

◆ UnsetVertices()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetVertices ( )
inline

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.

◆ UnsetWindows()

HPS.SelectabilityControl HPS.SelectabilityControl.UnsetWindows ( )
inline

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.

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