~ubuntu-branches/ubuntu/natty/balder2d/natty

« back to all changes in this revision

Viewing changes to include/menu/widgets/animation.h

  • Committer: Bazaar Package Importer
  • Author(s): Bjørn Hansen
  • Date: 2008-06-15 17:15:38 UTC
  • mfrom: (1.1.1 upstream) (3.1.2 hardy)
  • Revision ID: james.westby@ubuntu.com-20080615171538-e407e07wbtdy0qs8
Tags: 1.0-1
* new upstream release
* update for guichan 8.1 (Closes: #482584)
* use physicsfs to make data/config/map/aiscript loading more flexible
* new skins for menus
* fix typo in control file long description (Closes: #458401)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/***************************************************************************
 
2
 *   Copyright (C) 2006 by Bjorn Hansen                                    *
 
3
 *   holomorph@users.sourceforge.net                                       *
 
4
 *                                                                         *
 
5
 *   This program is free software; you can redistribute it and/or modify  *
 
6
 *   it under the terms of the GNU General Public License as published by  *
 
7
 *   the Free Software Foundation; either version 2 of the License, or     *
 
8
 *   (at your option) any later version.                                   *
 
9
 *                                                                         *
 
10
 *   This program is distributed in the hope that it will be useful,       *
 
11
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 
12
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 
13
 *   GNU General Public License for more details.                          *
 
14
 *                                                                         *
 
15
 *   You should have received a copy of the GNU General Public License     *
 
16
 *   along with this program; if not, write to the                         *
 
17
 *   Free Software Foundation, Inc.,                                       *
 
18
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 
19
 ***************************************************************************/
 
20
 
 
21
#ifndef BALDERANIMATION_H
 
22
#define BALDERANIMATION_H
 
23
 
 
24
#include <guichan/image.hpp>
 
25
#include <guichan/widget.hpp>
 
26
#include "../../balder2dtypes.h"
 
27
 
 
28
namespace Balder
 
29
{
 
30
    /**
 
31
     * An Icon for displaying an animated image.
 
32
     */
 
33
    class Animation: public gcn::Widget
 
34
    {
 
35
    public:
 
36
        // Constructor and Destructor.
 
37
        Animation(std::string, bool, bool, bool, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int);
 
38
        ~Animation();
 
39
 
 
40
        // Controls whether or not there is a base frame in the animation background.
 
41
        void setAnimationHasBaseFrame(bool aHBF) { animationHasBaseFrame = aHBF; }
 
42
        const bool getAnimationHasBaseFrame() { return animationHasBaseFrame; }
 
43
 
 
44
        // Controls loop feature for playback.
 
45
        void setAnimationLooped(bool aL) { animationLooped = aL; }
 
46
        const bool getAnimationLooped() { return animationLooped; }
 
47
 
 
48
        // Playback control.
 
49
        const bool getAnimationPlaying() { return animationPlaying; }  // Chacks to see if animation is currently playing.
 
50
        void Play();  // Starts to play animation from frameCurrent.
 
51
        void Stop() { animationPlaying = false; }  // Stops playing animation at frameCurrent.
 
52
        void Restart();  // Resets frameCurrent to frameStart and then starts playing animation.
 
53
 
 
54
        // Animates next frame if playing.
 
55
        void Animate();
 
56
 
 
57
        // Inherited from gcn::Widget
 
58
        virtual void draw(gcn::Graphics* graphics);
 
59
 
 
60
    private:
 
61
        // Animation Variables.
 
62
        SDL_Surface* animationFrameStrip;
 
63
        std::string animationFileName;
 
64
        bool animationHasBaseFrame;
 
65
        bool animationLooped;
 
66
        bool animationPlaying;
 
67
        unsigned int animationStripLocation;
 
68
 
 
69
        // Frame Variables.
 
70
        unsigned int frameWidth;
 
71
        unsigned int frameHeight;
 
72
        unsigned int frameBase;
 
73
        unsigned int frameStart;
 
74
        unsigned int frameQuantity;
 
75
        unsigned int frameInterval;
 
76
        unsigned int frameCurrent;
 
77
        Uint32 frameTimer;
 
78
    };
 
79
}
 
80
 
 
81
#endif  // BALDERANIMATION_H