src/GEOMGUI/GEOM_Displayer.h

   1 //  GEOM GEOMGUI : GUI for Geometry component
   2 //
   3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : GEOM_Displayer.h
  25 //  Author : Vadim SANDLER
  26 //  Module : GEOM
  27 //  $Header$
  28
  29 #if !defined (__GEOM_DISPLAYER_H)
  30 #define __GEOM_DISPLAYER_H
  31
  32 #include "SALOME_Prs.h"
  33 #include "SALOME_InteractiveObject.hxx"
  34 #include "SALOME_ListIO.hxx"
  35 #include <TopoDS_Shape.hxx>
  36 #include <Quantity_Color.hxx>
  37
  38 #include <list>
  39
  40 #include <SALOMEconfig.h>
  41 #include CORBA_CLIENT_HEADER(GEOM_Gen)
  42
  43 #define GEOM_ALLOBJECTS -1 // Selection of all objects is activated
  44 #define GEOM_PREVIEW    -2 // Definition for preview selection
  45 #define GEOM_ALLSHAPES  -3 // Selection of all shapes is activated
  46 #define GEOM_ALLGEOM    -4 // Selection of all geom objects is activated
  47
  48 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
  49
  50 class TColStd_MapOfInteger;
  51 class SalomeApp_SelectionMgr;
  52 class SalomeApp_Study;
  53 class SUIT_SelectionFilter;
  54 //class SALOME_Selection;
  55
  56 class GEOM_Displayer : public SALOME_Displayer
  57 {
  58
  59 public:
  60   /* Constructor */
  61   GEOM_Displayer( SalomeApp_Study* study );
  62   /* Destructor */
  63   virtual ~GEOM_Displayer();
  64
  65   /* Display/Erase object methods */
  66
  67   void          Display   ( const Handle(SALOME_InteractiveObject)& theIO,
  68                             const bool updateViewer = true,
  69                             SALOME_View* theViewFrame = 0 );
  70
  71   // This overloaded Display() method can be useful for operations
  72   // not using dialog boxes.
  73   void          Display   ( GEOM::GEOM_Object_ptr theObj,
  74                             const bool updateViewer = true );
  75
  76   void          Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
  77                             const bool updateViewer = true );
  78
  79   void          Erase     ( const Handle(SALOME_InteractiveObject)& theIO,
  80                             const bool forced = false,
  81                             const bool updateViewer = true,
  82                             SALOME_View* theViewFrame = 0 );
  83
  84   void          Erase     ( GEOM::GEOM_Object_ptr theObj,
  85                             const bool forced = false,
  86                             const bool updateViewer = true );
  87
  88   /* Display/Erase list of objects methods */
  89
  90   void          Display   ( const SALOME_ListIO& theIOList,
  91                             const bool updateViewer = true );
  92
  93   void          Erase     ( const SALOME_ListIO& theIOList,
  94                             const bool forced = false,
  95                             const bool updateViewer = true );
  96
  97   void          Redisplay ( const SALOME_ListIO& theIOList,
  98                             const bool updateViewer = true );
  99
 100   /* Erase all objects displayed in the given or active view */
 101   void          EraseAll ( const bool forced = false,
 102                            const bool updateViewer = true,
 103                            SALOME_View* theViewFrame = 0 );
 104
 105   /* Update current viewer */
 106   void          UpdateViewer();
 107
 108   /* build presentation accordint to the current viewer type*/
 109   SALOME_Prs*   BuildPrs  ( GEOM::GEOM_Object_ptr );
 110   SALOME_Prs*   BuildPrs  ( const TopoDS_Shape& );
 111
 112   /* Set color for shape displaying. If it is equal -1 then default color is used.
 113      Available values are from Quantity_NameOfColor enumeration */
 114   void          SetColor  ( const int );
 115   void          UnsetColor();
 116   int           GetColor  () const;
 117   bool          HasColor  () const;
 118
 119   /* Set width for shape displaying. If it is equal -1 then default width is used. */
 120   void          SetWidth  ( const double );
 121   void          UnsetWidth();
 122   double        GetWidth  () const;
 123   bool          HasWidth  () const;
 124
 125
 126   /* Sets name - for temporary objects only */
 127   void          SetName( const char* theName ) { myName = theName; }
 128   void          UnsetName() { myName = ""; }
 129
 130   /* Reimplemented from SALOME_Displayer */
 131   virtual void  Update( SALOME_OCCPrs* );
 132   virtual void  Update( SALOME_VTKPrs* );
 133   virtual void  BeforeDisplay( SALOME_View*, const SALOME_OCCViewType& );
 134   virtual void  AfterDisplay ( SALOME_View*, const SALOME_OCCViewType& );
 135
 136   /* This methos is used for activisation/deactivisation of objects to be displayed*/
 137   void          SetToActivate( const bool );
 138   bool          ToActivate() const;
 139
 140   /* Activate/Deactivate selection*/
 141   void         LocalSelection( const Handle(SALOME_InteractiveObject)&, const int );
 142   void         LocalSelection( const SALOME_ListIO& theIOList, const int );
 143   void         GlobalSelection( const int = GEOM_ALLOBJECTS, const bool = false );
 144   void         GlobalSelection( const TColStd_MapOfInteger&, const bool = false );
 145
 146   static SALOME_View* GetActiveView();
 147   SalomeApp_Study* getStudy() const {return myStudy;}
 148
 149 protected:
 150   /* internal methods */
 151   /* Builds presentation accordint to the current viewer type */
 152   SALOME_Prs* buildPresentation( const Handle(SALOME_InteractiveObject)& theIO,
 153                                  SALOME_View* theViewFrame = 0 );
 154
 155   /* Sets interactive object */
 156   void        setIO( const Handle(SALOME_InteractiveObject)& theIO ) { myIO = theIO; }
 157
 158   /* Sets shape */
 159   void        setShape( const TopoDS_Shape& theShape ) { myShape = theShape; }
 160
 161   /* Resets internal data */
 162   void        internalReset();
 163
 164   void        clearTemporary( SalomeApp_SelectionMgr* theSelMgr );
 165
 166   SUIT_SelectionFilter* getFilter( const int theMode );
 167
 168 protected:
 169   Handle(SALOME_InteractiveObject) myIO;
 170   TopoDS_Shape                     myShape;
 171   string                           myName;
 172   int                              myType;
 173   SALOME_View*                     myViewFrame;
 174
 175   // Attributes
 176   Quantity_Color                   myShadingColor;
 177   int                              myColor;
 178   double                           myWidth;
 179   bool                             myToActivate;
 180
 181 private:
 182   SalomeApp_Study* myStudy;
 183 };
 184
 185 #endif // __GEOM_DISPLAYER_H
 186