- More work on scripting interface
[supertux.git] / src / object / camera.cpp
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 #include <config.h>
20
21 #include <stdexcept>
22 #include <sstream>
23 #include <cmath>
24
25 #include "lisp/lisp.h"
26 #include "lisp/writer.h"
27 #include "lisp/list_iterator.h"
28 #include "camera.h"
29 #include "player.h"
30 #include "tilemap.h"
31 #include "game_session.h"
32 #include "sector.h"
33 #include "main.h"
34 #include "object_factory.h"
35
36 Camera::Camera(Sector* newsector)
37   : sector(newsector), do_backscrolling(true), scrollchange(NONE),
38     auto_idx(0), auto_t(0)
39 {
40   mode = NORMAL;
41 }
42
43 Camera::~Camera()
44 {
45 }
46
47 const Vector&
48 Camera::get_translation() const
49 {
50   return translation;
51 }
52
53 void
54 Camera::parse(const lisp::Lisp& reader)
55 {
56   std::string modename;
57   
58   reader.get("mode", modename);
59   if(modename == "normal") {
60     mode = NORMAL;
61
62     do_backscrolling = true;
63     reader.get("backscrolling", do_backscrolling);
64   } else if(modename == "autoscroll") {
65     printf("autoscroll.\n");
66     mode = AUTOSCROLL;
67     
68     const lisp::Lisp* path_lisp = reader.get_lisp("path");
69     if(!path_lisp)
70       throw std::runtime_error("No path specified in autoscroll camera.");
71
72     lisp::ListIterator iter(path_lisp);
73     float speed = .5;
74     while(iter.next()) {
75       if(iter.item() != "point") {
76         std::cerr << "Warning: unknown token '" << iter.item() 
77           << "' in camera path.\n";
78         continue;
79       }
80       const lisp::Lisp* point_lisp = iter.lisp();
81
82       ScrollPoint point;
83       if(!point_lisp->get("x", point.position.x) ||
84          !point_lisp->get("y", point.position.y)) {
85         throw std::runtime_error("x and y missing in point of camerapath");
86       }
87       point_lisp->get("speed", speed);
88       point.speed = speed;
89       scrollpoints.push_back(point);
90     }
91   } else if(modename == "manual") {
92     mode = MANUAL;
93   } else {
94     std::stringstream str;
95     str << "invalid camera mode '" << modename << "'found in worldfile.";
96     throw std::runtime_error(str.str());
97   }
98 }
99
100 void
101 Camera::write(lisp::Writer& writer)
102 {
103   writer.start_list("camera");
104   
105   if(mode == NORMAL) {
106     writer.write_string("mode", "normal");
107     writer.write_bool("backscrolling", do_backscrolling);
108   } else if(mode == AUTOSCROLL) {
109     writer.write_string("mode", "autoscroll");
110     writer.start_list("path");
111     for(std::vector<ScrollPoint>::iterator i = scrollpoints.begin();
112         i != scrollpoints.end(); ++i) {
113       writer.start_list("point");
114       writer.write_float("x", i->position.x);
115       writer.write_float("y", i->position.y);
116       writer.write_float("speed", i->speed);
117       writer.end_list("point");
118     }
119
120     writer.end_list("path");
121   } else if(mode == MANUAL) {
122     writer.write_string("mode", "manual");
123   }
124                      
125   writer.end_list("camera");
126 }
127
128 void
129 Camera::reset(const Vector& tuxpos)
130 {
131   translation.x = tuxpos.x - SCREEN_WIDTH/3 * 2;
132   translation.y = tuxpos.y - SCREEN_HEIGHT/2;
133   shakespeed = 0;
134   shaketimer.stop();
135   keep_in_bounds();
136 }
137
138 void
139 Camera::shake(float time, float x, float y)
140 {
141   shaketimer.start(time);
142   shakedepth_x = x;
143   shakedepth_y = y;
144   shakespeed = M_PI/2 / time;
145 }
146
147 static const float EPSILON = .00001;
148 static const float max_speed_y = 140;
149
150 void
151 Camera::action(float elapsed_time)
152 {
153   if(mode == NORMAL)
154     scroll_normal(elapsed_time);
155   else if(mode == AUTOSCROLL)
156     scroll_autoscroll(elapsed_time);
157 }
158
159 void
160 Camera::keep_in_bounds()
161 {
162   float width = sector->solids->get_width() * 32;
163   float height = sector->solids->get_height() * 32;
164
165   // don't scroll before the start or after the level's end
166   if(translation.y > height - SCREEN_HEIGHT)
167     translation.y = height - SCREEN_HEIGHT;
168   if(translation.y < 0)                                      
169     translation.y = 0; 
170   if(translation.x > width - SCREEN_WIDTH)
171     translation.x = width - SCREEN_WIDTH;
172   if(translation.x < 0)
173     translation.x = 0;                                         
174 }
175
176 void
177 Camera::shake()
178 {
179   if(shaketimer.started()) {
180     translation.x -= sin(shaketimer.get_timegone() * shakespeed) * shakedepth_x;
181     translation.y -= sin(shaketimer.get_timegone() * shakespeed) * shakedepth_y;
182   }
183 }
184
185 void
186 Camera::scroll_normal(float elapsed_time)
187 {
188   assert(sector != 0);
189   Player* player = sector->player;
190   
191   // check that we don't have division by zero later
192   if(elapsed_time < EPSILON)
193     return;
194
195   /****** Vertical Scrolling part ******/
196   bool do_y_scrolling = true;
197
198   if(player->is_dying() || sector->solids->get_height() == 19)
199     do_y_scrolling = false;
200
201   if(do_y_scrolling) {
202     // target_y is the high we target our scrolling at. This is not always the
203     // high of the player, but if he is jumping upwards we should use the
204     // position where he last touched the ground. (this probably needs
205     // exceptions for trampolines and similar things in the future)
206     float target_y;
207     if(player->fall_mode == Player::JUMPING)
208       target_y = player->last_ground_y + player->get_bbox().get_height();
209     else
210       target_y = player->get_bbox().p2.y;
211
212     // delta_y is the distance we'd have to travel to directly reach target_y
213     float delta_y = translation.y - (target_y - SCREEN_HEIGHT/2);
214     // speed is the speed the camera would need to reach target_y in this frame
215     float speed_y = delta_y / elapsed_time;
216
217     // limit the camera speed when jumping upwards
218     if(player->fall_mode != Player::FALLING 
219         && player->fall_mode != Player::TRAMPOLINE_JUMP) {
220       if(speed_y > max_speed_y)
221         speed_y = max_speed_y;
222       else if(speed_y < -max_speed_y)
223         speed_y = -max_speed_y;
224     }
225
226     // finally scroll with calculated speed
227     translation.y -= speed_y * elapsed_time;
228   }
229
230   /****** Horizontal scrolling part *******/
231
232   // our camera is either in leftscrolling, rightscrolling or nonscrollingmode.
233   
234   // when suddenly changing directions while scrolling into the other direction.
235   // abort scrolling, since tux might be going left/right at a relatively small
236   // part of the map (like when jumping upwards)
237   if((player->dir == ::LEFT && scrollchange == RIGHT)
238       || (player->dir == ::RIGHT && scrollchange == LEFT))
239     scrollchange = NONE;
240   // when in left 1/3rd of screen scroll left
241   if(player->get_bbox().get_middle().x < translation.x + SCREEN_WIDTH/3 - 16
242       && do_backscrolling)
243     scrollchange = LEFT;
244   // scroll right when in right 1/3rd of screen
245   else if(player->get_bbox().get_middle().x > translation.x + SCREEN_WIDTH/3*2+16)
246     scrollchange = RIGHT;
247
248   // calculate our scroll target depending on scroll mode
249   float target_x;
250   if(scrollchange == LEFT)
251     target_x = player->get_bbox().get_middle().x - SCREEN_WIDTH/3*2;
252   else if(scrollchange == RIGHT)
253     target_x = player->get_bbox().get_middle().x - SCREEN_WIDTH/3;
254   else
255     target_x = translation.x;
256
257   // that's the distance we would have to travel to reach target_x
258   float delta_x = translation.x - target_x;
259   // the speed we'd need to travel to reach target_x in this frame
260   float speed_x = delta_x / elapsed_time;
261
262   // limit our speed
263   float maxv = 130 + (fabsf(player->physic.get_velocity_x() * 1.3));
264   if(speed_x > maxv)
265     speed_x = maxv;
266   else if(speed_x < -maxv)
267     speed_x = -maxv;
268  
269   // apply scrolling
270   translation.x -= speed_x * elapsed_time;
271
272   keep_in_bounds();
273   shake();
274 }
275
276 void
277 Camera::scroll_autoscroll(float elapsed_time)
278 {
279   Player* player = sector->player;
280   
281   if(player->is_dying())
282     return;
283
284   if(auto_t - elapsed_time >= 0) {
285     translation += current_dir * elapsed_time;
286     auto_t -= elapsed_time;
287   } else {
288     // do the rest of the old movement
289     translation += current_dir * auto_t;
290     elapsed_time -= auto_t;
291     auto_t = 0;
292
293     // construct path for next point
294     if(auto_idx+1 >= scrollpoints.size()) {
295       keep_in_bounds();
296       return;
297     }
298     Vector distance = scrollpoints[auto_idx+1].position 
299                       - scrollpoints[auto_idx].position;
300     current_dir = distance.unit() * scrollpoints[auto_idx].speed;
301     auto_t = distance.norm() / scrollpoints[auto_idx].speed;
302
303     // do movement for the remaining time
304     translation += current_dir * elapsed_time;
305     auto_t -= elapsed_time;
306     auto_idx++;
307   }
308
309   keep_in_bounds();
310   shake();
311 }
312