src/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 "camera.h"
  20
  21 #include <stdexcept>
  22 #include <sstream>
  23 #include <math.h>
  24 #include "lispwriter.h"
  25 #include "player.h"
  26 #include "level.h"
  27 #include "globals.h"
  28
  29 Camera::Camera(Player* newplayer, Level* newlevel)
  30   : player(newplayer), level(newlevel), do_backscrolling(true),
  31     scrollchange(NONE), auto_idx(0), auto_t(0)
  32 {
  33   if(!player || !level)
  34     mode = MANUAL;
  35   else
  36     mode = NORMAL;
  37 }
  38
  39 Camera::~Camera()
  40 {
  41 }
  42
  43 void
  44 Camera::set_translation(const Vector& newtranslation)
  45 {
  46   translation = newtranslation;
  47 }
  48
  49 void
  50 Camera::read(LispReader& reader)
  51 {
  52   std::string modename;
  53
  54   reader.read_string("mode", &modename);
  55   if(modename == "normal") {
  56     mode = NORMAL;
  57
  58     do_backscrolling = true;
  59     reader.read_bool("backscrolling", &do_backscrolling);
  60   } else if(modename == "autoscroll") {
  61     mode = AUTOSCROLL;
  62
  63     lisp_object_t* cur = 0;
  64     reader.read_lisp("path", &cur);
  65     if(cur == 0) {
  66       throw std::runtime_error("No path specified in autoscroll camera.");
  67     }
  68     float speed = .5;
  69     while(!lisp_nil_p(cur)) {
  70       if(strcmp(lisp_symbol(lisp_car(lisp_car(cur))), "point") != 0) {
  71         std::cerr << "Warning: unknown token in camera path.\n";
  72         continue;
  73       }
  74
  75       LispReader reader(lisp_cdr(lisp_car(cur)));
  76
  77       ScrollPoint point;
  78       if(!reader.read_float("x", &point.position.x) ||
  79          !reader.read_float("y", &point.position.y)) {
  80         throw std::runtime_error("x and y missing in point of camerapath");
  81       }
  82       reader.read_float("speed", &speed);
  83       point.speed = speed;
  84       scrollpoints.push_back(point);
  85
  86       cur = lisp_cdr(cur);
  87     }
  88   } else if(modename == "manual") {
  89     mode = MANUAL;
  90   } else {
  91     std::stringstream str;
  92     str << "invalid camera mode '" << modename << "'found in worldfile.";
  93     throw std::runtime_error(str.str());
  94   }
  95 }
  96
  97 void
  98 Camera::write(LispWriter& writer)
  99 {
 100   writer.start_list("camera");
 101
 102   if(mode == NORMAL) {
 103     writer.write_string("mode", "normal");
 104     writer.write_bool("backscrolling", do_backscrolling);
 105   } else if(mode == AUTOSCROLL) {
 106     writer.write_string("mode", "autoscroll");
 107     writer.start_list("path");
 108     for(std::vector<ScrollPoint>::iterator i = scrollpoints.begin();
 109         i != scrollpoints.end(); ++i) {
 110       writer.start_list("point");
 111       writer.write_float("x", i->position.x);
 112       writer.write_float("y", i->position.y);
 113       writer.write_float("speed", i->speed);
 114       writer.end_list("point");
 115     }
 116
 117     writer.end_list("path");
 118   } else if(mode == MANUAL) {
 119     writer.write_string("mode", "manual");
 120   }
 121
 122   writer.end_list("camera");
 123 }
 124
 125 static const float EPSILON = .00001;
 126 static const float max_speed_y = 1.4;
 127
 128 void
 129 Camera::action(float elapsed_time)
 130 {
 131   if(mode == NORMAL)
 132     scroll_normal(elapsed_time);
 133   else if(mode == AUTOSCROLL)
 134     scroll_autoscroll(elapsed_time);
 135 }
 136
 137 void
 138 Camera::keep_in_bounds()
 139 {
 140   // don't scroll before the start or after the level's end
 141   if(translation.y > level->height * 32 - screen->h)
 142     translation.y = level->height * 32 - screen->h;
 143   if(translation.y < 0)
 144     translation.y = 0;
 145   if(translation.x > level->width * 32 - screen->w)
 146     translation.x = level->width * 32 - screen->w;
 147   if(translation.x < 0)
 148     translation.x = 0;
 149 }
 150
 151 void
 152 Camera::scroll_normal(float elapsed_time)
 153 {
 154   assert(level != 0 && player != 0);
 155
 156   // check that we don't have division by zero later
 157   if(elapsed_time < EPSILON)
 158     return;
 159
 160   /****** Vertical Scrolling part ******/
 161   bool do_y_scrolling = true;
 162
 163   if(player->dying || level->height == 19)
 164     do_y_scrolling = false;
 165
 166   if(do_y_scrolling) {
 167     // target_y is the high we target our scrolling at. This is not always the
 168     // high of the player, but if he is jumping upwards we should use the
 169     // position where he last touched the ground.
 170     float target_y;
 171     if(player->fall_mode == Player::JUMPING)
 172       target_y = player->last_ground_y + player->base.height;
 173     else
 174       target_y = player->base.y + player->base.height;
 175
 176     // delta_y is the distance we'd have to travel to directly reach target_y
 177     float delta_y = translation.y - (target_y - screen->h/2);
 178     // speed is the speed the camera would need to reach target_y in this frame
 179     float speed_y = delta_y / elapsed_time;
 180
 181     // limit the camera speed when jumping upwards
 182     if(player->fall_mode != Player::FALLING
 183         && player->fall_mode != Player::TRAMPOLINE_JUMP) {
 184       if(speed_y > max_speed_y)
 185         speed_y = max_speed_y;
 186       else if(speed_y < -max_speed_y)
 187         speed_y = -max_speed_y;
 188     }
 189
 190     // finally scroll with calculated speed
 191     translation.y -= speed_y * elapsed_time;
 192   }
 193
 194   /****** Horizontal scrolling part *******/
 195
 196   // our camera is either in leftscrolling, rightscrolling or nonscrollingmode.
 197
 198   // when suddenly changing directions while scrolling into the other direction.
 199   // abort scrolling, since tux might be going left/right at a relatively small
 200   // part of the map (like when jumping upwards)
 201   if((player->dir == ::LEFT && scrollchange == RIGHT)
 202       || (player->dir == ::RIGHT && scrollchange == LEFT))
 203     scrollchange = NONE;
 204   // when in left 1/3rd of screen scroll left
 205   if(player->base.x < translation.x + screen->w/3 && do_backscrolling)
 206     scrollchange = LEFT;
 207   // scroll right when in right 1/3rd of screen
 208   else if(player->base.x > translation.x + screen->w/3*2)
 209     scrollchange = RIGHT;
 210
 211   // calculate our scroll target depending on scroll mode
 212   float target_x;
 213   if(scrollchange == LEFT)
 214     target_x = player->base.x - screen->w/3*2;
 215   else if(scrollchange == RIGHT)
 216     target_x = player->base.x - screen->w/3;
 217   else
 218     target_x = translation.x;
 219
 220   // that's the distance we would have to travel to reach target_x
 221   float delta_x = translation.x - target_x;
 222   // the speed we'd need to travel to reach target_x in this frame
 223   float speed_x = delta_x / elapsed_time;
 224
 225   // limit our speed
 226   float maxv = 1 + fabsf(player->physic.get_velocity_x() * 1.3);
 227   if(speed_x > maxv)
 228     speed_x = maxv;
 229   else if(speed_x < -maxv)
 230     speed_x = -maxv;
 231
 232   // apply scrolling
 233   translation.x -= speed_x * elapsed_time;
 234
 235   keep_in_bounds();
 236 }
 237
 238 void
 239 Camera::scroll_autoscroll(float elapsed_time)
 240 {
 241   if(player->dying)
 242     return;
 243
 244   if(auto_t - elapsed_time >= 0) {
 245     translation += current_dir * elapsed_time;
 246     auto_t -= elapsed_time;
 247   } else {
 248     // do the rest of the old movement
 249     translation += current_dir * auto_t;
 250     elapsed_time -= auto_t;
 251     auto_t = 0;
 252
 253     // construct path for next point
 254     if(auto_idx+1 >= scrollpoints.size()) {
 255       keep_in_bounds();
 256       return;
 257     }
 258     Vector distance = scrollpoints[auto_idx+1].position
 259                       - scrollpoints[auto_idx].position;
 260     current_dir = distance.unit() * scrollpoints[auto_idx].speed;
 261     auto_t = distance.norm() / scrollpoints[auto_idx].speed;
 262
 263     // do movement for the remaining time
 264     translation += current_dir * elapsed_time;
 265     auto_t -= elapsed_time;
 266     auto_idx++;
 267   }
 268
 269   keep_in_bounds();
 270 }