Open CASCADE Technology  6.9.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. More...
 
void Init ()
 
Standard_Boolean More () const
 
void Next ()
 
const Handle
< Standard_Transient > & 
Value () const
 
Standard_Integer NbStored () const
 
const AIS_NListTransientObjects () const
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

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. More...
 
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. More...
 
static Handle< AIS_SelectionSelection (const Standard_CString aName)
 
static Standard_Boolean SetCurrentSelection (const Standard_CString aName)
 returns False if There is no selection of name <aName> More...
 
static Handle< AIS_SelectionCurrentSelection ()
 
static void ClearCurrentSelection ()
 Clears selection. More...
 
static void Select ()
 removes all the object of the currentselection. More...
 
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. More...
 
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. More...
 
static void ClearAndSelect (const Handle< Standard_Transient > &anObject)
 clears the selection and adds the object in the selection. More...
 
static Standard_Boolean IsSelected (const Handle< Standard_Transient > &anObject)
 
static Standard_Integer Extent ()
 returns the number of objects selected. More...
 
static Handle< Standard_TransientSingle ()
 returns the single object selected. Warning: raises TypeMismatch from Standard if Extent is not equal to 1. More...
 
static Standard_Integer Index (const Standard_CString aName)
 

Constructor & Destructor Documentation

AIS_Selection::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.

Member Function Documentation

static AIS_SelectStatus AIS_Selection::AddSelect ( const Handle< Standard_Transient > &  anObject)
static

the object is always add int the selection. faster when the number of objects selected is great.

static void AIS_Selection::ClearAndSelect ( const Handle< Standard_Transient > &  anObject)
static

clears the selection and adds the object in the selection.

static void AIS_Selection::ClearCurrentSelection ( )
static

Clears selection.

static Standard_Boolean AIS_Selection::CreateSelection ( const Standard_CString  aName)
static

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 > AIS_Selection::CurrentSelection ( )
static
static Standard_Integer AIS_Selection::Extent ( )
static

returns the number of objects selected.

static Standard_Boolean AIS_Selection::Find ( const Standard_CString  aName)
static

returns True if a selection having this name exsits.

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

removes all the object of the currentselection.

static AIS_SelectStatus AIS_Selection::Select ( const Handle< Standard_Transient > &  anObject)
static

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 Handle< AIS_Selection > AIS_Selection::Selection ( const Standard_CString  aName)
static
static Standard_Boolean AIS_Selection::SetCurrentSelection ( const Standard_CString  aName)
static

returns False if There is no selection of name <aName>

static Handle< Standard_Transient > AIS_Selection::Single ( )
static

returns the single object selected. Warning: raises TypeMismatch from Standard if Extent is not equal to 1.

const Handle< Standard_Transient >& AIS_Selection::Value ( ) const

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