src/object/camera.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 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 SUPERTUX_CAMERA_H
  20 #define SUPERTUX_CAMERA_H
  21
  22 #include <vector>
  23 #include <cassert>
  24 #include <memory>
  25
  26 #include "math/vector.hpp"
  27 #include "game_object.hpp"
  28 #include "video/drawing_context.hpp"
  29 #include "serializable.hpp"
  30 #include "timer.hpp"
  31 #include "script_interface.hpp"
  32
  33 namespace lisp {
  34 class Lisp;
  35 }
  36
  37 class Sector;
  38 class Path;
  39 class PathWalker;
  40 class CameraConfig;
  41
  42 class Camera : public GameObject, public Serializable, public ScriptInterface
  43 {
  44 public:
  45   Camera(Sector* sector, std::string name = "");
  46   virtual ~Camera();
  47
  48   /// parse camera mode from lisp file
  49   void parse(const lisp::Lisp& reader);
  50   /// write camera mode to a lisp file
  51   virtual void write(lisp::Writer& writer);
  52
  53   /// reset camera postion
  54   void reset(const Vector& tuxpos);
  55
  56   /** return camera position */
  57   const Vector& get_translation() const;
  58
  59   virtual void update(float elapsed_time);
  60
  61   virtual void draw(DrawingContext& );
  62
  63   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
  64   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  65
  66   // shake camera in a direction 1 time
  67   void shake(float speed, float x, float y);
  68
  69   void set_scrolling(int scroll_x, int scroll_y)
  70   {
  71     translation.x = scroll_x;
  72     translation.y = scroll_y;
  73   }
  74
  75   /**
  76    * scroll the upper left edge of the camera in scrolltime seconds
  77    * to the position goal
  78    */
  79   void scroll_to(const Vector& goal, float scrolltime);
  80
  81   void reload_config();
  82
  83   enum CameraMode
  84   {
  85     NORMAL, AUTOSCROLL, SCROLLTO, MANUAL
  86   };
  87   CameraMode mode;
  88
  89 private:
  90   void update_scroll_normal(float elapsed_time);
  91   void update_scroll_autoscroll(float elapsed_time);
  92   void update_scroll_to(float elapsed_time);
  93   void keep_in_bounds(Vector& vector);
  94   void shake();
  95
  96   /**
  97    * The camera basically provides lookeahead on the left or right side
  98    * or is undecided.
  99    */
 100   enum LookaheadMode {
 101     LOOKAHEAD_NONE, LOOKAHEAD_LEFT, LOOKAHEAD_RIGHT
 102   };
 103
 104   Vector translation;
 105
 106   Sector* sector;
 107
 108   // normal mode
 109   LookaheadMode lookahead_mode;
 110   float changetime;
 111   float lookahead_pos;
 112
 113   // autoscroll mode
 114   std::auto_ptr<Path> autoscroll_path;
 115   std::auto_ptr<PathWalker> autoscroll_walker;
 116
 117   // shaking
 118   Timer shaketimer;
 119   float shakespeed;
 120   float shakedepth_x;
 121   float shakedepth_y;
 122
 123   // scrollto mode
 124   Vector scroll_from;
 125   Vector scroll_goal;
 126   float scroll_to_pos;
 127   float scrollspeed;
 128
 129   CameraConfig *config;
 130 };
 131
 132 #endif /*SUPERTUX_CAMERA_H*/