Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Member Functions | Protected Attributes

AIS_Selection Class Reference

Class holding the list of selected owners. More...

#include <AIS_Selection.hxx>

Inheritance diagram for AIS_Selection:
Inheritance graph
[legend]

Public Member Functions

 AIS_Selection ()
 creates a new selection. More...
 
virtual void Clear ()
 removes all the object of the selection. More...
 
virtual AIS_SelectStatus Select (const Handle< SelectMgr_EntityOwner > &theObject)
 if the object is not yet in the selection, it will be added. if the object is already in the selection, it will be removed. More...
 
virtual AIS_SelectStatus AddSelect (const Handle< SelectMgr_EntityOwner > &theObject)
 the object is always add int the selection. faster when the number of objects selected is great. More...
 
virtual void ClearAndSelect (const Handle< SelectMgr_EntityOwner > &theObject)
 clears the selection and adds the object in the selection. More...
 
Standard_Boolean IsSelected (const Handle< SelectMgr_EntityOwner > &theObject) const
 checks if the object is in the selection. More...
 
const AIS_NListOfEntityOwnerObjects () const
 Return the list of selected objects. More...
 
Standard_Integer Extent () const
 Return the number of selected objects. More...
 
Standard_Boolean IsEmpty () const
 Return true if list of selected objects is empty. More...
 
void Init ()
 Start iteration through selected objects. More...
 
Standard_Boolean More () const
 Return true if iterator points to selected object. More...
 
void Next ()
 Continue iteration through selected objects. More...
 
const Handle< SelectMgr_EntityOwner > & Value () const
 Return selected object at iterator position. More...
 
virtual void SelectOwners (const AIS_NArray1OfEntityOwner &thePickedOwners, const AIS_SelectionScheme theSelScheme, const Standard_Boolean theToAllowSelOverlap, const Handle< SelectMgr_Filter > &theFilter)
 Select or deselect owners depending on the selection scheme. 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 void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

virtual AIS_SelectStatus appendOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Handle< SelectMgr_Filter > &theFilter)
 Append the owner into the current selection if filter is Ok. More...
 

Protected Attributes

AIS_NListOfEntityOwner myresult
 
AIS_NListOfEntityOwner::Iterator myIterator
 
NCollection_DataMap< Handle< SelectMgr_EntityOwner >, AIS_NListOfEntityOwner::IteratormyResultMap
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Class holding the list of selected owners.

Constructor & Destructor Documentation

◆ AIS_Selection()

AIS_Selection::AIS_Selection ( )

creates a new selection.

Member Function Documentation

◆ AddSelect()

virtual AIS_SelectStatus AIS_Selection::AddSelect ( const Handle< SelectMgr_EntityOwner > &  theObject)
virtual

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

◆ appendOwner()

virtual AIS_SelectStatus AIS_Selection::appendOwner ( const Handle< SelectMgr_EntityOwner > &  theOwner,
const Handle< SelectMgr_Filter > &  theFilter 
)
protectedvirtual

Append the owner into the current selection if filter is Ok.

Parameters
theOwner[in] element to change selection state
theFilter[in] context filter to skip not acceptable owners
Returns
result of selection

◆ Clear()

virtual void AIS_Selection::Clear ( )
virtual

removes all the object of the selection.

◆ ClearAndSelect()

virtual void AIS_Selection::ClearAndSelect ( const Handle< SelectMgr_EntityOwner > &  theObject)
inlinevirtual

clears the selection and adds the object in the selection.

◆ Extent()

Standard_Integer AIS_Selection::Extent ( void  ) const
inline

Return the number of selected objects.

◆ Init()

void AIS_Selection::Init ( )
inline

Start iteration through selected objects.

◆ IsEmpty()

Standard_Boolean AIS_Selection::IsEmpty ( ) const
inline

Return true if list of selected objects is empty.

◆ IsSelected()

Standard_Boolean AIS_Selection::IsSelected ( const Handle< SelectMgr_EntityOwner > &  theObject) const
inline

checks if the object is in the selection.

◆ More()

Standard_Boolean AIS_Selection::More ( void  ) const
inline

Return true if iterator points to selected object.

◆ Next()

void AIS_Selection::Next ( void  )
inline

Continue iteration through selected objects.

◆ Objects()

const AIS_NListOfEntityOwner& AIS_Selection::Objects ( ) const
inline

Return the list of selected objects.

◆ Select()

virtual AIS_SelectStatus AIS_Selection::Select ( const Handle< SelectMgr_EntityOwner > &  theObject)
virtual

if the object is not yet in the selection, it will be added. if the object is already in the selection, it will be removed.

◆ SelectOwners()

virtual void AIS_Selection::SelectOwners ( const AIS_NArray1OfEntityOwner thePickedOwners,
const AIS_SelectionScheme  theSelScheme,
const Standard_Boolean  theToAllowSelOverlap,
const Handle< SelectMgr_Filter > &  theFilter 
)
virtual

Select or deselect owners depending on the selection scheme.

Parameters
[in]thePickedOwnerselements to change selection state
[in]theSelSchemeselection scheme, defines how owner is selected
[in]theToAllowSelOverlapselection flag, if true - overlapped entities are allowed
[in]theFiltercontext filter to skip not acceptable owners

◆ Value()

const Handle< SelectMgr_EntityOwner >& AIS_Selection::Value ( void  ) const
inline

Return selected object at iterator position.

Field Documentation

◆ myIterator

AIS_NListOfEntityOwner::Iterator AIS_Selection::myIterator
protected

◆ myresult

AIS_NListOfEntityOwner AIS_Selection::myresult
protected

◆ myResultMap


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