SALOME_Actor.h

Go to the documentation of this file.

// Copyright (C) 2007-2026  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 OBJECT : implementation of interactive object visualization for OCC and VTK viewers
//  File   : SALOME_Actor.h
//  Author : Nicolas REJNERI
 
#ifndef SALOME_ACTOR_H
#define SALOME_ACTOR_H
 
#include "SVTK_SelectionEvent.h"
#include "SVTK_Selector.h"
#include "SVTK.h"
 
class SALOME_InteractiveObject;
 
// undefining min and max because CASCADE's defines them and
// it clashes with std::min(), std::max()
#undef min
#undef max
 
#include <VTKViewer_Actor.h>
#include <VTKViewer_MarkerDef.h>
 
#include <vtkSmartPointer.h>
 
class vtkAbstractPicker;
class vtkPointPicker;
class vtkCellPicker;
class vtkOutlineSource;
class vtkInteractorStyle;
class vtkRenderWindowInteractor;
 
class VTKViewer_FramedTextActor;
 
class SVTK_Actor;
class SVTK_AreaPicker;
class SVTK_InteractorStyle;
 
SVTK_EXPORT extern int SALOME_POINT_SIZE;
SVTK_EXPORT extern int SALOME_LINE_WIDTH;
 
#ifdef WIN32
#pragma warning ( disable:4251 )
#endif
 
 
class SVTK_EXPORT SALOME_Actor : public VTKViewer_Actor 
{
 public:
  static SALOME_Actor* New();
  
  vtkTypeMacro(SALOME_Actor,VTKViewer_Actor)
 
  //----------------------------------------------------------------------------
  virtual
  Standard_Boolean 
  hasIO();
 
  virtual 
  const Handle(SALOME_InteractiveObject)& 
  getIO(); 
 
  virtual
  void
  setIO(const Handle(SALOME_InteractiveObject)& theIO);
 
  virtual
  void
  setName(const char* theName);
 
  //----------------------------------------------------------------------------
  virtual
  void
  SetTransform(VTKViewer_Transform* theTransform); 
 
  virtual
  void
  SetPosition(double _arg1, 
              double _arg2, 
              double _arg3);
 
  virtual
  void
  SetPosition(double _arg[3]);
 
  //----------------------------------------------------------------------------
  virtual
  void
  SetVisibility( int );
 
  virtual
  bool
  ShouldBeDisplayed();
 
  //----------------------------------------------------------------------------
  virtual
  void
  AddToRender(vtkRenderer* theRendere); 
 
  virtual
  void
  RemoveFromRender(vtkRenderer* theRendere);
 
  vtkRenderer*
  GetRenderer();
 
  //----------------------------------------------------------------------------
  virtual
  void
  SetInteractor(vtkRenderWindowInteractor* theInteractor);
 
  virtual
  void
  Update();
 
  //----------------------------------------------------------------------------
  virtual
  void
  SetSelector(SVTK_Selector* theSelector);
 
  virtual
  void
  highlight(bool theHighlight);  
 
  virtual
  void
  Highlight(bool theHighlight);  
 
  //----------------------------------------------------------------------------
  virtual
  bool
  PreHighlight(vtkInteractorStyle* theInteractorStyle, 
               SVTK_SelectionEvent* theSelectionEvent,
               bool theIsHighlight);
 
  virtual 
  bool
  Highlight(vtkInteractorStyle* theInteractorStyle, 
            SVTK_SelectionEvent* theSelectionEvent,
            bool theIsHighlight);
 
  //----------------------------------------------------------------------------
  virtual
  bool
  IsDisplayNameActor() const;
 
  virtual
  void
  SetIsDisplayNameActor(bool theIsDisplayNameActor);
 
  virtual
  void
  SetNameActorText(const char* theText);
 
  virtual
  void
  SetNameActorOffset(double theOffset[2]);
 
  virtual
  void
  GetNameActorSize(vtkRenderer* theRenderer, double theSize[2]) const;
 
  virtual
  void
  UpdateNameActors();
 
  //----------------------------------------------------------------------------
  virtual
  void
  SetMarkerStd( VTK::MarkerType, VTK::MarkerScale );
 
  virtual
  void
  SetMarkerTexture( int, VTK::MarkerTexture );
 
  virtual
  VTK::MarkerType
  GetMarkerType();
 
  virtual
  VTK::MarkerScale
  GetMarkerScale();
 
  virtual
  int
  GetMarkerTexture();
 
  //----------------------------------------------------------------------------
  void
  SetPointPicker(vtkPointPicker* thePointPicker); 
 
  void
  SetCellPicker(vtkCellPicker* theCellPicker); 
 
  void
  SetPointAreaPicker(SVTK_AreaPicker* theAreaPicker);
 
  void
  SetCellAreaPicker(SVTK_AreaPicker* theAreaPicker);
 
  //----------------------------------------------------------------------------
  double* GetGravityCenter( int );
 
  //----------------------------------------------------------------------------
  void
  SetPreHighlightProperty(vtkProperty* theProperty);
 
  void
  SetHighlightProperty(vtkProperty* theProperty);
 
 protected:
  //----------------------------------------------------------------------------
  vtkRenderWindowInteractor* myInteractor;
  vtkRenderer* myRenderer;
 
  Handle(SALOME_InteractiveObject) myIO;
 
  SALOME_Actor();
  ~SALOME_Actor();
 
 protected:
  Selection_Mode mySelectionMode;
  vtkSmartPointer<SVTK_Selector> mySelector;
 
  //----------------------------------------------------------------------------
  // Highlight/ Prehighlight devices
  vtkSmartPointer<vtkPointPicker> myPointPicker;
  vtkSmartPointer<vtkCellPicker> myCellPicker;
 
  vtkSmartPointer<SVTK_AreaPicker> myPointAreaPicker;
  vtkSmartPointer<SVTK_AreaPicker> myCellAreaPicker;
 
  vtkSmartPointer<SVTK_Actor> myPreHighlightActor;
  vtkSmartPointer<SVTK_Actor> myHighlightActor;
 
  vtkSmartPointer<VTKViewer_Actor> myOutlineActor;
  vtkSmartPointer<vtkOutlineSource> myOutline;
 
  bool myIsDisplayNameActor;
  vtkSmartPointer<VTKViewer_FramedTextActor> myNameActor;
};
 
namespace SVTK
{
  class SVTK_EXPORT TPickLimiter
  {
    vtkAbstractPicker* myPicker;
  public:
    TPickLimiter(vtkAbstractPicker*, SALOME_Actor*);
    ~TPickLimiter();
  };
}
 
#ifdef WIN32
#pragma warning ( default:4251 )
#endif
 
#endif // SALOME_ACTOR_H