guiSwatchButtonCtrl.h

Engine/source/gui/buttons/guiSwatchButtonCtrl.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUISWATCHBUTTONCTRL_H_
25#define _GUISWATCHBUTTONCTRL_H_
26
27#ifndef _GUIBUTTONBASECTRL_H_
28   #include "gui/buttons/guiButtonBaseCtrl.h"
29#endif
30
31
32/// A color swatch button.
33///
34class GuiSwatchButtonCtrl : public GuiButtonBaseCtrl
35{
36   public:
37      
38      typedef GuiButtonBaseCtrl Parent;
39
40   protected:
41      
42      /// The color to display on the button.
43      LinearColorF mSwatchColor;
44      /// Bitmap used for mGrid
45      String mGridBitmap;
46
47      /// Background texture that will show through with transparent colors.
48      GFXTexHandle mGrid;
49      
50   public:
51
52      GuiSwatchButtonCtrl();
53
54      /// Return the color displayed in the swatch.
55      LinearColorF getColor() { return mSwatchColor; }
56
57      /// Set the color to display in the swatch.
58      void setColor( const LinearColorF &color ) { mSwatchColor = color; }
59
60      // GuiButtonBaseCtrl
61      virtual bool onWake();
62      virtual void onRender(Point2I offset, const RectI &updateRect);
63
64      static void initPersistFields();
65
66      DECLARE_CONOBJECT( GuiSwatchButtonCtrl );
67      DECLARE_DESCRIPTION( "A color swatch button." );
68};
69
70#endif // _GUISWATCHBUTTONCTRL_H_
71