src/GLViewer/GLViewer_AspectLine.h

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