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   virtual void reset(const Vector& tuxpos);
  55   virtual void reset_kd(const Vector& tuxpos);
  56
  57   /** return camera position */
  58   const Vector& get_translation() const;
  59
  60   virtual void update(float elapsed_time);
  61
  62   virtual void draw(DrawingContext& );
  63
  64   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
  65   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  66
  67   // shake camera in a direction 1 time
  68   void shake(float speed, float x, float y);
  69
  70   void set_scrolling(int scroll_x, int scroll_y)
  71   {
  72     translation.x = scroll_x;
  73     translation.y = scroll_y;
  74   }
  75
  76   /**
  77    * scroll the upper left edge of the camera in scrolltime seconds
  78    * to the position goal
  79    */
  80   void scroll_to(const Vector& goal, float scrolltime);
  81
  82   void reload_config();
  83
  84   enum CameraMode
  85   {
  86     NORMAL, AUTOSCROLL, SCROLLTO, MANUAL
  87   };
  88   CameraMode mode;
  89
  90 private:
  91   void update_scroll_normal(float elapsed_time);
  92   void update_scroll_normal_kd(float elapsed_time);
  93   void update_scroll_normal_exp(float elapsed_time);
  94   void update_scroll_autoscroll(float elapsed_time);
  95   void update_scroll_to(float elapsed_time);
  96   void keep_in_bounds(Vector& vector);
  97   void shake();
  98
  99   enum LeftRightScrollChange
 100   {
 101     NONE, LEFT, RIGHT
 102   };
 103
 104   Vector translation;
 105
 106   Sector* sector;
 107
 108   // normal mode
 109   bool do_backscrolling;
 110   LeftRightScrollChange scrollchange;
 111
 112   // autoscroll mode
 113   std::auto_ptr<Path> autoscroll_path;
 114   std::auto_ptr<PathWalker> autoscroll_walker;
 115
 116   // shaking
 117   Timer shaketimer;
 118   float shakespeed;
 119   float shakedepth_x;
 120   float shakedepth_y;
 121
 122   // scrollto mode
 123   Vector scroll_from;
 124   Vector scroll_goal;
 125   float scroll_to_pos;
 126   float scrollspeed;
 127
 128   CameraConfig *config;
 129 };
 130
 131 #endif /*SUPERTUX_CAMERA_H*/