guiFadeinBitmapCtrl.h

Engine/source/gui/game/guiFadeinBitmapCtrl.h
Classes:

class
A control that fades a bitmap in and out.
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 _GUIFADEINBITMAPCTRL_H_
25#define _GUIFADEINBITMAPCTRL_H_
26
27#ifndef _GUIBITMAPCTRL_H_
28   #include "gui/controls/guiBitmapCtrl.h"
29#endif
30#ifndef _MEASE_H_
31   #include "math/mEase.h"
32#endif
33
34
35/// A control that fades a bitmap in and out.
36class GuiFadeinBitmapCtrl : public GuiBitmapCtrl
37{
38   public:
39   
40      typedef GuiBitmapCtrl Parent;
41      
42   protected:
43   
44      /// Color we fade in from and fade out to.
45      LinearColorF mFadeColor;
46      
47      /// Reference time on which to base all fade timings.
48      U32 mStartTime;
49      
50      /// Milliseconds for bitmap to fade in.
51      U32 mFadeInTime;
52      
53      /// Milliseconds to wait before fade-out.
54      U32 mWaitTime;
55      
56      /// Milliseconds for bitmap to fade out.
57      U32 mFadeOutTime;
58      
59      /// Easing curve for fade-in.
60      EaseF mFadeInEase;
61      
62      /// Easing curve for fade-out.
63      EaseF mFadeOutEase;
64
65      /// Whether the fade cycle has run completely.
66      bool mDone;
67
68   public:
69
70      GuiFadeinBitmapCtrl();
71
72      // GuiControl.
73      virtual void onPreRender();
74      virtual void onMouseDown(const GuiEvent &);
75      virtual bool onKeyDown(const GuiEvent &);
76      virtual bool onGamepadButtonDown(const GuiEvent& event);
77      virtual bool onWake();
78      virtual void onRender(Point2I offset, const RectI &updateRect);
79      
80      static void initPersistFields();
81
82      DECLARE_CONOBJECT( GuiFadeinBitmapCtrl );
83      DECLARE_DESCRIPTION( "A control that shows a bitmap.  It fades the bitmap in a set amount of time,\n"
84                           "then waits a set amount of time, and finally fades the bitmap back out in\n"
85                           "another set amount of time." );
86
87     DECLARE_CALLBACK( void, click, ());
88     DECLARE_CALLBACK( void, onDone, ());
89};
90
91#endif // !_GUIFADEINBITMAPCTRL_H_
92