SVTK_Selector.h

Go to the documentation of this file.

// Copyright (C) 2007-2025  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
//  SALOME SALOMEGUI : implementation of desktop and GUI kernel
//  File   : SALOME_Selection.h
//  Author : Nicolas REJNERI
 
#ifndef SVTK_SELECTOR_H
#define SVTK_SELECTOR_H
 
#include "SVTK.h"
#include "SVTK_Selection.h"
#include "SVTK_Hash.h"
 
#include "SALOME_ListIO.hxx"
 
#include <VTKViewer_Filter.h>
 
#include <TColStd_MapOfInteger.hxx>
#include <TColStd_IndexedMapOfInteger.hxx>
 
#include <vtkObject.h>
 
class SALOME_InteractiveObject;
class SALOME_Actor;
class SVTK_SelectionEvent;
class vtkActorCollection;
class vtkRenderer;
 
 
class SVTK_EXPORT SVTK_Selector: public vtkObject
{
public:
  static SVTK_Selector* New();
  
  vtkTypeMacro(SVTK_Selector,vtkObject)
 
  
  virtual
  void 
  SetSelectionMode(Selection_Mode theMode) = 0;
 
  virtual
  Selection_Mode
  SelectionMode() const = 0;
 
  virtual
  void
  ClearIObjects() = 0;
 
  virtual
  SALOME_Actor* 
  GetActor(const Handle(SALOME_InteractiveObject)& theIO) const = 0;
 
  virtual
  bool
  IsSelected(const Handle(SALOME_InteractiveObject)& theIO) const = 0;
 
  virtual
  bool
  IsSelected(SALOME_Actor* theActor) const = 0;
 
  virtual
  bool
  AddIObject(const Handle(SALOME_InteractiveObject)& theIO) = 0;
 
  virtual
  bool
  AddIObject(SALOME_Actor* theActor) = 0;
 
  virtual
  bool 
  RemoveIObject(const Handle(SALOME_InteractiveObject)& theIO) = 0;
 
  virtual
  bool 
  RemoveIObject(SALOME_Actor* theActor) = 0;
 
  virtual
  const SALOME_ListIO& 
  StoredIObjects() const = 0;
 
  virtual
  int 
  IObjectCount() const = 0;
 
  virtual
  bool 
  HasIndex(const Handle(SALOME_InteractiveObject)& theIO ) const = 0;
 
  virtual
  void 
  GetIndex( const Handle(SALOME_InteractiveObject)& theIO, 
            SVTK_TIndexedMapOfVtkId& theIndex ) = 0;
        
  virtual
  bool 
  AddOrRemoveIndex( const Handle(SALOME_InteractiveObject)& theIO, 
                    const SVTK_TIndexedMapOfVtkId& theIndices, 
                    bool theIsModeShift) = 0;
 
  virtual
  bool 
  AddOrRemoveIndex( const Handle(SALOME_InteractiveObject)& theIO, 
                    const SVTK_TVtkIDsMap& theIndices, 
                    bool theIsModeShift) = 0;
 
  virtual
  bool
  AddOrRemoveIndex( const Handle(SALOME_InteractiveObject)& theIO, 
                    int theIndex, 
                    bool theIsModeShift) = 0;
 
  virtual
  void 
  RemoveIndex( const Handle(SALOME_InteractiveObject)& theIO, 
               int theIndex) = 0;
 
  virtual
  bool 
  IsIndexSelected(const Handle(SALOME_InteractiveObject)& theIO, 
                  int theIndex) const = 0;
 
  virtual
  void 
  ClearIndex() = 0;
 
  virtual
  bool 
  HasCompositeIndex(const Handle(SALOME_InteractiveObject)& theIO ) const = 0;
 
  virtual
  void 
  GetCompositeIndex( const Handle(SALOME_InteractiveObject)& theIO, 
               SVTK_IndexedMapOfVtkIds& theIds ) = 0;
        
  virtual
  bool 
  AddOrRemoveCompositeIndex( const Handle(SALOME_InteractiveObject)& theIO, 
                    const SVTK_IndexedMapOfVtkIds& theIds,
                    bool theIsModeShift) = 0;
 
  virtual
  bool
  AddOrRemoveCompositeIndex( const Handle(SALOME_InteractiveObject)& theIO, 
                    SVTK_ListOfVtk ids, 
                    bool theIsModeShift) = 0;
 
  virtual
  void 
  RemoveCompositeIndex( const Handle(SALOME_InteractiveObject)& theIO, 
               SVTK_ListOfVtk ids ) = 0;
 
  virtual
  bool 
  IsCompositeIndexSelected(const Handle(SALOME_InteractiveObject)& theIO, 
                  SVTK_ListOfVtk ids ) const = 0;
 
  virtual
  void 
  ClearCompositeIndex() = 0;
 
  //----------------------------------------------------------------------------
  typedef int TFilterID;
 
  virtual
  void 
  SetFilter(const Handle(VTKViewer_Filter)& theFilter) = 0;
 
  virtual
  Handle(VTKViewer_Filter) 
  GetFilter(const TFilterID theId) const = 0;
 
  virtual
  bool
  IsFilterPresent(const TFilterID theId) const = 0;
 
  virtual
  void
  RemoveFilter(const TFilterID theId) = 0;
 
  virtual
  bool
  IsValid(SALOME_Actor* theActor,
          const int theId,
          const bool theIsNode = false) const = 0;
  
  //----------------------------------------------------------------------------
  virtual
  void 
  StartPickCallback() = 0;
 
  virtual
  void 
  EndPickCallback() = 0;
 
  //----------------------------------------------------------------------------
  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;
};
 
 
#endif