Salome HOME
updated copyright message
[modules/gui.git] / src / GLViewer / GLViewer_Grid.h
index 7cdd6bd227f5a3d7167ceea65c61e1f9c9026ea5..6745fea88fccb40d5db26ea127e2a3fdb1213d24 100644 (file)
+// Copyright (C) 2007-2023  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
+//
+
+//  Author : OPEN CASCADE
 // File:      GLViewer_Grid.h
 // Created:   November, 2004
-// Author:    OCC team
-// Copyright (C) CEA 2004
-
+//
 #ifndef GLVIEWER_GRID_H
 #define GLVIEWER_GRID_H
 
-#ifdef WNT
+#ifdef WIN32
 #include "windows.h"
 #endif
 
 #include "GLViewer.h"
 
+#ifdef __APPLE__
+#include <OpenGL/gl.h>
+#include <OpenGL/glu.h>
+#else
 #include <GL/gl.h>
 #include <GL/glu.h>
+#endif
 
-#ifdef WNT
+#ifdef WIN32
 #pragma warning( disable:4251 )
 #endif
 
+/*! Class GLViewer_Grid
+  2D rectangular grid for GLViewer
+  Grid is adapt cells for current view
+*/
+
 class GLVIEWER_API GLViewer_Grid 
 {
 public:
+  //! A default constructor
   GLViewer_Grid();
-  GLViewer_Grid( float, float, float, float, float, float, float, float, float, float );
+  //! A constructor
+  /*
+  * \param  width and \param height - width and height of grid 
+  * \param winW and \param winH     - width and height of window 
+  * \param xSize and \param ySize   - steps along x and y direction
+  * \param xPan and \param yPan     - offsets along x and y direction
+  * \param xScale and \param yScal  - scale factors along x and y direction
+  */
+  GLViewer_Grid( GLfloat width, GLfloat height,
+                 GLfloat winW, GLfloat winH,
+                 GLfloat xSize, GLfloat ySize,
+                 GLfloat xPan, GLfloat yPan,
+                 GLfloat xScale, GLfloat yScale );
   ~GLViewer_Grid();
 
+  //! Draws grid
   void                   draw();
 
-  void                   setGridColor( GLfloat, GLfloat, GLfloat );
-  void                   setAxisColor( GLfloat, GLfloat, GLfloat );
+  //! Sets color of grid in RGB format
+  void                   setGridColor( GLfloat r, GLfloat g, GLfloat b );
+  //! Sets color of grid axes in RGB format
+  void                   setAxisColor( GLfloat r, GLfloat g, GLfloat b );
   void                   setGridWidth( float );
+  //! Sets Radius of center point( begin coords )
   void                   setCenterRadius( int );
 
-  void                   setSize( float, float );
-  void                   setPan( float, float );
-  bool                   setZoom( float );
-  void                   setResize( float, float, float );
+  //! Sets steps along x and y directions
+  void                   setSize( float xs, float ys );
+  //! Sets offset along x and y direction
+  void                   setPan( float xp, float yp );
+  //! Sets common scale factor along x and y direction
+  bool                   setZoom( float zoom );
+  //! Recomputes grid in new size and scale of view
+  void                   setResize( float winW, float winH, float Zoom );
 
   void                   getSize( float&, float& ) const;
   void                   getPan( float&, float& ) const;
   void                   getScale( float&, float& ) const;
 
+  //! Sets step of scale
   void                   setScaleFactor( int );
   int                    getScaleFactor();
 
 protected:
+  //! Initialize grid display list
   bool                   initList();
 
   GLuint                 myGridList;
@@ -68,7 +122,7 @@ protected:
   GLboolean              myIsUpdate;
 };
 
-#ifdef WNT
+#ifdef WIN32
 #pragma warning ( default:4251 )
 #endif