src/GLViewer/GLViewer_AspectLine.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_AspectLine.h
  24 // Created:   November, 2004
  25 //
  26 #ifndef GLVIEWER_ASPECTLINE_H
  27 #define GLVIEWER_ASPECTLINE_H
  28
  29 #include "GLViewer.h"
  30
  31 #include <QColor>
  32
  33 #ifdef WIN32
  34 #pragma warning( disable:4251 )
  35 #endif
  36
  37 /*!
  38  \Class GLViewer_AspectLine
  39  Substitution of Prs2d_AspectLine for OpenGL
  40 */
  41
  42 class GLVIEWER_API GLViewer_AspectLine
  43 {
  44 public:
  45   //! A default constructor
  46   /* Line is Non strip
  47    * Normal color is white
  48    * Highlight color is cyan
  49    * Select color is red
  50   */
  51   GLViewer_AspectLine();
  52   //! A conctructor by type and width of line
  53   /*!
  54    \param theType equals 0 for normal line and 1 for strip line
  55    \param theWidth is a width of new line
  56   */
  57   GLViewer_AspectLine( int theType, float theWidth );
  58
  59   //! A destructor
  60   ~GLViewer_AspectLine();
  61
  62   //! A function for installing the line colors
  63   /*!
  64    \param nc is normal color
  65    \param hc is highlight color
  66    \param sc is select color
  67   */
  68   void                  setLineColors( QColor nc = Qt::black,
  69                                        QColor hc = Qt::cyan,
  70                                        QColor sc = Qt::red );
  71   //! A function for installing the line width
  72   int                   setLineWidth( const float theWidth );
  73   //! A function for installing the line type
  74   /*!
  75    \param theType equals 0 for normal line and 1 for strip line
  76   */
  77   int                   setLineType( const int theType );
  78
  79   //! A function for getting line colors information
  80   /*!
  81    \param theNC is normal color
  82    \param theHC is highlight color
  83    \param theSC is select color
  84   */
  85   void                  getLineColors( QColor& theNC, QColor& theHC, QColor& theSC ) const;
  86   //! A function for getting information about line width
  87   float                 getLineWidth() const { return myLineWidth; };
  88   //! A function for getting information about line type
  89   int                   getLineType() const { return myLineType; };
  90
  91   //! A function for coding object to the byte copy
  92   /*!
  93      A function is used for copy-past technollogy in copy method
  94    */
  95   QByteArray            getByteCopy() const;
  96
  97   //! A function for decoding object from the byte copy
  98   /*!
  99      A function is used for copy-past technollogy in past method
 100    */
 101   static GLViewer_AspectLine* fromByteCopy( QByteArray );
 102
 103 protected:
 104   //! A normal color
 105   QColor                myNColor;
 106   //! A highlight color
 107   QColor                myHColor;
 108   //! A select color
 109   QColor                mySColor;
 110   //! A line width
 111   float                 myLineWidth;
 112   //! A line type
 113   /*! equals 0 for normal line and 1 for strip line */
 114   int                   myLineType;
 115 };
 116
 117 #ifdef WIN32
 118 #pragma warning ( default:4251 )
 119 #endif
 120
 121 #endif