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

#include <AIS_Selection.hxx>

Inheritance diagram for AIS_Selection:

Public Member Functions
	AIS_Selection ()
	creates a new selection.

virtual void	Clear ()
	removes all the object of the selection.

virtual AIS_SelectStatus	Select (const Handle< SelectMgr_EntityOwner > &theOwner, const Handle< SelectMgr_Filter > &theFilter, const AIS_SelectionScheme theSelScheme, const Standard_Boolean theIsDetected)
	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.

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.

virtual void	ClearAndSelect (const Handle< SelectMgr_EntityOwner > &theObject, const Handle< SelectMgr_Filter > &theFilter, const Standard_Boolean theIsDetected)
	clears the selection and adds the object in the selection.

Standard_Boolean	IsSelected (const Handle< SelectMgr_EntityOwner > &theObject) const
	checks if the object is in the selection.

const AIS_NListOfEntityOwner &	Objects () const
	Return the list of selected objects.

Standard_Integer	Extent () const
	Return the number of selected objects.

Standard_Boolean	IsEmpty () const
	Return true if list of selected objects is empty.

void	Init ()
	Start iteration through selected objects.

Standard_Boolean	More () const
	Return true if iterator points to selected object.

void	Next ()
	Continue iteration through selected objects.

const Handle< SelectMgr_EntityOwner > &	Value () const
	Return selected object at iterator position.

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.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

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.

Protected Attributes
AIS_NListOfEntityOwner	myresult

AIS_NListOfEntityOwner::Iterator	myIterator

NCollection_DataMap< Handle< SelectMgr_EntityOwner >, AIS_NListOfEntityOwner::Iterator >	myResultMap

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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,
		const Handle< SelectMgr_Filter > &	theFilter,
		const Standard_Boolean	theIsDetected )

inlinevirtual

clears the selection and adds the object in the selection.

Parameters

[in]	theObject	element to change selection state
[in]	theFilter	context filter
[in]	theIsDetected	flag of object detection

◆ Extent()

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

inline

Return true if iterator points to selected object.

◆ Next()

void AIS_Selection::Next ( )

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 > &	theOwner,
		const Handle< SelectMgr_Filter > &	theFilter,
		const AIS_SelectionScheme	theSelScheme,
		const Standard_Boolean	theIsDetected )

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.

Parameters

[in]	theOwner	element to change selection state
[in]	theFilter	context filter
[in]	theSelScheme	selection scheme
[in]	theIsDetected	flag of object detection

Returns: result of selection

◆ 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]	thePickedOwners	elements to change selection state
[in]	theSelScheme	selection scheme, defines how owner is selected
[in]	theToAllowSelOverlap	selection flag, if true - overlapped entities are allowed
[in]	theFilter	context filter to skip not acceptable owners

◆ Value()

const Handle< SelectMgr_EntityOwner > & AIS_Selection::Value ( ) 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

NCollection_DataMap< Handle< SelectMgr_EntityOwner > , AIS_NListOfEntityOwner::Iterator> AIS_Selection::myResultMap

protected

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

AIS_Selection.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AIS_Selection()

Member Function Documentation

◆ AddSelect()

◆ appendOwner()

◆ Clear()

◆ ClearAndSelect()

◆ Extent()

◆ Init()

◆ IsEmpty()

◆ IsSelected()

◆ More()

◆ Next()

◆ Objects()

◆ Select()

◆ SelectOwners()

◆ Value()

Field Documentation

◆ myIterator

◆ myresult

◆ myResultMap