src/GLViewer/GLViewer_Context.h

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  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.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  Author : OPEN CASCADE
  23 // File:      GLViewer_Context.h
  24 // Created:   November, 2004
  25 //
  26 #ifndef GLVIEWER_CONTEXT_H
  27 #define GLVIEWER_CONTEXT_H
  28
  29 #ifdef WIN32
  30 #include "windows.h"
  31 #endif
  32
  33 #include "GLViewer_Defs.h"
  34 #include "GLViewer_Object.h"
  35
  36 class QRect;
  37
  38 #include <Quantity_NameOfColor.hxx>
  39 #include <Quantity_Color.hxx>
  40
  41 #include <GL/gl.h>
  42
  43 class GLViewer_Viewer2d;
  44
  45 #ifdef WIN32
  46 #pragma warning( disable:4251 )
  47 #endif
  48
  49 /*! \class GLViewer_Context
  50  *  Class for manage of presentations in GLViewer
  51  */
  52 class GLVIEWER_API GLViewer_Context
  53 {
  54 public:
  55   //! A constructor
  56   GLViewer_Context( GLViewer_Viewer2d* );
  57   //! A desructor
  58   ~GLViewer_Context();
  59
  60   //! A function installing update flag in highlighting technology
  61   void                  setUpdateAll( bool on ) { myUpdateAll = on; }
  62   //! Returns update flag in highlighting technology
  63   bool                  isUpdateAll() const { return myUpdateAll; }
  64
  65   //! Main interactive method. Trace mouse in viewer window
  66   /*!
  67   *\param x - X coord of mouse cursor
  68   *\param y - Y coord of mouse cursor
  69   *\paran byCircle - true if needs round sensitive area around mouse cursor, else rectangle
  70   *function search object rectangle which intersect with sensitive area and call object highlight method
  71   */
  72   int                   MoveTo( int x, int y, bool byCircle = FALSE );
  73   /*! A function selecting already highlighting object by calling object method select
  74   *\param Append - true if new selection will be append to existing selection, false - another
  75   *\param byCircle - true if needs round selection area in complex object
  76   */
  77   int                   Select( bool Append = FALSE, bool byCircle = FALSE );
  78   /*! A function selecting objects on scene by rectangle
  79   *\param theRect - rectangle of selection
  80   *\param Append - true if new selection will be append to existing selection, false - another
  81   *function search object rectangle which intersect with theRect and call object select method
  82   */
  83   int                   SelectByRect( const QRect& theRect, bool Append = FALSE );
  84
  85   //! A function installing highlight color for all presentation (does not work)
  86   void                  SetHighlightColor( Quantity_NameOfColor aCol );
  87   //! A function installing select color for all presentation (does not work)
  88   void                  SetSelectionColor( Quantity_NameOfColor aCol );
  89   //! Returns highlight color
  90   Quantity_NameOfColor  HighlightColor() { return myHighlightColor; }
  91   //! Returns select color
  92   Quantity_NameOfColor  SelectionColor() { return mySelectionColor; }
  93
  94   //! Returns number of objects in current selection
  95   int                   NbSelected();
  96   //! A function set iterator of selected objects on first object
  97   void                  InitSelected();
  98   //! Retuns true if iterator of selected objects is not set on last object
  99   bool                  MoreSelected();
 100   //! Increment of iterator of selected objects
 101   bool                  NextSelected();
 102   //! Returns object corresponding the current iterator of selected objects
 103   GLViewer_Object*      SelectedObject();
 104
 105   //! Returns true if theObject is selected
 106   bool                  isSelected( GLViewer_Object* theObject );
 107
 108   //! Insert new object in context
 109   /*!
 110   *\param theObject - inserting object
 111   *\param display - true if needs display object immediatly after inserting, else false
 112   *\param isActive - true if needs inserting object in active list
 113   */
 114   int                   insertObject( GLViewer_Object* theObject, bool display = false, bool isActive = true );
 115   //! Replacing objects in context
 116   /*!
 117   * Function search active and incative objects
 118   */
 119   bool                  replaceObject( GLViewer_Object* oldObject, GLViewer_Object* newObject );
 120   //! A function updating scales of all objects in context
 121   void                  updateScales( GLfloat theX, GLfloat theY );
 122   //! A function installing tolerance in window pixels for highlghting and selection methods
 123   void                  setTolerance( int tol ) { myTolerance = tol; }
 124
 125   //! Returns list of context objects
 126   /*!
 127   * \return active objects if isActive = true, else inactive objects
 128   */
 129   const ObjList&        getObjects( bool isActive = true )
 130                         { return isActive ? myActiveObjects : myInactiveObjects; }
 131
 132   //! Returns first active object
 133   GLViewer_Object*      getFirstObject() { return *( myActiveObjects.begin() ); }
 134
 135   //! A function clear highlighted object information
 136   void                  clearHighlighted( bool updateViewer );
 137   //! A function clear selection object information
 138   void                  clearSelected( bool updateViewer );
 139   //! A function make theObject as selected object and update viewer if updateViewer = true
 140   void                  setSelected( GLViewer_Object* theObject, bool updateViewer );
 141   //! A function make theObject as unselected object and update viewer if updateViewer = true
 142   void                  remSelected( GLViewer_Object* theObject, bool updateViewer );
 143
 144   //! Returns highlighted object
 145   GLViewer_Object*      getCurrentObject() { return myLastPicked; }
 146   //! Returns true if after last MoveTo method calling highlight object is changed
 147   bool                  currentObjectIsChanged() { return myLastPickedChanged; }
 148
 149   //! A function installing to theObject invisible status and update viewer if updateViewer = true
 150   void                  eraseObject( GLViewer_Object* theObject, bool updateViewer = true );
 151   //! A function remove theObject from context and update viewer if updateViewer = true
 152   void                  deleteObject( GLViewer_Object* theObject, bool updateViewer = true );
 153
 154   //! A function installing to theObject active status
 155   bool                  setActive( GLViewer_Object* theObject );
 156   //! A function installing to theObject inactive status
 157   bool                  setInactive( GLViewer_Object* theObject );
 158
 159 protected:
 160   //! Flag of updating viewer after highlight
 161   /*!
 162   * if = true, the viewer update all objects after change of highlight object,
 163   * else - only highlight object
 164   */
 165   bool                  myUpdateAll;
 166
 167   GLViewer_Viewer2d*    myGLViewer2d;
 168   //! Highlighted object
 169   GLViewer_Object*      myLastPicked;
 170   //! = true if after last MoveTo method calling highlight object is changed
 171   bool                  myLastPickedChanged;
 172
 173   //! List of active object
 174   /*!Active objects if consider in highlight and select methods*/
 175   ObjList               myActiveObjects;
 176   //! List of inactive object
 177   /*!Active objects isn't consider in highlight and select methods*/
 178   ObjList               myInactiveObjects;
 179
 180   //! List of selected objects
 181   ObjList               mySelectedObjects;
 182   //! Selected object iterator
 183   int                   mySelCurIndex;
 184
 185   //! X coordinate of mouse cursor
 186   GLfloat               myXhigh;
 187   //! Y coordinate of mouse cursor
 188   GLfloat               myYhigh;
 189
 190   //! Color for highlight
 191   Quantity_NameOfColor  myHighlightColor;
 192   //! Color for selection
 193   Quantity_NameOfColor  mySelectionColor;
 194   //! If = false - moveTo method is not any highlighting
 195   GLboolean             myHFlag;
 196   //! If = false - select method is not any select
 197   GLboolean             mySFlag;
 198   //! Tolerance in window pixels for highlghting and selection methods
 199   int                   myTolerance;
 200 };
 201
 202 #ifdef WIN32
 203 #pragma warning ( default:4251 )
 204 #endif
 205
 206 #endif