Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.SelectabilityKit Class Reference

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

Inheritance diagram for HPS.SelectabilityKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 SelectabilityKit ()
 Initializes an empty kit. More...
 
 SelectabilityKit (HPS.SelectabilityKit in_kit)
 The copy constructor creates a new SelectabilityKit object that contains the same settings as the source object. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.SelectabilityKit in_kit)
 Copies all settings from the source SelectabilityKit into this object. More...
 
void Show (out HPS.SelectabilityKit out_kit)
 Copies all settings from this SelectabilityKit into the given SelectabilityKit. More...
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.SelectabilityKit in_kit)
 Check if the source SelectabilityKit is equivalent to this object. More...
 
HPS.SelectabilityKit SetWindows (HPS.Selectability.Value in_val)
 Controls whether windows can be selected by selection actions. More...
 
HPS.SelectabilityKit SetEdges (HPS.Selectability.Value in_val)
 Controls whether edges can be selected by selection actions. More...
 
HPS.SelectabilityKit SetFaces (HPS.Selectability.Value in_val)
 Controls whether faces can be selected by selection actions. More...
 
HPS.SelectabilityKit SetLights (HPS.Selectability.Value in_val)
 Controls whether lights can be selected by selection actions. More...
 
HPS.SelectabilityKit SetLines (HPS.Selectability.Value in_val)
 Controls whether lines can be selected by selection actions. More...
 
HPS.SelectabilityKit SetMarkers (HPS.Selectability.Value in_val)
 Controls whether markers can be selected by selection actions. More...
 
HPS.SelectabilityKit SetVertices (HPS.Selectability.Value in_val)
 Controls whether vertices can be selected by selection actions. More...
 
HPS.SelectabilityKit SetText (HPS.Selectability.Value in_val)
 Controls whether text can be selected by selection actions. More...
 
HPS.SelectabilityKit SetGeometry (HPS.Selectability.Value in_val)
 Sets the selectability of all edges, faces, lights, lines, markers, vertices, and text. More...
 
HPS.SelectabilityKit SetEverything (HPS.Selectability.Value in_val)
 Sets the selectability of all geometry, subgeometry and windows. More...
 
HPS.SelectabilityKit UnsetWindows ()
 Removes the selectability setting from windows. More...
 
HPS.SelectabilityKit UnsetEdges ()
 Removes the selectability setting from edges. More...
 
HPS.SelectabilityKit UnsetFaces ()
 Removes the selectability setting from faces. More...
 
HPS.SelectabilityKit UnsetLights ()
 Removes the selectability setting from lights. More...
 
HPS.SelectabilityKit UnsetLines ()
 Removes the selectability setting from lines. More...
 
HPS.SelectabilityKit UnsetMarkers ()
 Removes the selectability setting from markers. More...
 
HPS.SelectabilityKit UnsetVertices ()
 Removes the selectability setting from vertices. More...
 
HPS.SelectabilityKit UnsetText ()
 Removes the selectability setting from text. More...
 
HPS.SelectabilityKit UnsetGeometry ()
 Removes the selectability settings from edges, faces, lights, lines, markers, vertices, and text. More...
 
HPS.SelectabilityKit UnsetEverything ()
 Removes all settings from this object. More...
 
bool ShowWindows (out HPS.Selectability.Value out_val)
 Shows whether windows can be selected by selection actions. More...
 
bool ShowEdges (out HPS.Selectability.Value out_val)
 Shows whether edges can be selected by selection actions. More...
 
bool ShowFaces (out HPS.Selectability.Value out_val)
 Shows whether faces can be selected by selection actions. More...
 
bool ShowLights (out HPS.Selectability.Value out_val)
 Shows whether lights can be selected by selection actions. More...
 
bool ShowLines (out HPS.Selectability.Value out_val)
 Shows whether lines can be selected by selection actions. More...
 
bool ShowMarkers (out HPS.Selectability.Value out_val)
 Shows whether markers can be selected by selection actions. More...
 
bool ShowVertices (out HPS.Selectability.Value out_val)
 Shows whether vertices can be selected by selection actions. More...
 
bool ShowText (out HPS.Selectability.Value out_val)
 Shows whether text can be selected by selection actions. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 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. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static 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. More...
 
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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.SelectabilityKit.SelectabilityKit ( )
inline

Initializes an empty kit.

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

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.

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

Check if the source SelectabilityKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_selectability_kit" kindref="compound">SelectabilityKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
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.
override HPS.Type HPS.SelectabilityKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

Copies all settings from the source SelectabilityKit into this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_selectability_kit" kindref="compound">SelectabilityKit</ref> to copy.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
void HPS.SelectabilityKit.Show ( out HPS.SelectabilityKit  out_kit)
inline

Copies all settings from this SelectabilityKit into the given SelectabilityKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_selectability_kit" kindref="compound">SelectabilityKit</ref> to populate with the contents of this object.
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.
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.
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.
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.
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.
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.
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.
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.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetEdges ( )
inline

Removes the selectability setting from edges.

Returns
A reference to this object.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetFaces ( )
inline

Removes the selectability setting from faces.

Returns
A reference to this object.
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.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetLights ( )
inline

Removes the selectability setting from lights.

Returns
A reference to this object.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetLines ( )
inline

Removes the selectability setting from lines.

Returns
A reference to this object.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetMarkers ( )
inline

Removes the selectability setting from markers.

Returns
A reference to this object.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetText ( )
inline

Removes the selectability setting from text.

Returns
A reference to this object.
HPS.SelectabilityKit HPS.SelectabilityKit.UnsetVertices ( )
inline

Removes the selectability setting from vertices.

Returns
A reference to this object.
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: