Version: 6.3.1
Public Types | Public Member Functions | Static Public Member Functions

SVTK_Selector Class Reference

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

#include <SVTK_Selector.h>

Inheritance diagram for SVTK_Selector:
Inheritance graph

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)
virtual Selection_Mode SelectionMode () const =0
 Get current Selection_Mode.
virtual void ClearIObjects ()=0
 Clear selection.
virtual SALOME_ActorGetActor (const Handle(SALOME_InteractiveObject)&theIO) const =0
 Try to find corresponding SALOME_Actor for given reference on SALOME_InteractiveObject.
virtual bool IsSelected (const Handle(SALOME_InteractiveObject)&theIO) const =0
 Check, is the SALOME_InteractiveObject is present into selection.
virtual bool IsSelected (SALOME_Actor *theActor) const =0
 Check, is the SALOME_Actor is present into selection.
virtual bool AddIObject (const Handle(SALOME_InteractiveObject)&theIO)=0
 Modify the selection by adding new reference on SALOME_InteractiveObject.
virtual bool AddIObject (SALOME_Actor *theActor)=0
 Modify the selection by adding new reference on SALOME_Actor.
virtual bool RemoveIObject (const Handle(SALOME_InteractiveObject)&theIO)=0
 Modify the selection by removing a reference on SALOME_InteractiveObject.
virtual bool RemoveIObject (SALOME_Actor *theActor)=0
 Modify the selection by removing a reference on SALOME_Actor.
virtual const SALOME_ListIOStoredIObjects () const =0
 Get all SALOME_InteractiveObject references that is present into selection.
virtual int IObjectCount () const =0
 Get number of selected objects.
virtual bool HasIndex (const Handle(SALOME_InteractiveObject)&theIO) const =0
 Check, if the SALOME_InteractiveObject has a subselection.
virtual void GetIndex (const Handle(SALOME_InteractiveObject)&theIO, TColStd_IndexedMapOfInteger &theIndex)=0
 Get indexes of subslection for given SALOME_InteractiveObject.
virtual bool AddOrRemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, const TColStd_IndexedMapOfInteger &theIndices, bool theIsModeShift)=0
 Change indices of subselection for given SALOME_InteractiveObject.
virtual bool AddOrRemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, const TColStd_MapOfInteger &theIndices, bool theIsModeShift)=0
 Change indexes of subslection for given SALOME_InteractiveObject.
virtual bool AddOrRemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, int theIndex, bool theIsModeShift)=0
 Change index of subslection for given SALOME_InteractiveObject.
virtual void RemoveIndex (const Handle(SALOME_InteractiveObject)&theIO, int theIndex)=0
 Change index of subslection for given SALOME_InteractiveObject.
virtual bool IsIndexSelected (const Handle(SALOME_InteractiveObject)&theIO, int theIndex) const =0
 Check, if the given index is present in subselection.
virtual void ClearIndex ()=0
 Clear subselection.
virtual void SetFilter (const Handle(VTKViewer_Filter)&theFilter)=0
 To apply a filter on the selection.
virtual Handle (VTKViewer_Filter) GetFilter(const TFilterID theId) const =0
 To get a section filter by its number.
virtual bool IsFilterPresent (const TFilterID theId) const =0
 Check, if a filter with given number is applyed.
virtual void RemoveFilter (const TFilterID theId)=0
 To remove a filter from the selection.
virtual bool IsValid (SALOME_Actor *theActor, const int theId, const bool theIsNode=false) const =0
 Check, if the index satisfy to the installed filters.
virtual void StartPickCallback ()=0
virtual void EndPickCallback ()=0
 To invoke selectionChanged signals.
virtual vtkActorCollection * Pick (const SVTK_SelectionEvent *theEvent, vtkRenderer *theRenderer) const =0
virtual void SetTolerance (const double &theTolerance)=0

Static Public Member Functions

static SVTK_SelectorNew ()

Detailed Description

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


Member Function Documentation

SVTK_Selector * SVTK_Selector::New ( ) [static]
Returns:
new SVTK_Selector
SVTK_Selector.vtkTypeMacro ( SVTK_Selector  ,
vtkObject   
)
virtual void SVTK_Selector.SetSelectionMode ( Selection_Mode  theMode) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual Selection_Mode SVTK_Selector.SelectionMode ( ) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.ClearIObjects ( ) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual SALOME_Actor* SVTK_Selector.GetActor ( const Handle(SALOME_InteractiveObject)&  theIO) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.IsSelected ( const Handle(SALOME_InteractiveObject)&  theIO) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.IsSelected ( SALOME_Actor theActor) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.AddIObject ( const Handle(SALOME_InteractiveObject)&  theIO) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.AddIObject ( SALOME_Actor theActor) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.RemoveIObject ( const Handle(SALOME_InteractiveObject)&  theIO) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.RemoveIObject ( SALOME_Actor theActor) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual const SALOME_ListIO& SVTK_Selector.StoredIObjects ( ) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual int SVTK_Selector.IObjectCount ( ) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.HasIndex ( const Handle(SALOME_InteractiveObject)&  theIO) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.GetIndex ( const Handle(SALOME_InteractiveObject)&  theIO,
TColStd_IndexedMapOfInteger &  theIndex 
) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.AddOrRemoveIndex ( const Handle(SALOME_InteractiveObject)&  theIO,
const TColStd_IndexedMapOfInteger &  theIndices,
bool  theIsModeShift 
) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.AddOrRemoveIndex ( const Handle(SALOME_InteractiveObject)&  theIO,
const TColStd_MapOfInteger &  theIndices,
bool  theIsModeShift 
) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.AddOrRemoveIndex ( const Handle(SALOME_InteractiveObject)&  theIO,
int  theIndex,
bool  theIsModeShift 
) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.RemoveIndex ( const Handle(SALOME_InteractiveObject)&  theIO,
int  theIndex 
) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.IsIndexSelected ( const Handle(SALOME_InteractiveObject)&  theIO,
int  theIndex 
) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.ClearIndex ( ) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.SetFilter ( const Handle(VTKViewer_Filter)&  theFilter) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual SVTK_Selector.Handle ( VTKViewer_Filter  ) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.IsFilterPresent ( const TFilterID  theId) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.RemoveFilter ( const TFilterID  theId) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual bool SVTK_Selector.IsValid ( SALOME_Actor theActor,
const int  theId,
const bool  theIsNode = false 
) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.StartPickCallback ( ) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.EndPickCallback ( ) [pure virtual]

Implemented in SVTK_SelectorDef.

virtual vtkActorCollection* SVTK_Selector.Pick ( const SVTK_SelectionEvent theEvent,
vtkRenderer *  theRenderer 
) const [pure virtual]

Implemented in SVTK_SelectorDef.

virtual void SVTK_Selector.SetTolerance ( const double &  theTolerance) [pure virtual]

Implemented in SVTK_SelectorDef.

Copyright © 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS