src/camera.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser 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 #ifndef CAMERA_HEADER
  21 #define CAMERA_HEADER
  22
  23 #include "irrlichttypes_extrabloated.h"
  24 #include "inventory.h"
  25 #include "mesh.h"
  26 #include "tile.h"
  27 #include "util/numeric.h"
  28 #include <ICameraSceneNode.h>
  29
  30 #include "client.h"
  31
  32 class LocalPlayer;
  33 struct MapDrawControl;
  34 class IGameDef;
  35
  36 enum CameraMode {CAMERA_MODE_FIRST, CAMERA_MODE_THIRD, CAMERA_MODE_THIRD_FRONT};
  37
  38 /*
  39         Client camera class, manages the player and camera scene nodes, the viewing distance
  40         and performs view bobbing etc. It also displays the wielded tool in front of the
  41         first-person camera.
  42 */
  43 class Camera
  44 {
  45 public:
  46         Camera(scene::ISceneManager* smgr, MapDrawControl& draw_control,
  47                         IGameDef *gamedef);
  48         ~Camera();
  49
  50         // Get player scene node.
  51         // This node is positioned at the player's torso (without any view bobbing),
  52         // as given by Player::m_position. Yaw is applied but not pitch.
  53         inline scene::ISceneNode* getPlayerNode() const
  54         {
  55                 return m_playernode;
  56         }
  57
  58         // Get head scene node.
  59         // It has the eye transformation and pitch applied,
  60         // but no view bobbing.
  61         inline scene::ISceneNode* getHeadNode() const
  62         {
  63                 return m_headnode;
  64         }
  65
  66         // Get camera scene node.
  67         // It has the eye transformation, pitch and view bobbing applied.
  68         inline scene::ICameraSceneNode* getCameraNode() const
  69         {
  70                 return m_cameranode;
  71         }
  72
  73         // Get the camera position (in absolute scene coordinates).
  74         // This has view bobbing applied.
  75         inline v3f getPosition() const
  76         {
  77                 return m_camera_position;
  78         }
  79
  80         // Get the camera direction (in absolute camera coordinates).
  81         // This has view bobbing applied.
  82         inline v3f getDirection() const
  83         {
  84                 return m_camera_direction;
  85         }
  86
  87         // Get the camera offset
  88         inline v3s16 getOffset() const
  89         {
  90                 return m_camera_offset;
  91         }
  92
  93         // Horizontal field of view
  94         inline f32 getFovX() const
  95         {
  96                 return m_fov_x;
  97         }
  98
  99         // Vertical field of view
 100         inline f32 getFovY() const
 101         {
 102                 return m_fov_y;
 103         }
 104
 105         // Get maximum of getFovX() and getFovY()
 106         inline f32 getFovMax() const
 107         {
 108                 return MYMAX(m_fov_x, m_fov_y);
 109         }
 110
 111         // Checks if the constructor was able to create the scene nodes
 112         bool successfullyCreated(std::wstring& error_message);
 113
 114         // Step the camera: updates the viewing range and view bobbing.
 115         void step(f32 dtime);
 116
 117         // Update the camera from the local player's position.
 118         // busytime is used to adjust the viewing range.
 119         void update(LocalPlayer* player, f32 frametime, f32 busytime,
 120                         f32 tool_reload_ratio, ClientEnvironment &c_env);
 121
 122         // Render distance feedback loop
 123         void updateViewingRange(f32 frametime_in, f32 busytime_in);
 124
 125         // Start digging animation
 126         // Pass 0 for left click, 1 for right click
 127         void setDigging(s32 button);
 128
 129         // Replace the wielded item mesh
 130         void wield(const ItemStack &item, u16 playeritem);
 131
 132         // Draw the wielded tool.
 133         // This has to happen *after* the main scene is drawn.
 134         // Warning: This clears the Z buffer.
 135         void drawWieldedTool(irr::core::matrix4* translation=NULL);
 136
 137         // Toggle the current camera mode
 138         void toggleCameraMode() {
 139                 if (m_camera_mode == CAMERA_MODE_FIRST)
 140                         m_camera_mode = CAMERA_MODE_THIRD;
 141                 else if (m_camera_mode == CAMERA_MODE_THIRD)
 142                         m_camera_mode = CAMERA_MODE_THIRD_FRONT;
 143                 else
 144                         m_camera_mode = CAMERA_MODE_FIRST;
 145         }
 146
 147         //read the current camera mode
 148         inline CameraMode getCameraMode()
 149         {
 150                 return m_camera_mode;
 151         }
 152
 153 private:
 154         // Nodes
 155         scene::ISceneNode* m_playernode;
 156         scene::ISceneNode* m_headnode;
 157         scene::ICameraSceneNode* m_cameranode;
 158
 159         scene::ISceneManager* m_wieldmgr;
 160         scene::IMeshSceneNode* m_wieldnode;
 161         u8 m_wieldlight;
 162
 163         // draw control
 164         MapDrawControl& m_draw_control;
 165
 166         IGameDef *m_gamedef;
 167
 168         // Absolute camera position
 169         v3f m_camera_position;
 170         // Absolute camera direction
 171         v3f m_camera_direction;
 172         // Camera offset
 173         v3s16 m_camera_offset;
 174
 175         // Field of view and aspect ratio stuff
 176         f32 m_aspect;
 177         f32 m_fov_x;
 178         f32 m_fov_y;
 179
 180         // Stuff for viewing range calculations
 181         f32 m_added_busytime;
 182         s16 m_added_frames;
 183         f32 m_range_old;
 184         f32 m_busytime_old;
 185         f32 m_frametime_counter;
 186         f32 m_time_per_range;
 187
 188         // View bobbing animation frame (0 <= m_view_bobbing_anim < 1)
 189         f32 m_view_bobbing_anim;
 190         // If 0, view bobbing is off (e.g. player is standing).
 191         // If 1, view bobbing is on (player is walking).
 192         // If 2, view bobbing is getting switched off.
 193         s32 m_view_bobbing_state;
 194         // Speed of view bobbing animation
 195         f32 m_view_bobbing_speed;
 196         // Fall view bobbing
 197         f32 m_view_bobbing_fall;
 198
 199         // Digging animation frame (0 <= m_digging_anim < 1)
 200         f32 m_digging_anim;
 201         // If -1, no digging animation
 202         // If 0, left-click digging animation
 203         // If 1, right-click digging animation
 204         s32 m_digging_button;
 205
 206         //dummymesh for camera
 207         irr::scene::IAnimatedMesh* m_dummymesh;
 208
 209         // Animation when changing wielded item
 210         f32 m_wield_change_timer;
 211         scene::IMesh *m_wield_mesh_next;
 212         u16 m_previous_playeritem;
 213         std::string m_previous_itemname;
 214
 215         CameraMode m_camera_mode;
 216 };
 217
 218 #endif