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 "mesh.h"
  26 #include "player.h"
  27 #include "tile.h"
  28 #include <cmath>
  29 #include "settings.h"
  30 #include "itemdef.h" // For wield visualization
  31
  32 Camera::Camera(scene::ISceneManager* smgr, MapDrawControl& draw_control):
  33         m_smgr(smgr),
  34         m_playernode(NULL),
  35         m_headnode(NULL),
  36         m_cameranode(NULL),
  37
  38         m_wieldmgr(NULL),
  39         m_wieldnode(NULL),
  40         m_wieldlight(0),
  41
  42         m_draw_control(draw_control),
  43         m_viewing_range_min(5.0),
  44         m_viewing_range_max(5.0),
  45
  46         m_camera_position(0,0,0),
  47         m_camera_direction(0,0,0),
  48
  49         m_aspect(1.0),
  50         m_fov_x(1.0),
  51         m_fov_y(1.0),
  52
  53         m_wanted_frametime(0.0),
  54         m_added_frametime(0),
  55         m_added_frames(0),
  56         m_range_old(0),
  57         m_frametime_old(0),
  58         m_frametime_counter(0),
  59         m_time_per_range(30. / 50), // a sane default of 30ms per 50 nodes of range
  60
  61         m_view_bobbing_anim(0),
  62         m_view_bobbing_state(0),
  63         m_view_bobbing_speed(0),
  64
  65         m_digging_anim(0),
  66         m_digging_button(-1)
  67 {
  68         //dstream<<__FUNCTION_NAME<<std::endl;
  69
  70         // note: making the camera node a child of the player node
  71         // would lead to unexpected behaviour, so we don't do that.
  72         m_playernode = smgr->addEmptySceneNode(smgr->getRootSceneNode());
  73         m_headnode = smgr->addEmptySceneNode(m_playernode);
  74         m_cameranode = smgr->addCameraSceneNode(smgr->getRootSceneNode());
  75         m_cameranode->bindTargetAndRotation(true);
  76
  77         // This needs to be in its own scene manager. It is drawn after
  78         // all other 3D scene nodes and before the GUI.
  79         m_wieldmgr = smgr->createNewSceneManager();
  80         m_wieldmgr->addCameraSceneNode();
  81         m_wieldnode = m_wieldmgr->addMeshSceneNode(createCubeMesh(v3f(1,1,1)), NULL);  // need a dummy mesh
  82
  83         updateSettings();
  84 }
  85
  86 Camera::~Camera()
  87 {
  88         m_wieldnode->setMesh(NULL);
  89         m_wieldmgr->drop();
  90 }
  91
  92 bool Camera::successfullyCreated(std::wstring& error_message)
  93 {
  94         if (m_playernode == NULL)
  95         {
  96                 error_message = L"Failed to create the player scene node";
  97                 return false;
  98         }
  99         if (m_headnode == NULL)
 100         {
 101                 error_message = L"Failed to create the head scene node";
 102                 return false;
 103         }
 104         if (m_cameranode == NULL)
 105         {
 106                 error_message = L"Failed to create the camera scene node";
 107                 return false;
 108         }
 109         if (m_wieldmgr == NULL)
 110         {
 111                 error_message = L"Failed to create the wielded item scene manager";
 112                 return false;
 113         }
 114         if (m_wieldnode == NULL)
 115         {
 116                 error_message = L"Failed to create the wielded item scene node";
 117                 return false;
 118         }
 119         return true;
 120 }
 121
 122 // Returns the fractional part of x
 123 inline f32 my_modf(f32 x)
 124 {
 125         double dummy;
 126         return modf(x, &dummy);
 127 }
 128
 129 void Camera::step(f32 dtime)
 130 {
 131         if (m_view_bobbing_state != 0)
 132         {
 133                 //f32 offset = dtime * m_view_bobbing_speed * 0.035;
 134                 f32 offset = dtime * m_view_bobbing_speed * 0.030;
 135                 if (m_view_bobbing_state == 2)
 136                 {
 137 #if 0
 138                         // Animation is getting turned off
 139                         if (m_view_bobbing_anim < 0.5)
 140                                 m_view_bobbing_anim -= offset;
 141                         else
 142                                 m_view_bobbing_anim += offset;
 143                         if (m_view_bobbing_anim <= 0 || m_view_bobbing_anim >= 1)
 144                         {
 145                                 m_view_bobbing_anim = 0;
 146                                 m_view_bobbing_state = 0;
 147                         }
 148 #endif
 149 #if 1
 150                         // Animation is getting turned off
 151                         if(m_view_bobbing_anim < 0.25){
 152                                 m_view_bobbing_anim -= offset;
 153                         } else if(m_view_bobbing_anim > 0.75){
 154                                 m_view_bobbing_anim += offset;
 155                         } if(m_view_bobbing_anim < 0.5){
 156                                 m_view_bobbing_anim += offset;
 157                                 if(m_view_bobbing_anim > 0.5)
 158                                         m_view_bobbing_anim = 0.5;
 159                         } else {
 160                                 m_view_bobbing_anim -= offset;
 161                                 if(m_view_bobbing_anim < 0.5)
 162                                         m_view_bobbing_anim = 0.5;
 163                         }
 164                         if(m_view_bobbing_anim <= 0 || m_view_bobbing_anim >= 1 ||
 165                                         fabs(m_view_bobbing_anim - 0.5) < 0.01)
 166                         {
 167                                 m_view_bobbing_anim = 0;
 168                                 m_view_bobbing_state = 0;
 169                         }
 170 #endif
 171                 }
 172                 else
 173                 {
 174                         m_view_bobbing_anim = my_modf(m_view_bobbing_anim + offset);
 175                 }
 176         }
 177
 178         if (m_digging_button != -1)
 179         {
 180                 f32 offset = dtime * 3.5;
 181                 m_digging_anim += offset;
 182                 if (m_digging_anim >= 1)
 183                 {
 184                         m_digging_anim = 0;
 185                         m_digging_button = -1;
 186                 }
 187         }
 188 }
 189
 190 void Camera::update(LocalPlayer* player, f32 frametime, v2u32 screensize)
 191 {
 192         // Set player node transformation
 193         m_playernode->setPosition(player->getPosition());
 194         m_playernode->setRotation(v3f(0, -1 * player->getYaw(), 0));
 195         m_playernode->updateAbsolutePosition();
 196
 197         // Set head node transformation
 198         m_headnode->setPosition(player->getEyeOffset());
 199         m_headnode->setRotation(v3f(player->getPitch(), 0, 0));
 200         m_headnode->updateAbsolutePosition();
 201
 202         // Compute relative camera position and target
 203         v3f rel_cam_pos = v3f(0,0,0);
 204         v3f rel_cam_target = v3f(0,0,1);
 205         v3f rel_cam_up = v3f(0,1,0);
 206
 207         if (m_view_bobbing_anim != 0)
 208         {
 209                 f32 bobfrac = my_modf(m_view_bobbing_anim * 2);
 210                 f32 bobdir = (m_view_bobbing_anim < 0.5) ? 1.0 : -1.0;
 211
 212                 #if 1
 213                 f32 bobknob = 1.2;
 214                 f32 bobtmp = sin(pow(bobfrac, bobknob) * PI);
 215                 //f32 bobtmp2 = cos(pow(bobfrac, bobknob) * PI);
 216
 217                 v3f bobvec = v3f(
 218                         0.3 * bobdir * sin(bobfrac * PI),
 219                         -0.28 * bobtmp * bobtmp,
 220                         0.);
 221
 222                 //rel_cam_pos += 0.2 * bobvec;
 223                 //rel_cam_target += 0.03 * bobvec;
 224                 //rel_cam_up.rotateXYBy(0.02 * bobdir * bobtmp * PI);
 225                 float f = 1.0;
 226                 f *= g_settings->getFloat("view_bobbing_amount");
 227                 rel_cam_pos += bobvec * f;
 228                 //rel_cam_target += 0.995 * bobvec * f;
 229                 rel_cam_target += bobvec * f;
 230                 rel_cam_target.Z -= 0.005 * bobvec.Z * f;
 231                 //rel_cam_target.X -= 0.005 * bobvec.X * f;
 232                 //rel_cam_target.Y -= 0.005 * bobvec.Y * f;
 233                 rel_cam_up.rotateXYBy(-0.03 * bobdir * bobtmp * PI * f);
 234                 #else
 235                 f32 angle_deg = 1 * bobdir * sin(bobfrac * PI);
 236                 f32 angle_rad = angle_deg * PI / 180;
 237                 f32 r = 0.05;
 238                 v3f off = v3f(
 239                         r * sin(angle_rad),
 240                         r * (cos(angle_rad) - 1),
 241                         0);
 242                 rel_cam_pos += off;
 243                 //rel_cam_target += off;
 244                 rel_cam_up.rotateXYBy(angle_deg);
 245                 #endif
 246
 247         }
 248
 249         // Compute absolute camera position and target
 250         m_headnode->getAbsoluteTransformation().transformVect(m_camera_position, rel_cam_pos);
 251         m_headnode->getAbsoluteTransformation().rotateVect(m_camera_direction, rel_cam_target - rel_cam_pos);
 252
 253         v3f abs_cam_up;
 254         m_headnode->getAbsoluteTransformation().rotateVect(abs_cam_up, rel_cam_up);
 255
 256         // Set camera node transformation
 257         m_cameranode->setPosition(m_camera_position);
 258         m_cameranode->setUpVector(abs_cam_up);
 259         // *100.0 helps in large map coordinates
 260         m_cameranode->setTarget(m_camera_position + 100 * m_camera_direction);
 261
 262         // FOV and and aspect ratio
 263         m_aspect = (f32)screensize.X / (f32) screensize.Y;
 264         m_fov_x = 2 * atan(0.5 * m_aspect * tan(m_fov_y));
 265         m_cameranode->setAspectRatio(m_aspect);
 266         m_cameranode->setFOV(m_fov_y);
 267         // Just so big a value that everything rendered is visible
 268         // Some more allowance that m_viewing_range_max * BS because of active objects etc.
 269         m_cameranode->setFarValue(m_viewing_range_max * BS * 10);
 270
 271         // Position the wielded item
 272         v3f wield_position = v3f(45, -35, 65);
 273         v3f wield_rotation = v3f(-100, 120, -100);
 274         if (m_digging_button != -1)
 275         {
 276                 f32 digfrac = m_digging_anim;
 277                 wield_position.X -= 30 * sin(pow(digfrac, 0.8f) * PI);
 278                 wield_position.Y += 15 * sin(digfrac * 2 * PI);
 279                 wield_position.Z += 5 * digfrac;
 280
 281                 // Euler angles are PURE EVIL, so why not use quaternions?
 282                 core::quaternion quat_begin(wield_rotation * core::DEGTORAD);
 283                 core::quaternion quat_end(v3f(90, -10, -130) * core::DEGTORAD);
 284                 core::quaternion quat_slerp;
 285                 quat_slerp.slerp(quat_begin, quat_end, sin(digfrac * PI));
 286                 quat_slerp.toEuler(wield_rotation);
 287                 wield_rotation *= core::RADTODEG;
 288         }
 289         else {
 290                 f32 bobfrac = my_modf(m_view_bobbing_anim);
 291                 wield_position.X -= sin(bobfrac*PI*2.0) * 3.0;
 292                 wield_position.Y += sin(my_modf(bobfrac*2.0)*PI) * 3.0;
 293         }
 294         m_wieldnode->setPosition(wield_position);
 295         m_wieldnode->setRotation(wield_rotation);
 296         m_wieldlight = player->light;
 297
 298         // Render distance feedback loop
 299         updateViewingRange(frametime);
 300
 301         // If the player seems to be walking on solid ground,
 302         // view bobbing is enabled and free_move is off,
 303         // start (or continue) the view bobbing animation.
 304         v3f speed = player->getSpeed();
 305         if ((hypot(speed.X, speed.Z) > BS) &&
 306                 (player->touching_ground) &&
 307                 (g_settings->getBool("view_bobbing") == true) &&
 308                 (g_settings->getBool("free_move") == false))
 309         {
 310                 // Start animation
 311                 m_view_bobbing_state = 1;
 312                 m_view_bobbing_speed = MYMIN(speed.getLength(), 40);
 313         }
 314         else if (m_view_bobbing_state == 1)
 315         {
 316                 // Stop animation
 317                 m_view_bobbing_state = 2;
 318                 m_view_bobbing_speed = 60;
 319         }
 320 }
 321
 322 void Camera::updateViewingRange(f32 frametime_in)
 323 {
 324         if (m_draw_control.range_all)
 325                 return;
 326
 327         m_added_frametime += frametime_in;
 328         m_added_frames += 1;
 329
 330         // Actually this counter kind of sucks because frametime is busytime
 331         m_frametime_counter -= frametime_in;
 332         if (m_frametime_counter > 0)
 333                 return;
 334         m_frametime_counter = 0.2;
 335
 336         /*dstream<<__FUNCTION_NAME
 337                         <<": Collected "<<m_added_frames<<" frames, total of "
 338                         <<m_added_frametime<<"s."<<std::endl;
 339
 340         dstream<<"m_draw_control.blocks_drawn="
 341                         <<m_draw_control.blocks_drawn
 342                         <<", m_draw_control.blocks_would_have_drawn="
 343                         <<m_draw_control.blocks_would_have_drawn
 344                         <<std::endl;*/
 345
 346         m_draw_control.wanted_min_range = m_viewing_range_min;
 347         m_draw_control.wanted_max_blocks = (2.0*m_draw_control.blocks_would_have_drawn)+1;
 348         if (m_draw_control.wanted_max_blocks < 10)
 349                 m_draw_control.wanted_max_blocks = 10;
 350
 351         f32 block_draw_ratio = 1.0;
 352         if (m_draw_control.blocks_would_have_drawn != 0)
 353         {
 354                 block_draw_ratio = (f32)m_draw_control.blocks_drawn
 355                         / (f32)m_draw_control.blocks_would_have_drawn;
 356         }
 357
 358         // Calculate the average frametime in the case that all wanted
 359         // blocks had been drawn
 360         f32 frametime = m_added_frametime / m_added_frames / block_draw_ratio;
 361
 362         m_added_frametime = 0.0;
 363         m_added_frames = 0;
 364
 365         f32 wanted_frametime_change = m_wanted_frametime - frametime;
 366         //dstream<<"wanted_frametime_change="<<wanted_frametime_change<<std::endl;
 367
 368         // If needed frametime change is small, just return
 369         // This value was 0.4 for many months until 2011-10-18 by c55;
 370         // Let's see how this works out.
 371         if (fabs(wanted_frametime_change) < m_wanted_frametime*0.33)
 372         {
 373                 //dstream<<"ignoring small wanted_frametime_change"<<std::endl;
 374                 return;
 375         }
 376
 377         f32 range = m_draw_control.wanted_range;
 378         f32 new_range = range;
 379
 380         f32 d_range = range - m_range_old;
 381         f32 d_frametime = frametime - m_frametime_old;
 382         if (d_range != 0)
 383         {
 384                 m_time_per_range = d_frametime / d_range;
 385         }
 386
 387         // The minimum allowed calculated frametime-range derivative:
 388         // Practically this sets the maximum speed of changing the range.
 389         // The lower this value, the higher the maximum changing speed.
 390         // A low value here results in wobbly range (0.001)
 391         // A high value here results in slow changing range (0.0025)
 392         // SUGG: This could be dynamically adjusted so that when
 393         //       the camera is turning, this is lower
 394         //f32 min_time_per_range = 0.0015;
 395         f32 min_time_per_range = 0.0010;
 396         //f32 min_time_per_range = 0.05 / range;
 397         if(m_time_per_range < min_time_per_range)
 398         {
 399                 m_time_per_range = min_time_per_range;
 400                 //dstream<<"m_time_per_range="<<m_time_per_range<<" (min)"<<std::endl;
 401         }
 402         else
 403         {
 404                 //dstream<<"m_time_per_range="<<m_time_per_range<<std::endl;
 405         }
 406
 407         f32 wanted_range_change = wanted_frametime_change / m_time_per_range;
 408         // Dampen the change a bit to kill oscillations
 409         //wanted_range_change *= 0.9;
 410         //wanted_range_change *= 0.75;
 411         wanted_range_change *= 0.5;
 412         //dstream<<"wanted_range_change="<<wanted_range_change<<std::endl;
 413
 414         // If needed range change is very small, just return
 415         if(fabs(wanted_range_change) < 0.001)
 416         {
 417                 //dstream<<"ignoring small wanted_range_change"<<std::endl;
 418                 return;
 419         }
 420
 421         new_range += wanted_range_change;
 422
 423         //f32 new_range_unclamped = new_range;
 424         new_range = MYMAX(new_range, m_viewing_range_min);
 425         new_range = MYMIN(new_range, m_viewing_range_max);
 426         /*dstream<<"new_range="<<new_range_unclamped
 427                         <<", clamped to "<<new_range<<std::endl;*/
 428
 429         m_draw_control.wanted_range = new_range;
 430
 431         m_range_old = new_range;
 432         m_frametime_old = frametime;
 433 }
 434
 435 void Camera::updateSettings()
 436 {
 437         m_viewing_range_min = g_settings->getS16("viewing_range_nodes_min");
 438         m_viewing_range_min = MYMAX(5.0, m_viewing_range_min);
 439
 440         m_viewing_range_max = g_settings->getS16("viewing_range_nodes_max");
 441         m_viewing_range_max = MYMAX(m_viewing_range_min, m_viewing_range_max);
 442
 443         f32 fov_degrees = g_settings->getFloat("fov");
 444         fov_degrees = MYMAX(fov_degrees, 10.0);
 445         fov_degrees = MYMIN(fov_degrees, 170.0);
 446         m_fov_y = fov_degrees * PI / 180.0;
 447
 448         f32 wanted_fps = g_settings->getFloat("wanted_fps");
 449         wanted_fps = MYMAX(wanted_fps, 1.0);
 450         m_wanted_frametime = 1.0 / wanted_fps;
 451 }
 452
 453 void Camera::setDigging(s32 button)
 454 {
 455         if (m_digging_button == -1)
 456                 m_digging_button = button;
 457 }
 458
 459 void Camera::wield(const ItemStack &item, IGameDef *gamedef)
 460 {
 461         IItemDefManager *idef = gamedef->idef();
 462         scene::IMesh *wield_mesh = item.getDefinition(idef).wield_mesh;
 463         if(wield_mesh)
 464         {
 465                 m_wieldnode->setMesh(wield_mesh);
 466                 m_wieldnode->setVisible(true);
 467         }
 468         else
 469         {
 470                 m_wieldnode->setVisible(false);
 471         }
 472 }
 473
 474 void Camera::drawWieldedTool()
 475 {
 476         // Set vertex colors of wield mesh according to light level
 477         u8 li = decode_light(m_wieldlight);
 478         video::SColor color(255,li,li,li);
 479         setMeshColor(m_wieldnode->getMesh(), color);
 480
 481         // Clear Z buffer
 482         m_wieldmgr->getVideoDriver()->clearZBuffer();
 483
 484         // Draw the wielded node (in a separate scene manager)
 485         scene::ICameraSceneNode* cam = m_wieldmgr->getActiveCamera();
 486         cam->setAspectRatio(m_cameranode->getAspectRatio());
 487         cam->setFOV(m_cameranode->getFOV());
 488         cam->setNearValue(0.1);
 489         cam->setFarValue(100);
 490         m_wieldmgr->drawAll();
 491 }