git.sesse.net Git - vlc/blob - modules/gui/skins2/src/anim_bitmap.hpp

   1 /*****************************************************************************
   2  * anim_bitmap.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef ANIM_BITMAP_HPP
  25 #define ANIM_BITMAP_HPP
  26
  27 #include "../commands/cmd_generic.hpp"
  28 #include "../utils/observer.hpp"
  29 #include "../utils/position.hpp"
  30
  31 class GenericBitmap;
  32 class OSGraphics;
  33 class OSTimer;
  34
  35
  36 /// Animated bitmap
  37 class AnimBitmap: public SkinObject, public Box,
  38                   public Subject<AnimBitmap>
  39 {
  40     public:
  41         AnimBitmap( intf_thread_t *pIntf, const GenericBitmap &rBitmap );
  42
  43         virtual ~AnimBitmap();
  44
  45         /// Start the animation
  46         void startAnim();
  47
  48         /// Stop the animation
  49         void stopAnim();
  50
  51         /// Draw the current frame on another graphics
  52         void draw( OSGraphics &rImage, int xDest, int yDest );
  53
  54         /// Tell whether the pixel at the given position is visible
  55         bool hit( int x, int y ) const;
  56
  57         /// Get the size of the current frame
  58         virtual int getWidth() const;
  59         virtual int getHeight() const;
  60
  61     private:
  62         /// Graphics to store the bitmap
  63         OSGraphics *m_pImage;
  64         /// Number of frames
  65         int m_nbFrames;
  66         /// Frame rate
  67         int m_frameRate;
  68         /// Curent frame
  69         int m_curFrame;
  70          /// Timer for the animation
  71         OSTimer *m_pTimer;
  72
  73         /// Callback for the timer
  74         DEFINE_CALLBACK( AnimBitmap, NextFrame );
  75 };
  76
  77
  78 #endif
  79