VFadeControl.h

Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef _VT_VFADECONTROL_H_
25#define _VT_VFADECONTROL_H_
26
27#ifndef _GUICONTROL_H_
28#include "gui/core/guiControl.h"
29#endif
30
31//-----------------------------------------------------------------------------
32
33class VFadeControl : public GuiControl
34{
35    typedef GuiControl Parent;
36
37public:
38
39    enum eFadeType
40    {
41        k_TypeIn,
42        k_TypeOut,
43
44        k_TypeInvalid,
45    };
46
47    bool            mActive;
48    eFadeType       mFadeType;
49
50    S32             mElapsedTime;
51    S32             mDuration;
52    S32             mLastTime;
53    
54public:
55
56    VFadeControl( void );
57
58    // Render Methods.
59
60    virtual void    onRender( Point2I pOffset, const RectI &pUpdateRect );
61
62    // Console Declaration.
63
64    DECLARE_CONOBJECT( VFadeControl );
65
66public:
67
68    void            start( eFadeType pType, S32 pDuration );
69    void            pause( void );
70};
71
72//-----------------------------------------------------------------------------
73
74#endif // _VT_VFADECONTROL_H_
75