Define an abstract interface for selection in SVTK package. More...

#include <SVTK_Selector.h>

Inheritance diagram for SVTK_Selector:

Public Types
typedef int	TFilterID

Public Member Functions
	vtkTypeMacro (SVTK_Selector, vtkObject) virtual void SetSelectionMode(Selection_Mode theMode)=0
	To change current Selection_Mode (as outside effect, it invokes selectionChange signal) More...

virtual Selection_Mode	SelectionMode () const =0
	Get current Selection_Mode. More...

virtual void	ClearIObjects ()=0
	Clear selection. More...

virtual SALOME_Actor *	GetActor (const Handle(SALOME_InteractiveObject)&theIO) const =0
	Try to find corresponding SALOME_Actor for given reference on SALOME_InteractiveObject. More...

virtual bool	IsSelected (const Handle(SALOME_InteractiveObject)&theIO) const =0
	Check, is the SALOME_InteractiveObject is present into selection. More...

virtual bool	IsSelected (SALOME_Actor *theActor) const =0
	Check, is the SALOME_Actor is present into selection. More...

virtual bool	AddIObject (const Handle(SALOME_InteractiveObject)&theIO)=0
	Modify the selection by adding new reference on SALOME_InteractiveObject. More...

virtual bool	AddIObject (SALOME_Actor *theActor)=0
	Modify the selection by adding new reference on SALOME_Actor. More...

virtual bool	RemoveIObject (const Handle(SALOME_InteractiveObject)&theIO)=0
	Modify the selection by removing a reference on SALOME_InteractiveObject. More...

virtual bool	RemoveIObject (SALOME_Actor *theActor)=0
	Modify the selection by removing a reference on SALOME_Actor. More...

virtual const SALOME_ListIO &	StoredIObjects () const =0
	Get all SALOME_InteractiveObject references that is present into selection. More...

virtual int	IObjectCount () const =0
	Get number of selected objects. More...

virtual bool	HasIndex (const Handle(SALOME_InteractiveObject)&theIO) const =0
	Check, if the SALOME_InteractiveObject has a subselection. More...

virtual void	GetIndex (const Handle(SALOME_InteractiveObject)&theIO, SVTK_TIndexedMapOfVtkId &theIndex)=0
	Get indexes of subslection for given SALOME_InteractiveObject. More...

virtual bool	AddOrRemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, const SVTK_TIndexedMapOfVtkId &theIndices, bool theIsModeShift)=0
	Change indices of subselection for given SALOME_InteractiveObject. More...

virtual bool	AddOrRemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, const SVTK_TVtkIDsMap &theIndices, bool theIsModeShift)=0
	Change indexes of subslection for given SALOME_InteractiveObject. More...

virtual bool	AddOrRemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, int theIndex, bool theIsModeShift)=0
	Change index of subslection for given SALOME_InteractiveObject. More...

virtual void	RemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, int theIndex)=0
	Change index of subslection for given SALOME_InteractiveObject. More...

virtual bool	IsIndexSelected (const Handle(SALOME_InteractiveObject)&theIO, int theIndex) const =0
	Check, if the given index is present in subselection. More...

virtual void	ClearIndex ()=0
	Clear subselection. More...

virtual bool	HasCompositeIndex (const Handle(SALOME_InteractiveObject)&theIO) const =0
	! Composite indexes More...

virtual void	GetCompositeIndex (const Handle(SALOME_InteractiveObject)&theIO, SVTK_IndexedMapOfVtkIds &theIds)=0
	Get composite indexes of subslection for given SALOME_InteractiveObject. More...

virtual bool	AddOrRemoveCompositeIndex (const Handle(SALOME_InteractiveObject)&theIO, const SVTK_IndexedMapOfVtkIds &theIds, bool theIsModeShift)=0
	Change composite indices of subselection for given SALOME_InteractiveObject. More...

virtual bool	AddOrRemoveCompositeIndex (const Handle(SALOME_InteractiveObject)&theIO, SVTK_ListOfVtk ids, bool theIsModeShift)=0
	Change composite index of subslection for given SALOME_InteractiveObject. More...

virtual void	RemoveCompositeIndex (const Handle(SALOME_InteractiveObject)&theIO, SVTK_ListOfVtk ids)=0
	Change composite index of subslection for given SALOME_InteractiveObject. More...

virtual bool	IsCompositeIndexSelected (const Handle(SALOME_InteractiveObject)&theIO, SVTK_ListOfVtk ids) const =0
	Check, if the given composite index is present in subselection. More...

virtual void	ClearCompositeIndex ()=0
	Clear composite indexes subselection. More...

virtual void	SetFilter (const Handle(VTKViewer_Filter)&theFilter)=0
	To apply a filter on the selection. More...

virtual	Handle (VTKViewer_Filter) GetFilter(const TFilterID theId) const =0
	To get a section filter by its number. More...

virtual bool	IsFilterPresent (const TFilterID theId) const =0
	Check, if a filter with given number is applyed. More...

virtual void	RemoveFilter (const TFilterID theId)=0
	To remove a filter from the selection. More...

virtual bool	IsValid (SALOME_Actor *theActor, const int theId, const bool theIsNode=false) const =0
	Check, if the index satisfy to the installed filters. More...

virtual void	StartPickCallback ()=0

virtual void	EndPickCallback ()=0
	To invoke selectionChanged signals. More...

virtual vtkActorCollection *	Pick (const SVTK_SelectionEvent theEvent, vtkRenderer theRenderer) const =0

virtual void	SetTolerance (const double &theTolerance)=0

virtual void	SetDynamicPreSelection (bool theIsDynPreselect)=0

virtual bool	GetDynamicPreSelection () const =0

virtual void	SetPreSelectionEnabled (bool theEnabled)=0

virtual bool	IsPreSelectionEnabled () const =0

virtual void	SetSelectionEnabled (bool theEnabled)=0

virtual bool	IsSelectionEnabled () const =0

Static Public Member Functions
static SVTK_Selector *	New ()

Detailed Description

Define an abstract interface for selection in SVTK package.

The class implements selection functionality through storing corresponding references to SALOME_InteractiveObject. For implementation of subselection modes it keeps a corresponding map of sub indexes.

Note: Also, for each SALOME_InteractiveObject it tries to keep corresponding refenrence to SALOME_Actor

Member Typedef Documentation

◆ TFilterID

typedef int SVTK_Selector::TFilterID

Member Function Documentation

◆ AddIObject() [1/2]

virtual bool SVTK_Selector::AddIObject ( const Handle(SALOME_InteractiveObject)& theIO )

pure virtual

Modify the selection by adding new reference on SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ AddIObject() [2/2]

virtual bool SVTK_Selector::AddIObject ( SALOME_Actor * theActor )

pure virtual

Modify the selection by adding new reference on SALOME_Actor.

Implemented in SVTK_SelectorDef.

◆ AddOrRemoveCompositeIndex() [1/2]

virtual bool SVTK_Selector::AddOrRemoveCompositeIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		const SVTK_IndexedMapOfVtkIds &	theIds,
		bool	theIsModeShift
	)

pure virtual

Change composite indices of subselection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ AddOrRemoveCompositeIndex() [2/2]

virtual bool SVTK_Selector::AddOrRemoveCompositeIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		SVTK_ListOfVtk	ids,
		bool	theIsModeShift
	)

pure virtual

Change composite index of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ AddOrRemoveIndex() [1/3]

virtual bool SVTK_Selector::AddOrRemoveIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		const SVTK_TIndexedMapOfVtkId &	theIndices,
		bool	theIsModeShift
	)

pure virtual

Change indices of subselection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ AddOrRemoveIndex() [2/3]

virtual bool SVTK_Selector::AddOrRemoveIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		const SVTK_TVtkIDsMap &	theIndices,
		bool	theIsModeShift
	)

pure virtual

Change indexes of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ AddOrRemoveIndex() [3/3]

virtual bool SVTK_Selector::AddOrRemoveIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		int	theIndex,
		bool	theIsModeShift
	)

pure virtual

Change index of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ ClearCompositeIndex()

virtual void SVTK_Selector::ClearCompositeIndex ( )

pure virtual

Clear composite indexes subselection.

Implemented in SVTK_SelectorDef.

◆ ClearIndex()

virtual void SVTK_Selector::ClearIndex ( )

pure virtual

Clear subselection.

Implemented in SVTK_SelectorDef.

◆ ClearIObjects()

virtual void SVTK_Selector::ClearIObjects ( )

pure virtual

Clear selection.

Implemented in SVTK_SelectorDef.

◆ EndPickCallback()

virtual void SVTK_Selector::EndPickCallback ( )

pure virtual

To invoke selectionChanged signals.

Implemented in SVTK_SelectorDef.

◆ GetActor()

virtual SALOME_Actor* SVTK_Selector::GetActor ( const Handle(SALOME_InteractiveObject)& theIO ) const

pure virtual

Try to find corresponding SALOME_Actor for given reference on SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ GetCompositeIndex()

virtual void SVTK_Selector::GetCompositeIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		SVTK_IndexedMapOfVtkIds &	theIds
	)

pure virtual

Get composite indexes of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ GetDynamicPreSelection()

virtual bool SVTK_Selector::GetDynamicPreSelection ( ) const

pure virtual

Implemented in SVTK_SelectorDef.

◆ GetIndex()

virtual void SVTK_Selector::GetIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		SVTK_TIndexedMapOfVtkId &	theIndex
	)

pure virtual

Get indexes of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ Handle()

virtual SVTK_Selector::Handle ( VTKViewer_Filter ) const

pure virtual

To get a section filter by its number.

Implemented in SVTK_SelectorDef.

◆ HasCompositeIndex()

virtual bool SVTK_Selector::HasCompositeIndex ( const Handle(SALOME_InteractiveObject)& theIO ) const

pure virtual

! Composite indexes

Implemented in SVTK_SelectorDef.

◆ HasIndex()

virtual bool SVTK_Selector::HasIndex ( const Handle(SALOME_InteractiveObject)& theIO ) const

pure virtual

Check, if the SALOME_InteractiveObject has a subselection.

Implemented in SVTK_SelectorDef.

◆ IObjectCount()

virtual int SVTK_Selector::IObjectCount ( ) const

pure virtual

Get number of selected objects.

Implemented in SVTK_SelectorDef.

◆ IsCompositeIndexSelected()

virtual bool SVTK_Selector::IsCompositeIndexSelected	(	const Handle(SALOME_InteractiveObject)&	theIO,
		SVTK_ListOfVtk	ids
	)		const

pure virtual

Check, if the given composite index is present in subselection.

Implemented in SVTK_SelectorDef.

◆ IsFilterPresent()

virtual bool SVTK_Selector::IsFilterPresent ( const TFilterID theId ) const

pure virtual

Check, if a filter with given number is applyed.

Implemented in SVTK_SelectorDef.

◆ IsIndexSelected()

virtual bool SVTK_Selector::IsIndexSelected	(	const Handle(SALOME_InteractiveObject)&	theIO,
		int	theIndex
	)		const

pure virtual

Check, if the given index is present in subselection.

Implemented in SVTK_SelectorDef.

◆ IsPreSelectionEnabled()

virtual bool SVTK_Selector::IsPreSelectionEnabled ( ) const

pure virtual

Implemented in SVTK_SelectorDef.

◆ IsSelected() [1/2]

virtual bool SVTK_Selector::IsSelected ( const Handle(SALOME_InteractiveObject)& theIO ) const

pure virtual

Check, is the SALOME_InteractiveObject is present into selection.

Implemented in SVTK_SelectorDef.

◆ IsSelected() [2/2]

virtual bool SVTK_Selector::IsSelected ( SALOME_Actor * theActor ) const

pure virtual

Check, is the SALOME_Actor is present into selection.

Implemented in SVTK_SelectorDef.

◆ IsSelectionEnabled()

virtual bool SVTK_Selector::IsSelectionEnabled ( ) const

pure virtual

Implemented in SVTK_SelectorDef.

◆ IsValid()

virtual bool SVTK_Selector::IsValid	(	SALOME_Actor *	theActor,
		const int	theId,
		const bool	theIsNode = `false`
	)		const

pure virtual

Check, if the index satisfy to the installed filters.

Implemented in SVTK_SelectorDef.

◆ New()

SVTK_Selector * SVTK_Selector::New ( )

static

Returns: new SVTK_Selector

◆ Pick()

virtual vtkActorCollection* SVTK_Selector::Pick	(	const SVTK_SelectionEvent *	theEvent,
		vtkRenderer *	theRenderer
	)		const

pure virtual

Implemented in SVTK_SelectorDef.

◆ RemoveCompositeIndex()

virtual void SVTK_Selector::RemoveCompositeIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		SVTK_ListOfVtk	ids
	)

pure virtual

Change composite index of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ RemoveFilter()

virtual void SVTK_Selector::RemoveFilter ( const TFilterID theId )

pure virtual

To remove a filter from the selection.

Implemented in SVTK_SelectorDef.

◆ RemoveIndex()

virtual void SVTK_Selector::RemoveIndex	(	const Handle(SALOME_InteractiveObject)&	theIO,
		int	theIndex
	)

pure virtual

Change index of subslection for given SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ RemoveIObject() [1/2]

virtual bool SVTK_Selector::RemoveIObject ( const Handle(SALOME_InteractiveObject)& theIO )

pure virtual

Modify the selection by removing a reference on SALOME_InteractiveObject.

Implemented in SVTK_SelectorDef.

◆ RemoveIObject() [2/2]

virtual bool SVTK_Selector::RemoveIObject ( SALOME_Actor * theActor )

pure virtual

Modify the selection by removing a reference on SALOME_Actor.

Implemented in SVTK_SelectorDef.

◆ SelectionMode()

virtual Selection_Mode SVTK_Selector::SelectionMode ( ) const

pure virtual

Get current Selection_Mode.

Implemented in SVTK_SelectorDef.

◆ SetDynamicPreSelection()

virtual void SVTK_Selector::SetDynamicPreSelection ( bool theIsDynPreselect )

pure virtual

Implemented in SVTK_SelectorDef.

◆ SetFilter()

virtual void SVTK_Selector::SetFilter ( const Handle(VTKViewer_Filter)& theFilter )

pure virtual

To apply a filter on the selection.

Implemented in SVTK_SelectorDef.

◆ SetPreSelectionEnabled()

virtual void SVTK_Selector::SetPreSelectionEnabled ( bool theEnabled )

pure virtual

Implemented in SVTK_SelectorDef.

◆ SetSelectionEnabled()

virtual void SVTK_Selector::SetSelectionEnabled ( bool theEnabled )

pure virtual

Implemented in SVTK_SelectorDef.

◆ SetTolerance()

virtual void SVTK_Selector::SetTolerance ( const double & theTolerance )

pure virtual

Implemented in SVTK_SelectorDef.

◆ StartPickCallback()

virtual void SVTK_Selector::StartPickCallback ( )

pure virtual

Implemented in SVTK_SelectorDef.

◆ StoredIObjects()

virtual const SALOME_ListIO& SVTK_Selector::StoredIObjects ( ) const

pure virtual

Get all SALOME_InteractiveObject references that is present into selection.

Implemented in SVTK_SelectorDef.

◆ vtkTypeMacro()

SVTK_Selector::vtkTypeMacro	(	SVTK_Selector	,
		vtkObject
	)

pure virtual

To change current Selection_Mode (as outside effect, it invokes selectionChange signal)

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

src/SVTK/SVTK_Selector.h
src/SVTK/SVTK_Selector.cxx

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ TFilterID

Member Function Documentation

◆ AddIObject() [1/2]

◆ AddIObject() [2/2]

◆ AddOrRemoveCompositeIndex() [1/2]

◆ AddOrRemoveCompositeIndex() [2/2]

◆ AddOrRemoveIndex() [1/3]

◆ AddOrRemoveIndex() [2/3]

◆ AddOrRemoveIndex() [3/3]

◆ ClearCompositeIndex()

◆ ClearIndex()

◆ ClearIObjects()

◆ EndPickCallback()

◆ GetActor()

◆ GetCompositeIndex()

◆ GetDynamicPreSelection()

◆ GetIndex()

◆ Handle()

◆ HasCompositeIndex()

◆ HasIndex()

◆ IObjectCount()

◆ IsCompositeIndexSelected()

◆ IsFilterPresent()

◆ IsIndexSelected()

◆ IsPreSelectionEnabled()

◆ IsSelected() [1/2]

◆ IsSelected() [2/2]

◆ IsSelectionEnabled()

◆ IsValid()

◆ New()

◆ Pick()

◆ RemoveCompositeIndex()

◆ RemoveFilter()

◆ RemoveIndex()

◆ RemoveIObject() [1/2]

◆ RemoveIObject() [2/2]

◆ SelectionMode()

◆ SetDynamicPreSelection()

◆ SetFilter()

◆ SetPreSelectionEnabled()

◆ SetSelectionEnabled()

◆ SetTolerance()

◆ StartPickCallback()

◆ StoredIObjects()

◆ vtkTypeMacro()