3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
23 #include "main.h" // for g_settings
25 #include "clientmap.h" // MapDrawControl
31 #include "itemdef.h" // For wield visualization
32 #include "noise.h" // easeCurve
37 Camera::Camera(scene::ISceneManager* smgr, MapDrawControl& draw_control,
48 m_draw_control(draw_control),
51 m_camera_position(0,0,0),
52 m_camera_direction(0,0,0),
62 m_frametime_counter(0),
63 m_time_per_range(30. / 50), // a sane default of 30ms per 50 nodes of range
65 m_view_bobbing_anim(0),
66 m_view_bobbing_state(0),
67 m_view_bobbing_speed(0),
72 //dstream<<__FUNCTION_NAME<<std::endl;
74 // note: making the camera node a child of the player node
75 // would lead to unexpected behaviour, so we don't do that.
76 m_playernode = smgr->addEmptySceneNode(smgr->getRootSceneNode());
77 m_headnode = smgr->addEmptySceneNode(m_playernode);
78 m_cameranode = smgr->addCameraSceneNode(smgr->getRootSceneNode());
79 m_cameranode->bindTargetAndRotation(true);
81 // This needs to be in its own scene manager. It is drawn after
82 // all other 3D scene nodes and before the GUI.
83 m_wieldmgr = smgr->createNewSceneManager();
84 m_wieldmgr->addCameraSceneNode();
85 m_wieldnode = m_wieldmgr->addMeshSceneNode(createCubeMesh(v3f(1,1,1)), NULL); // need a dummy mesh
90 m_wieldnode->setMesh(NULL);
94 bool Camera::successfullyCreated(std::wstring& error_message)
96 if (m_playernode == NULL)
98 error_message = L"Failed to create the player scene node";
101 if (m_headnode == NULL)
103 error_message = L"Failed to create the head scene node";
106 if (m_cameranode == NULL)
108 error_message = L"Failed to create the camera scene node";
111 if (m_wieldmgr == NULL)
113 error_message = L"Failed to create the wielded item scene manager";
116 if (m_wieldnode == NULL)
118 error_message = L"Failed to create the wielded item scene node";
124 // Returns the fractional part of x
125 inline f32 my_modf(f32 x)
128 return modf(x, &dummy);
131 void Camera::step(f32 dtime)
133 if (m_view_bobbing_state != 0)
135 //f32 offset = dtime * m_view_bobbing_speed * 0.035;
136 f32 offset = dtime * m_view_bobbing_speed * 0.030;
137 if (m_view_bobbing_state == 2)
140 // Animation is getting turned off
141 if (m_view_bobbing_anim < 0.5)
142 m_view_bobbing_anim -= offset;
144 m_view_bobbing_anim += offset;
145 if (m_view_bobbing_anim <= 0 || m_view_bobbing_anim >= 1)
147 m_view_bobbing_anim = 0;
148 m_view_bobbing_state = 0;
152 // Animation is getting turned off
153 if(m_view_bobbing_anim < 0.25){
154 m_view_bobbing_anim -= offset;
155 } else if(m_view_bobbing_anim > 0.75){
156 m_view_bobbing_anim += offset;
157 } if(m_view_bobbing_anim < 0.5){
158 m_view_bobbing_anim += offset;
159 if(m_view_bobbing_anim > 0.5)
160 m_view_bobbing_anim = 0.5;
162 m_view_bobbing_anim -= offset;
163 if(m_view_bobbing_anim < 0.5)
164 m_view_bobbing_anim = 0.5;
166 if(m_view_bobbing_anim <= 0 || m_view_bobbing_anim >= 1 ||
167 fabs(m_view_bobbing_anim - 0.5) < 0.01)
169 m_view_bobbing_anim = 0;
170 m_view_bobbing_state = 0;
176 float was = m_view_bobbing_anim;
177 m_view_bobbing_anim = my_modf(m_view_bobbing_anim + offset);
178 bool step = (was == 0 ||
179 (was < 0.5f && m_view_bobbing_anim >= 0.5f) ||
180 (was > 0.5f && m_view_bobbing_anim <= 0.5f));
182 MtEvent *e = new SimpleTriggerEvent("ViewBobbingStep");
183 m_gamedef->event()->put(e);
188 if (m_digging_button != -1)
190 f32 offset = dtime * 3.5;
191 float m_digging_anim_was = m_digging_anim;
192 m_digging_anim += offset;
193 if (m_digging_anim >= 1)
196 m_digging_button = -1;
199 if(m_digging_anim_was < lim && m_digging_anim >= lim)
201 if(m_digging_button == 0){
202 MtEvent *e = new SimpleTriggerEvent("CameraPunchLeft");
203 m_gamedef->event()->put(e);
204 } else if(m_digging_button == 1){
205 MtEvent *e = new SimpleTriggerEvent("CameraPunchRight");
206 m_gamedef->event()->put(e);
212 void Camera::update(LocalPlayer* player, f32 frametime, v2u32 screensize,
213 f32 tool_reload_ratio)
215 // Set player node transformation
216 m_playernode->setPosition(player->getPosition());
217 m_playernode->setRotation(v3f(0, -1 * player->getYaw(), 0));
218 m_playernode->updateAbsolutePosition();
220 // Set head node transformation
221 m_headnode->setPosition(player->getEyeOffset());
222 m_headnode->setRotation(v3f(player->getPitch(), 0, 0));
223 m_headnode->updateAbsolutePosition();
225 // Compute relative camera position and target
226 v3f rel_cam_pos = v3f(0,0,0);
227 v3f rel_cam_target = v3f(0,0,1);
228 v3f rel_cam_up = v3f(0,1,0);
230 if (m_view_bobbing_anim != 0)
232 f32 bobfrac = my_modf(m_view_bobbing_anim * 2);
233 f32 bobdir = (m_view_bobbing_anim < 0.5) ? 1.0 : -1.0;
237 f32 bobtmp = sin(pow(bobfrac, bobknob) * PI);
238 //f32 bobtmp2 = cos(pow(bobfrac, bobknob) * PI);
241 0.3 * bobdir * sin(bobfrac * PI),
242 -0.28 * bobtmp * bobtmp,
245 //rel_cam_pos += 0.2 * bobvec;
246 //rel_cam_target += 0.03 * bobvec;
247 //rel_cam_up.rotateXYBy(0.02 * bobdir * bobtmp * PI);
249 f *= g_settings->getFloat("view_bobbing_amount");
250 rel_cam_pos += bobvec * f;
251 //rel_cam_target += 0.995 * bobvec * f;
252 rel_cam_target += bobvec * f;
253 rel_cam_target.Z -= 0.005 * bobvec.Z * f;
254 //rel_cam_target.X -= 0.005 * bobvec.X * f;
255 //rel_cam_target.Y -= 0.005 * bobvec.Y * f;
256 rel_cam_up.rotateXYBy(-0.03 * bobdir * bobtmp * PI * f);
258 f32 angle_deg = 1 * bobdir * sin(bobfrac * PI);
259 f32 angle_rad = angle_deg * PI / 180;
263 r * (cos(angle_rad) - 1),
266 //rel_cam_target += off;
267 rel_cam_up.rotateXYBy(angle_deg);
272 // Compute absolute camera position and target
273 m_headnode->getAbsoluteTransformation().transformVect(m_camera_position, rel_cam_pos);
274 m_headnode->getAbsoluteTransformation().rotateVect(m_camera_direction, rel_cam_target - rel_cam_pos);
277 m_headnode->getAbsoluteTransformation().rotateVect(abs_cam_up, rel_cam_up);
279 // Set camera node transformation
280 m_cameranode->setPosition(m_camera_position);
281 m_cameranode->setUpVector(abs_cam_up);
282 // *100.0 helps in large map coordinates
283 m_cameranode->setTarget(m_camera_position + 100 * m_camera_direction);
286 f32 fov_degrees = g_settings->getFloat("fov");
287 fov_degrees = MYMAX(fov_degrees, 10.0);
288 fov_degrees = MYMIN(fov_degrees, 170.0);
290 // FOV and aspect ratio
291 m_aspect = (f32)screensize.X / (f32) screensize.Y;
292 m_fov_y = fov_degrees * PI / 180.0;
293 m_fov_x = 2 * atan(0.5 * m_aspect * tan(m_fov_y));
294 m_cameranode->setAspectRatio(m_aspect);
295 m_cameranode->setFOV(m_fov_y);
297 // Position the wielded item
298 //v3f wield_position = v3f(45, -35, 65);
299 v3f wield_position = v3f(55, -35, 65);
300 //v3f wield_rotation = v3f(-100, 120, -100);
301 v3f wield_rotation = v3f(-100, 120, -100);
302 if(m_digging_anim < 0.05 || m_digging_anim > 0.5){
304 if(m_digging_anim > 0.5)
305 frac = 2.0 * (m_digging_anim - 0.5);
306 // This value starts from 1 and settles to 0
307 f32 ratiothing = pow((1.0f - tool_reload_ratio), 0.5f);
308 //f32 ratiothing2 = pow(ratiothing, 0.5f);
309 f32 ratiothing2 = (easeCurve(ratiothing*0.5))*2.0;
310 wield_position.Y -= frac * 25.0 * pow(ratiothing2, 1.7f);
311 //wield_position.Z += frac * 5.0 * ratiothing2;
312 wield_position.X -= frac * 35.0 * pow(ratiothing2, 1.1f);
313 wield_rotation.Y += frac * 70.0 * pow(ratiothing2, 1.4f);
314 //wield_rotation.X -= frac * 15.0 * pow(ratiothing2, 1.4f);
315 //wield_rotation.Z += frac * 15.0 * pow(ratiothing2, 1.0f);
317 if (m_digging_button != -1)
319 f32 digfrac = m_digging_anim;
320 wield_position.X -= 30 * sin(pow(digfrac, 0.8f) * PI);
321 wield_position.Y += 15 * sin(digfrac * 2 * PI);
322 wield_position.Z += 5 * digfrac;
324 // Euler angles are PURE EVIL, so why not use quaternions?
325 core::quaternion quat_begin(wield_rotation * core::DEGTORAD);
326 core::quaternion quat_end(v3f(90, -10, -130) * core::DEGTORAD);
327 core::quaternion quat_slerp;
328 quat_slerp.slerp(quat_begin, quat_end, sin(digfrac * PI));
329 quat_slerp.toEuler(wield_rotation);
330 wield_rotation *= core::RADTODEG;
333 f32 bobfrac = my_modf(m_view_bobbing_anim);
334 wield_position.X -= sin(bobfrac*PI*2.0) * 3.0;
335 wield_position.Y += sin(my_modf(bobfrac*2.0)*PI) * 3.0;
337 m_wieldnode->setPosition(wield_position);
338 m_wieldnode->setRotation(wield_rotation);
339 m_wieldlight = player->light;
341 // Render distance feedback loop
342 updateViewingRange(frametime);
344 // If the player seems to be walking on solid ground,
345 // view bobbing is enabled and free_move is off,
346 // start (or continue) the view bobbing animation.
347 v3f speed = player->getSpeed();
348 if ((hypot(speed.X, speed.Z) > BS) &&
349 (player->touching_ground) &&
350 (g_settings->getBool("view_bobbing") == true) &&
351 (g_settings->getBool("free_move") == false))
354 m_view_bobbing_state = 1;
355 m_view_bobbing_speed = MYMIN(speed.getLength(), 40);
357 else if (m_view_bobbing_state == 1)
360 m_view_bobbing_state = 2;
361 m_view_bobbing_speed = 60;
365 void Camera::updateViewingRange(f32 frametime_in)
367 if (m_draw_control.range_all)
370 m_added_frametime += frametime_in;
373 // Actually this counter kind of sucks because frametime is busytime
374 m_frametime_counter -= frametime_in;
375 if (m_frametime_counter > 0)
377 m_frametime_counter = 0.2;
379 /*dstream<<__FUNCTION_NAME
380 <<": Collected "<<m_added_frames<<" frames, total of "
381 <<m_added_frametime<<"s."<<std::endl;
383 dstream<<"m_draw_control.blocks_drawn="
384 <<m_draw_control.blocks_drawn
385 <<", m_draw_control.blocks_would_have_drawn="
386 <<m_draw_control.blocks_would_have_drawn
389 // Get current viewing range and FPS settings
390 f32 viewing_range_min = g_settings->getS16("viewing_range_nodes_min");
391 viewing_range_min = MYMAX(5.0, viewing_range_min);
393 f32 viewing_range_max = g_settings->getS16("viewing_range_nodes_max");
394 viewing_range_max = MYMAX(viewing_range_min, viewing_range_max);
396 // Immediately apply hard limits
397 if(m_draw_control.wanted_range < viewing_range_min)
398 m_draw_control.wanted_range = viewing_range_min;
399 if(m_draw_control.wanted_range > viewing_range_max)
400 m_draw_control.wanted_range = viewing_range_max;
402 // Just so big a value that everything rendered is visible
403 // Some more allowance than viewing_range_max * BS because of clouds,
404 // active objects, etc.
405 if(viewing_range_max < 200*BS)
406 m_cameranode->setFarValue(200 * BS * 10);
408 m_cameranode->setFarValue(viewing_range_max * BS * 10);
410 f32 wanted_fps = g_settings->getFloat("wanted_fps");
411 wanted_fps = MYMAX(wanted_fps, 1.0);
412 f32 wanted_frametime = 1.0 / wanted_fps;
414 m_draw_control.wanted_min_range = viewing_range_min;
415 m_draw_control.wanted_max_blocks = (2.0*m_draw_control.blocks_would_have_drawn)+1;
416 if (m_draw_control.wanted_max_blocks < 10)
417 m_draw_control.wanted_max_blocks = 10;
419 f32 block_draw_ratio = 1.0;
420 if (m_draw_control.blocks_would_have_drawn != 0)
422 block_draw_ratio = (f32)m_draw_control.blocks_drawn
423 / (f32)m_draw_control.blocks_would_have_drawn;
426 // Calculate the average frametime in the case that all wanted
427 // blocks had been drawn
428 f32 frametime = m_added_frametime / m_added_frames / block_draw_ratio;
430 m_added_frametime = 0.0;
433 f32 wanted_frametime_change = wanted_frametime - frametime;
434 //dstream<<"wanted_frametime_change="<<wanted_frametime_change<<std::endl;
436 // If needed frametime change is small, just return
437 // This value was 0.4 for many months until 2011-10-18 by c55;
438 // Let's see how this works out.
439 if (fabs(wanted_frametime_change) < wanted_frametime*0.33)
441 //dstream<<"ignoring small wanted_frametime_change"<<std::endl;
445 f32 range = m_draw_control.wanted_range;
446 f32 new_range = range;
448 f32 d_range = range - m_range_old;
449 f32 d_frametime = frametime - m_frametime_old;
452 m_time_per_range = d_frametime / d_range;
455 // The minimum allowed calculated frametime-range derivative:
456 // Practically this sets the maximum speed of changing the range.
457 // The lower this value, the higher the maximum changing speed.
458 // A low value here results in wobbly range (0.001)
459 // A high value here results in slow changing range (0.0025)
460 // SUGG: This could be dynamically adjusted so that when
461 // the camera is turning, this is lower
462 //f32 min_time_per_range = 0.0015;
463 f32 min_time_per_range = 0.0010;
464 //f32 min_time_per_range = 0.05 / range;
465 if(m_time_per_range < min_time_per_range)
467 m_time_per_range = min_time_per_range;
468 //dstream<<"m_time_per_range="<<m_time_per_range<<" (min)"<<std::endl;
472 //dstream<<"m_time_per_range="<<m_time_per_range<<std::endl;
475 f32 wanted_range_change = wanted_frametime_change / m_time_per_range;
476 // Dampen the change a bit to kill oscillations
477 //wanted_range_change *= 0.9;
478 //wanted_range_change *= 0.75;
479 wanted_range_change *= 0.5;
480 //dstream<<"wanted_range_change="<<wanted_range_change<<std::endl;
482 // If needed range change is very small, just return
483 if(fabs(wanted_range_change) < 0.001)
485 //dstream<<"ignoring small wanted_range_change"<<std::endl;
489 new_range += wanted_range_change;
491 //f32 new_range_unclamped = new_range;
492 new_range = MYMAX(new_range, viewing_range_min);
493 new_range = MYMIN(new_range, viewing_range_max);
494 /*dstream<<"new_range="<<new_range_unclamped
495 <<", clamped to "<<new_range<<std::endl;*/
497 m_draw_control.wanted_range = new_range;
499 m_range_old = new_range;
500 m_frametime_old = frametime;
503 void Camera::setDigging(s32 button)
505 if (m_digging_button == -1)
506 m_digging_button = button;
509 void Camera::wield(const ItemStack &item)
511 IItemDefManager *idef = m_gamedef->idef();
512 scene::IMesh *wield_mesh = item.getDefinition(idef).wield_mesh;
515 m_wieldnode->setMesh(wield_mesh);
516 m_wieldnode->setVisible(true);
520 m_wieldnode->setVisible(false);
524 void Camera::drawWieldedTool()
526 // Set vertex colors of wield mesh according to light level
527 u8 li = decode_light(m_wieldlight);
528 video::SColor color(255,li,li,li);
529 setMeshColor(m_wieldnode->getMesh(), color);
532 m_wieldmgr->getVideoDriver()->clearZBuffer();
534 // Draw the wielded node (in a separate scene manager)
535 scene::ICameraSceneNode* cam = m_wieldmgr->getActiveCamera();
536 cam->setAspectRatio(m_cameranode->getAspectRatio());
537 cam->setFOV(72.0*PI/180.0);
538 cam->setNearValue(0.1);
539 cam->setFarValue(100);
540 m_wieldmgr->drawAll();