ryzom/client/src/interfaces_manager/osd_base.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef CL_OSD_BASE_H
  20 #define CL_OSD_BASE_H
  21
  22 #include "nel/misc/types_nl.h"
  23 #include "osd.h"
  24
  25
  26 /**
  27  * Class to manage OSD Base.
  28  * \author Guillaume PUZIN
  29  * \author Nevrax France
  30  * \date 2001
  31  */
  32 class COSDBase
  33 {
  34 public:
  35
  36         /// Constructor
  37         COSDBase();
  38
  39         /** \name Background
  40          * Variables to manage the background of the OSD.
  41          */
  42         //@{
  43         /// Display mode for the background.
  44         COSD::TBG       _BG_Mode;
  45         /// Id of the texture for the background.
  46         uint            _BG;
  47         /// Color of the Background.
  48         CRGBA           _BG_Color;
  49         //@}
  50
  51         /** \name Title Bar
  52          * Variables to manage the Title Bar of the OSD.
  53          */
  54         //@{
  55         /// Display mode for the Title Bar.
  56         COSD::TTB       _TB_Mode;
  57         /// Id of the texture for the Title BAr.
  58         uint            _TB;
  59         /// Color of the Title Bar.
  60         CRGBA           _TB_Color;
  61         /// Pen of the Title Bar.
  62         CPen            _TB_Pen;
  63         //@}
  64
  65         /** \name HighLight
  66          * Variables to manage the HighLight of the OSD.
  67          */
  68         //@{
  69         /// Color of the HighLight.
  70         CRGBA           _HL_Color;
  71         /// HighLight Size (in Pixel).
  72         float           _HL_Size;
  73         //@}
  74
  75         /** \name Resize
  76          * Variables to manage the Resize of the OSD.
  77          */
  78         //@{
  79         /// Resize borders Color
  80         CRGBA           _RS_Color;
  81         /// Resize size (in pixel).
  82         float           _RS_Size;
  83         //@}
  84 };
  85
  86
  87 #endif // CL_OSD_BASE_H
  88
  89 /* End of osd_base.h */