< Home

< Table of Contents

REFERENCE MANUAL

SelectabilityControl Class Reference

#include <hps.h>

Inheritance diagram for SelectabilityControl:
Control Object

Public Member Functions

Type ObjectType () const
 
SelectabilityControloperator= (SelectabilityControl &&in_that)
 
SelectabilityControloperator= (SelectabilityControl const &in_that)
 
 SelectabilityControl (SegmentKey &in_seg)
 
 SelectabilityControl (SelectabilityControl const &in_that)
 
 SelectabilityControl (SelectabilityControl &&in_that)
 
SelectabilityControlSetEdges (Selectability::Value in_val)
 
SelectabilityControlSetEverything (Selectability::Value in_val)
 
SelectabilityControlSetFaces (Selectability::Value in_val)
 
SelectabilityControlSetGeometry (Selectability::Value in_val)
 
SelectabilityControlSetLights (Selectability::Value in_val)
 
SelectabilityControlSetLines (Selectability::Value in_val)
 
SelectabilityControlSetMarkers (Selectability::Value in_val)
 
SelectabilityControlSetText (Selectability::Value in_val)
 
SelectabilityControlSetVertices (Selectability::Value in_val)
 
SelectabilityControlSetWindows (Selectability::Value in_val)
 
bool ShowEdges (Selectability::Value &out_val) const
 
bool ShowFaces (Selectability::Value &out_val) const
 
bool ShowLights (Selectability::Value &out_val) const
 
bool ShowLines (Selectability::Value &out_val) const
 
bool ShowMarkers (Selectability::Value &out_val) const
 
bool ShowText (Selectability::Value &out_val) const
 
bool ShowVertices (Selectability::Value &out_val) const
 
bool ShowWindows (Selectability::Value &out_val) const
 
SelectabilityControlUnsetEdges ()
 
SelectabilityControlUnsetEverything ()
 
SelectabilityControlUnsetFaces ()
 
SelectabilityControlUnsetGeometry ()
 
SelectabilityControlUnsetLights ()
 
SelectabilityControlUnsetLines ()
 
SelectabilityControlUnsetMarkers ()
 
SelectabilityControlUnsetText ()
 
SelectabilityControlUnsetVertices ()
 
SelectabilityControlUnsetWindows ()
 
 ~SelectabilityControl ()
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

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::SelectabilityControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

SelectabilityControl::SelectabilityControl ( SelectabilityControl const &  in_that)

Initializes a control tied to the same object as in_that.

SelectabilityControl::SelectabilityControl ( SelectabilityControl &&  in_that)

The move constructor creates a SelectabilityControl by transferring the underlying impl of the rvalue reference to this SelectabilityControl thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a SelectabilityControl to take the impl from.
SelectabilityControl::~SelectabilityControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

Type SelectabilityControl::ObjectType ( ) const
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 Control.

SelectabilityControl& SelectabilityControl::operator= ( SelectabilityControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this SelectabilityControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a SelectabilityControl to take the impl from.
Returns
A reference to this SelectabilityControl.
SelectabilityControl& SelectabilityControl::operator= ( SelectabilityControl const &  in_that)

Share the smart-pointer.

SelectabilityControl& SelectabilityControl::SetEdges ( Selectability::Value  in_val)

Controls whether edges can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetEverything ( Selectability::Value  in_val)

Sets the selectability of all geometry, subgeometry and windows.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetFaces ( Selectability::Value  in_val)

Controls whether faces can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetGeometry ( Selectability::Value  in_val)

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.
SelectabilityControl& SelectabilityControl::SetLights ( Selectability::Value  in_val)

Controls whether lights can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetLines ( Selectability::Value  in_val)

Controls whether lines can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetMarkers ( Selectability::Value  in_val)

Controls whether markers can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetText ( Selectability::Value  in_val)

Controls whether text can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetVertices ( Selectability::Value  in_val)

Controls whether vertices can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::SetWindows ( Selectability::Value  in_val)

Controls whether windows can be selected by selection actions.

Parameters
in_valThe level of selectability.
Returns
A reference to this object.
bool SelectabilityControl::ShowEdges ( Selectability::Value out_val) const

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 SelectabilityControl::ShowFaces ( Selectability::Value out_val) const

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 SelectabilityControl::ShowLights ( Selectability::Value out_val) const

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 SelectabilityControl::ShowLines ( Selectability::Value out_val) const

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 SelectabilityControl::ShowMarkers ( Selectability::Value out_val) const

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 SelectabilityControl::ShowText ( Selectability::Value out_val) const

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 SelectabilityControl::ShowVertices ( Selectability::Value out_val) const

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 SelectabilityControl::ShowWindows ( Selectability::Value out_val) const

Shows whether windows can be selected by selection actions.

Parameters
out_valThe level of selectability.
Returns
true if the setting is valid, false otherwise.
SelectabilityControl& SelectabilityControl::UnsetEdges ( )

Removes the selectability setting from edges.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetFaces ( )

Removes the selectability setting from faces.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetGeometry ( )

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

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetLights ( )

Removes the selectability setting from lights.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetLines ( )

Removes the selectability setting from lines.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetMarkers ( )

Removes the selectability setting from markers.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetText ( )

Removes the selectability setting from text.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetVertices ( )

Removes the selectability setting from vertices.

Returns
A reference to this object.
SelectabilityControl& SelectabilityControl::UnsetWindows ( )

Removes the selectability setting from windows.

Returns
A reference to this object.

The documentation for this class was generated from the following file: