src/camera.h

   1 //  $Id$
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 Matthias Braun <matze@braunis.de
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19 #ifndef __VIEWPORT_H__
  20 #define __VIEWPORT_H__
  21
  22 #include "vector.h"
  23 #include "game_object.h"
  24 #include "serializable.h"
  25 #include <cassert>
  26
  27 class LispReader;
  28 class Player;
  29 class Level;
  30
  31 class Camera : public GameObject, public Serializable
  32 {
  33 public:
  34   Camera(Player* player = 0, Level* level = 0);
  35   virtual ~Camera();
  36
  37   /** transforms a coordinate in world space to screen space.
  38    * Basically you have to apply this function to each coordinate that you want
  39    * to display on screen.
  40    */
  41   Vector world2screen(const Vector& worldpos) const
  42   {
  43     return worldpos - translation;
  44   }
  45
  46   /// parse camera mode from lisp file
  47   void parse_camera(LispReader& reader);
  48   /// write camera mode to a lisp file
  49   virtual void write(LispWriter& writer);
  50
  51   /** returns the current translation (=scroll) vector of the viewport */
  52   const Vector& get_translation() const
  53   { return translation; }
  54   /** set the curren translation vector of the viewport */
  55   void set_translation(const Vector& translation);
  56
  57   virtual void action(float elapsed_time);
  58
  59   enum CameraMode
  60   {
  61     NORMAL, AUTOSCROLL, MANUAL
  62   };
  63
  64 private:
  65   void scroll_normal(float elapsed_time);
  66   void scroll_autoscroll(float elapsed_time);
  67
  68   enum LeftRightScrollChange
  69   {
  70     NONE, LEFT, RIGHT
  71   };
  72
  73   Vector translation;
  74
  75   Player* player;
  76   Level* level;
  77   CameraMode mode;
  78
  79   // normal mode
  80   LeftRightScrollChange scrollchange;
  81
  82   // autoscroll mode
  83 };
  84
  85 #endif
  86