guiAnimBitmapCtrl.h

Engine/source/gui/controls/guiAnimBitmapCtrl.h
Classes:

class
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 _GUIANIMBITMAPCTRL_H_
25#define _GUIANIMBITMAPCTRL_H_
26
27#ifndef _GUIBITMAPCTRL_H_
28#include "gui/controls/guiBitmapCtrl.h"
29#endif
30
31class guiAnimBitmapCtrl : public GuiBitmapCtrl
32{
33public:
34   typedef GuiBitmapCtrl Parent;
35
36protected:
37   /// max frames (x,y)
38   Point2I           mAnimTexTiling;
39   /// frames to use
40   StringTableEntry  mAnimTexFramesString;
41   /// frames to use (internal)
42   Vector<S32>       mAnimTexFrames;
43   U32               mNumFrames;
44   S32               mCurFrameIndex;
45
46   bool              mLoop;
47   bool              mPlay;
48   bool              mReverse;
49   S32               mFramesPerSec;
50   bool              mAnimateTexture;
51   PlatformTimer *   mFrameTime;
52   bool              mFinished;
53   static bool ptSetFrame(void *object, const char *index, const char *data);
54   static bool ptSetFrameRanges(void *object, const char *index, const char *data);
55public:
56   guiAnimBitmapCtrl();
57   ~guiAnimBitmapCtrl();
58   bool onAdd();
59
60   static void initPersistFields();
61   void onRender(Point2I offset, const RectI &updateRect);
62   DECLARE_CONOBJECT(guiAnimBitmapCtrl);
63   DECLARE_CATEGORY("Gui Images");
64   DECLARE_DESCRIPTION("A control that clips a bitmap based on %.");
65
66   DECLARE_CALLBACK(void, onLoop, ());
67   DECLARE_CALLBACK(void, onCompleted, ());
68   DECLARE_CALLBACK(void, onFrame, (S32 frameIndex, S32 frame));
69};
70
71#endif
72