Open CASCADE Technology 6.6.0
Public Member Functions | Static Public Member Functions
AIS_Selection Class Reference

#include <AIS_Selection.hxx>

Inheritance diagram for AIS_Selection:
Inheritance graph
[legend]

Public Member Functions

 AIS_Selection (const Standard_CString aName)
 creates a new selection and make it current in the session.
the selection will be accessible later through its name
to make it again current.

Note that if a session has been created, a session with
the name "default" is created.

In this case, the is always a current selection which
is the last one created until SetCurrentSelection is used.

The class methods deals with the current selection.

Warning : Better Call AIS_Selection::CreateSelection.


void Init ()
Standard_Boolean More () const
void Next ()
const Handle_Standard_TransientValue () const
Standard_Integer NbStored () const
const AIS_NListTransient & Objects () const

Static Public Member Functions

static void Remove (const Standard_CString aName)
static Standard_Boolean Find (const Standard_CString aName)
 returns True if a selection having this name exsits.

static Standard_Boolean CreateSelection (const Standard_CString aName)
 calls the private constructor and puts the new Selection
in the list of existing selections.
returns False if the selection exists.

static Handle_AIS_Selection Selection (const Standard_CString aName)
static Standard_Boolean SetCurrentSelection (const Standard_CString aName)
 returns False if There is no selection of name <aName>

static Handle_AIS_Selection CurrentSelection ()
static void Select ()
 removes all the object of the currentselection.

static AIS_SelectStatus Select (const Handle< Standard_Transient > &anObject)
 if the object is not yet in the current selection, it will be added.
if the object is already in the current selection, it will be removed.

static AIS_SelectStatus AddSelect (const Handle< Standard_Transient > &anObject)
 the object is always add int the selection.
faster when the number of objects selected is great.

static void ClearAndSelect (const Handle< Standard_Transient > &anObject)
 clears the selection and adds the object in the selection.

static Standard_Boolean IsSelected (const Handle< Standard_Transient > &anObject)
static Standard_Integer Extent ()
 returns the number of objects selected.

static Handle_Standard_Transient Single ()
 returns the single object selected.
Warning: raises TypeMismatch from Standard if Extent is not equal to 1.

static Standard_Integer Index (const Standard_CString aName)

Constructor & Destructor Documentation

AIS_Selection::AIS_Selection ( const Standard_CString  aName)

Member Function Documentation

static AIS_SelectStatus AIS_Selection::AddSelect ( const Handle< Standard_Transient > &  anObject) [static]
static void AIS_Selection::ClearAndSelect ( const Handle< Standard_Transient > &  anObject) [static]
static Standard_Boolean AIS_Selection::CreateSelection ( const Standard_CString  aName) [static]
static Handle_AIS_Selection AIS_Selection::CurrentSelection ( ) [static]
static Standard_Integer AIS_Selection::Extent ( ) [static]
static Standard_Boolean AIS_Selection::Find ( const Standard_CString  aName) [static]
static Standard_Integer AIS_Selection::Index ( const Standard_CString  aName) [static]
void AIS_Selection::Init ( )
static Standard_Boolean AIS_Selection::IsSelected ( const Handle< Standard_Transient > &  anObject) [static]
Standard_Boolean AIS_Selection::More ( ) const
Standard_Integer AIS_Selection::NbStored ( ) const
void AIS_Selection::Next ( )
const AIS_NListTransient& AIS_Selection::Objects ( ) const
static void AIS_Selection::Remove ( const Standard_CString  aName) [static]
static void AIS_Selection::Select ( ) [static]
static AIS_SelectStatus AIS_Selection::Select ( const Handle< Standard_Transient > &  anObject) [static]
static Handle_AIS_Selection AIS_Selection::Selection ( const Standard_CString  aName) [static]
static Standard_Boolean AIS_Selection::SetCurrentSelection ( const Standard_CString  aName) [static]
static Handle_Standard_Transient AIS_Selection::Single ( ) [static]
const Handle_Standard_Transient& AIS_Selection::Value ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines