- updated TODO
[supertux.git] / 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>
23 #include "vector.h"
24 #include "game_object.h"
25 #include "serializable.h"
26 #include <cassert>
27
28 class LispReader;
29 class Sector;
30
31 class Camera : public GameObject, public Serializable
32 {
33 public:
34   Camera(Sector* sector);
35   virtual ~Camera();
36
37   /// parse camera mode from lisp file
38   void read(LispReader& reader);
39   /// write camera mode to a lisp file
40   virtual void write(LispWriter& writer);
41
42   /// reset camera postion
43   virtual void reset(const Vector& tuxpos);
44
45   /** @deprecated@ */
46   const Vector& get_translation() const;
47
48   virtual void action(float elapsed_time);
49
50   virtual void draw(DrawingContext& context)
51   {
52     (void) context;
53   }
54
55   void set_scrolling(int scroll_x, int scroll_y)
56   {
57     translation.x = scroll_x;
58     translation.y = scroll_y;
59   }
60
61   enum CameraMode
62   {
63     NORMAL, AUTOSCROLL, MANUAL
64   };
65   CameraMode mode;
66
67 private:
68   void scroll_normal(float elapsed_time);
69   void scroll_autoscroll(float elapsed_time);
70   void keep_in_bounds();
71
72   enum LeftRightScrollChange
73   {
74     NONE, LEFT, RIGHT
75   };
76     
77   Vector translation;
78
79   Sector* sector;
80
81   // normal mode
82   bool do_backscrolling;
83   LeftRightScrollChange scrollchange;
84
85   // autoscroll mode
86   class ScrollPoint {
87   public:
88     Vector position;
89     float speed;
90   };
91   std::vector<ScrollPoint> scrollpoints;
92   size_t auto_idx;
93   float auto_t;
94   Vector current_dir;
95 };
96
97 #endif
98