src/GLViewer/GLViewer_Compass.h

   1 // Copyright (C) 2007-2023  CEA, EDF, 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, or (at your option) any later version.
  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
  23 //  Author : OPEN CASCADE
  24 // File:      GLViewer_Compass.h
  25 // Created:   November, 2004
  26 //
  27 #ifndef GLVIEWER_COMPASS_H
  28 #define GLVIEWER_COMPASS_H
  29
  30 #include "GLViewer.h"
  31
  32 #include <QColor>
  33
  34 class QFont;
  35
  36 #ifdef WIN32
  37 #pragma warning( disable:4251 )
  38 #endif
  39
  40 class GLViewer_TexFont;
  41
  42 /*! Class GLViewer_Compass
  43  * Class implement representatiof of compass in one of corner in GLViewer.
  44  * Compass it's a some round visual pointer rotated with view window and
  45  * located in fixed place (in one fixed corner)
  46  */
  47 class GLVIEWER_API GLViewer_Compass
  48 {
  49 public:
  50   //! Position of compass
  51   enum Position
  52   {
  53     TopLeft,
  54     TopRight,
  55     BottomLeft,
  56     BottomRight
  57   };
  58
  59   //! A constructor
  60   /*!
  61   *\param color        - a color of compass
  62   *\param size         - a diameter of compass
  63   *\param pos          - a position
  64   *\param WidthTop     - width of wide part of arrow
  65   *\param WidthBottom  - width of base part of arrow
  66   *\param HeightTop    - height of arrow header
  67   *\param HeightBottom - height of arrow cut on bottom
  68   */
  69   GLViewer_Compass( const QColor& color = QColor ( 0, 255, 0 ),
  70                    const int size = 60,
  71                    const Position pos = TopRight,
  72                    const int WidthTop = 20,
  73                    const int WidthBottom = 10,
  74                    const int HeightTop = 25,
  75                    const int HeightBottom = 7 );
  76   //! A destructor
  77   ~GLViewer_Compass();
  78
  79   //! A function installing main parameters of compass
  80   void              setCompass( const QColor& color, const int size, const Position pos );
  81   //! A function installing a visible status
  82   void              setVisible( const bool vis = true );
  83   //! Returns visible status
  84   bool              getVisible(){ return myIsVisible; };
  85
  86   //! A function installing diameter
  87   void              setSize( const int size );
  88   //! Returns diameter
  89   int               getSize(){ return mySize; }
  90
  91   //! A function installing position
  92   void              setPos( const Position pos ){ myPos = pos; }
  93   //! Returns position
  94   int               getPos(){ return myPos; }
  95
  96   //! A function installing color
  97   void              setColor( const QColor& color ){ myCol = color; }
  98   //! Returns color
  99   QColor            getColor(){ return myCol; }
 100
 101   //! A function installing width of wide part of arrow
 102   void              setArrowWidthTop( const int WidthTop );
 103   //! Returns width of wide part of arrow
 104   int               getArrowWidthTop(){ return myArrowWidthTop; }
 105
 106   //! A function installing width of base part of arrow
 107   void              setArrowWidthBottom( const int WidthBot );
 108   //! Returns width of base part of arrow
 109   int               getArrowWidthBottom(){return myArrowWidthBottom;};
 110
 111   //! A function installing height of arrow header
 112   void              setArrowHeightTop( const int HeightTop );
 113   //! Returns height of arrow header
 114   int               getArrowHeightTop(){return myArrowHeightTop;};
 115
 116   //! A function installing height of arrow cut on bottom
 117   void              setArrowHeightBottom( const int HeightBot );
 118   //! Returns height of arrow cut on bottom
 119   int               getArrowHeightBottom(){return myArrowHeightBottom;};
 120
 121   //! A function installing
 122   void              setFont( QFont theFont );
 123   //! Returns
 124   GLViewer_TexFont* getFont();
 125
 126 protected:
 127   //! Compass color
 128   QColor             myCol;
 129   //! Compass diameter
 130   int                mySize;
 131   //! Compass position
 132   int                myPos;
 133   //! Compass invisible status
 134   bool               myIsVisible;
 135   //! Width of wide part of arrow
 136   int                myArrowWidthTop;
 137   //! Width of base part of arrow
 138   int                myArrowWidthBottom;
 139   //! Height of arrow header
 140   int                myArrowHeightTop;
 141   //! Height of arrow cut on bottom
 142   int                myArrowHeightBottom;
 143   //! Compass font
 144   GLViewer_TexFont*  myFont;
 145   //! Status of generated font
 146   bool               isGenereted;
 147 };
 148
 149 #ifdef WIN32
 150 #pragma warning ( default:4251 )
 151 #endif
 152
 153 #endif