src/camera.cpp

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "camera.h"
  21 #include "debug.h"
  22 #include "client.h"
  23 #include "main.h" // for g_settings
  24 #include "map.h"
  25 #include "player.h"
  26 #include <cmath>
  27
  28 const s32 BOBFRAMES = 0x1000000; // must be a power of two
  29
  30 Camera::Camera(scene::ISceneManager* smgr, MapDrawControl& draw_control):
  31         m_smgr(smgr),
  32         m_playernode(NULL),
  33         m_headnode(NULL),
  34         m_cameranode(NULL),
  35         m_draw_control(draw_control),
  36         m_viewing_range_min(5.0),
  37         m_viewing_range_max(5.0),
  38
  39         m_camera_position(0,0,0),
  40         m_camera_direction(0,0,0),
  41
  42         m_aspect(1.0),
  43         m_fov_x(1.0),
  44         m_fov_y(1.0),
  45
  46         m_wanted_frametime(0.0),
  47         m_added_frametime(0),
  48         m_added_frames(0),
  49         m_range_old(0),
  50         m_frametime_old(0),
  51         m_frametime_counter(0),
  52         m_time_per_range(30. / 50), // a sane default of 30ms per 50 nodes of range
  53
  54         m_view_bobbing_anim(0),
  55         m_view_bobbing_state(0),
  56         m_view_bobbing_speed(0)
  57 {
  58         //dstream<<__FUNCTION_NAME<<std::endl;
  59
  60         // note: making the camera node a child of the player node
  61         // would lead to unexpected behaviour, so we don't do that.
  62         m_playernode = smgr->addEmptySceneNode(smgr->getRootSceneNode());
  63         m_headnode = smgr->addEmptySceneNode(m_playernode);
  64         m_cameranode = smgr->addCameraSceneNode(smgr->getRootSceneNode());
  65         m_cameranode->bindTargetAndRotation(true);
  66
  67         updateSettings();
  68 }
  69
  70 Camera::~Camera()
  71 {
  72 }
  73
  74 bool Camera::successfullyCreated(std::wstring& error_message)
  75 {
  76         if (m_playernode == NULL)
  77         {
  78                 error_message = L"Failed to create the player scene node";
  79                 return false;
  80         }
  81         if (m_headnode == NULL)
  82         {
  83                 error_message = L"Failed to create the head scene node";
  84                 return false;
  85         }
  86         if (m_cameranode == NULL)
  87         {
  88                 error_message = L"Failed to create the camera scene node";
  89                 return false;
  90         }
  91         return true;
  92 }
  93
  94 void Camera::step(f32 dtime)
  95 {
  96         if (m_view_bobbing_state != 0)
  97         {
  98                 s32 offset = MYMAX(dtime * m_view_bobbing_speed * 0.035 * BOBFRAMES, 1);
  99                 if (m_view_bobbing_state == 2)
 100                 {
 101                         // Animation is getting turned off
 102                         s32 subanim = (m_view_bobbing_anim & (BOBFRAMES/2-1));
 103                         if (subanim < BOBFRAMES/4)
 104                                 offset = -1 *  MYMIN(offset, subanim);
 105                         else
 106                                 offset = MYMIN(offset, BOBFRAMES/2 - subanim);
 107                 }
 108                 m_view_bobbing_anim = (m_view_bobbing_anim + offset) & (BOBFRAMES-1);
 109         }
 110 }
 111
 112 void Camera::update(LocalPlayer* player, f32 frametime, v2u32 screensize)
 113 {
 114         // Set player node transformation
 115         m_playernode->setPosition(player->getPosition());
 116         m_playernode->setRotation(v3f(0, -1 * player->getYaw(), 0));
 117         m_playernode->updateAbsolutePosition();
 118
 119         // Set head node transformation
 120         v3f eye_offset = player->getEyePosition() - player->getPosition();
 121         m_headnode->setPosition(eye_offset);
 122         m_headnode->setRotation(v3f(player->getPitch(), 0, 0));
 123         m_headnode->updateAbsolutePosition();
 124
 125         // Compute relative camera position and target
 126         v3f rel_cam_pos = v3f(0,0,0);
 127         v3f rel_cam_target = v3f(0,0,1);
 128         v3f rel_cam_up = v3f(0,1,0);
 129
 130         s32 bobframe = m_view_bobbing_anim & (BOBFRAMES/2-1);
 131         if (bobframe != 0)
 132         {
 133                 f32 bobfrac = (f32) bobframe / (BOBFRAMES/2);
 134                 f32 bobdir = (m_view_bobbing_anim < (BOBFRAMES/2)) ? 1.0 : -1.0;
 135
 136                 f32 bobknob = 1.2;
 137                 f32 bobtmp = sin(pow(bobfrac, bobknob) * PI);
 138
 139                 v3f bobvec = v3f(
 140                         0.01 * bobdir * sin(bobfrac * PI),
 141                         0.005 * bobtmp * bobtmp,
 142                         0.);
 143
 144                 rel_cam_pos += bobvec * 3.;
 145                 rel_cam_target += bobvec * 4.5;
 146         }
 147
 148         // Compute absolute camera position and target
 149         m_headnode->getAbsoluteTransformation().transformVect(m_camera_position, rel_cam_pos);
 150         m_headnode->getAbsoluteTransformation().transformVect(m_camera_direction, rel_cam_target);
 151         m_camera_direction -= m_camera_position;
 152
 153         v3f abs_cam_up;
 154         m_headnode->getAbsoluteTransformation().transformVect(abs_cam_up, rel_cam_pos + rel_cam_up);
 155         abs_cam_up -= m_camera_position;
 156
 157         // Set camera node transformation
 158         m_cameranode->setPosition(m_camera_position);
 159         m_cameranode->setUpVector(abs_cam_up);
 160         m_cameranode->setTarget(m_camera_position + m_camera_direction);
 161
 162         // FOV and and aspect ratio
 163         m_aspect = (f32)screensize.X / (f32) screensize.Y;
 164         m_fov_x = 2 * atan(0.5 * m_aspect * tan(m_fov_y));
 165         m_cameranode->setAspectRatio(m_aspect);
 166         m_cameranode->setFOV(m_fov_y);
 167         // Just so big a value that everything rendered is visible
 168         // Some more allowance that m_viewing_range_max * BS because of active objects etc.
 169         m_cameranode->setFarValue(m_viewing_range_max * BS * 10);
 170
 171         // Render distance feedback loop
 172         updateViewingRange(frametime);
 173
 174         // If the player seems to be walking on solid ground,
 175         // view bobbing is enabled and free_move is off,
 176         // start (or continue) the view bobbing animation.
 177         v3f speed = player->getSpeed();
 178         if ((hypot(speed.X, speed.Z) > BS) &&
 179                 (player->touching_ground) &&
 180                 (g_settings.getBool("view_bobbing") == true) &&
 181                 (g_settings.getBool("free_move") == false))
 182         {
 183                 // Start animation
 184                 m_view_bobbing_state = 1;
 185                 m_view_bobbing_speed = MYMIN(speed.getLength(), 40);
 186         }
 187         else if (m_view_bobbing_state == 1)
 188         {
 189                 // Stop animation
 190                 m_view_bobbing_state = 2;
 191                 m_view_bobbing_speed = 100;
 192         }
 193         else if (m_view_bobbing_state == 2 && bobframe == 0)
 194         {
 195                 // Stop animation completed
 196                 m_view_bobbing_state = 0;
 197         }
 198 }
 199
 200 void Camera::updateViewingRange(f32 frametime_in)
 201 {
 202         if (m_draw_control.range_all)
 203                 return;
 204
 205         m_added_frametime += frametime_in;
 206         m_added_frames += 1;
 207
 208         // Actually this counter kind of sucks because frametime is busytime
 209         m_frametime_counter -= frametime_in;
 210         if (m_frametime_counter > 0)
 211                 return;
 212         m_frametime_counter = 0.2;
 213
 214         /*dstream<<__FUNCTION_NAME
 215                         <<": Collected "<<m_added_frames<<" frames, total of "
 216                         <<m_added_frametime<<"s."<<std::endl;
 217
 218         dstream<<"m_draw_control.blocks_drawn="
 219                         <<m_draw_control.blocks_drawn
 220                         <<", m_draw_control.blocks_would_have_drawn="
 221                         <<m_draw_control.blocks_would_have_drawn
 222                         <<std::endl;*/
 223
 224         m_draw_control.wanted_min_range = m_viewing_range_min;
 225         m_draw_control.wanted_max_blocks = (1.5*m_draw_control.blocks_would_have_drawn)+1;
 226         if (m_draw_control.wanted_max_blocks < 10)
 227                 m_draw_control.wanted_max_blocks = 10;
 228
 229         f32 block_draw_ratio = 1.0;
 230         if (m_draw_control.blocks_would_have_drawn != 0)
 231         {
 232                 block_draw_ratio = (f32)m_draw_control.blocks_drawn
 233                         / (f32)m_draw_control.blocks_would_have_drawn;
 234         }
 235
 236         // Calculate the average frametime in the case that all wanted
 237         // blocks had been drawn
 238         f32 frametime = m_added_frametime / m_added_frames / block_draw_ratio;
 239
 240         m_added_frametime = 0.0;
 241         m_added_frames = 0;
 242
 243         f32 wanted_frametime_change = m_wanted_frametime - frametime;
 244         //dstream<<"wanted_frametime_change="<<wanted_frametime_change<<std::endl;
 245
 246         // If needed frametime change is small, just return
 247         if (fabs(wanted_frametime_change) < m_wanted_frametime*0.4)
 248         {
 249                 //dstream<<"ignoring small wanted_frametime_change"<<std::endl;
 250                 return;
 251         }
 252
 253         f32 range = m_draw_control.wanted_range;
 254         f32 new_range = range;
 255
 256         f32 d_range = range - m_range_old;
 257         f32 d_frametime = frametime - m_frametime_old;
 258         if (d_range != 0)
 259         {
 260                 m_time_per_range = d_frametime / d_range;
 261         }
 262
 263         // The minimum allowed calculated frametime-range derivative:
 264         // Practically this sets the maximum speed of changing the range.
 265         // The lower this value, the higher the maximum changing speed.
 266         // A low value here results in wobbly range (0.001)
 267         // A high value here results in slow changing range (0.0025)
 268         // SUGG: This could be dynamically adjusted so that when
 269         //       the camera is turning, this is lower
 270         //f32 min_time_per_range = 0.0015;
 271         f32 min_time_per_range = 0.0010;
 272         //f32 min_time_per_range = 0.05 / range;
 273         if(m_time_per_range < min_time_per_range)
 274         {
 275                 m_time_per_range = min_time_per_range;
 276                 //dstream<<"m_time_per_range="<<m_time_per_range<<" (min)"<<std::endl;
 277         }
 278         else
 279         {
 280                 //dstream<<"m_time_per_range="<<m_time_per_range<<std::endl;
 281         }
 282
 283         f32 wanted_range_change = wanted_frametime_change / m_time_per_range;
 284         // Dampen the change a bit to kill oscillations
 285         //wanted_range_change *= 0.9;
 286         //wanted_range_change *= 0.75;
 287         wanted_range_change *= 0.5;
 288         //dstream<<"wanted_range_change="<<wanted_range_change<<std::endl;
 289
 290         // If needed range change is very small, just return
 291         if(fabs(wanted_range_change) < 0.001)
 292         {
 293                 //dstream<<"ignoring small wanted_range_change"<<std::endl;
 294                 return;
 295         }
 296
 297         new_range += wanted_range_change;
 298
 299         //f32 new_range_unclamped = new_range;
 300         new_range = MYMAX(new_range, m_viewing_range_min);
 301         new_range = MYMIN(new_range, m_viewing_range_max);
 302         /*dstream<<"new_range="<<new_range_unclamped
 303                         <<", clamped to "<<new_range<<std::endl;*/
 304
 305         m_draw_control.wanted_range = new_range;
 306
 307         m_range_old = new_range;
 308         m_frametime_old = frametime;
 309 }
 310
 311 void Camera::updateSettings()
 312 {
 313         m_viewing_range_min = g_settings.getS16("viewing_range_nodes_min");
 314         m_viewing_range_min = MYMAX(5.0, m_viewing_range_min);
 315
 316         m_viewing_range_max = g_settings.getS16("viewing_range_nodes_max");
 317         m_viewing_range_max = MYMAX(m_viewing_range_min, m_viewing_range_max);
 318
 319         f32 fov_degrees = g_settings.getFloat("fov");
 320         fov_degrees = MYMAX(fov_degrees, 10.0);
 321         fov_degrees = MYMIN(fov_degrees, 170.0);
 322         m_fov_y = fov_degrees * PI / 180.0;
 323
 324         f32 wanted_fps = g_settings.getFloat("wanted_fps");
 325         wanted_fps = MYMAX(wanted_fps, 1.0);
 326         m_wanted_frametime = 1.0 / wanted_fps;
 327 }
 328