guiBitmapCtrl.h

Engine/source/gui/controls/guiBitmapCtrl.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 _GUIBITMAPCTRL_H_
25#define _GUIBITMAPCTRL_H_
26
27#ifndef _GUICONTROL_H_
28#include "gui/core/guiControl.h"
29#endif
30
31/// Renders a bitmap.
32class GuiBitmapCtrl : public GuiControl
33{
34   public:
35   
36      typedef GuiControl Parent;
37
38   protected:
39   
40      /// Name of the bitmap file.  If this is 'texhandle' the bitmap is not loaded
41      /// from a file but rather set explicitly on the control.
42      String mBitmapName;
43      
44      /// Loaded texture.
45      GFXTexHandle mTextureObject;
46      
47      Point2I mStartPoint;
48      ColorI   mColor;
49      
50      /// If true, bitmap tiles inside control.  Otherwise stretches.
51      bool mWrap;
52
53      static bool setBitmapName( void *object, const char *index, const char *data );
54      static const char *getBitmapName( void *obj, const char *data );
55
56   public:
57      
58      GuiBitmapCtrl();
59      static void initPersistFields();
60
61      void setBitmap(const char *name,bool resize = false);
62      void setBitmapHandle(GFXTexHandle handle, bool resize = false);
63
64      // GuiControl.
65      bool onWake();
66      void onSleep();
67      void inspectPostApply();
68
69      void updateSizing();
70
71      void onRender(Point2I offset, const RectI &updateRect);
72      void setValue(S32 x, S32 y);
73
74      DECLARE_CONOBJECT( GuiBitmapCtrl );
75      DECLARE_CATEGORY( "Gui Images" );
76      DECLARE_DESCRIPTION( "A control that displays a single, static image from a file.\n"
77                           "The bitmap can either be tiled or stretched inside the control." );
78};
79
80#endif
81