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 "client/tile.h"
  27 #include "util/numeric.h"
  28 #include <ICameraSceneNode.h>
  29 #include <ISceneNode.h>
  30 #include <list>
  31
  32 #include "client.h"
  33
  34 class LocalPlayer;
  35 struct MapDrawControl;
  36 class Client;
  37 class WieldMeshSceneNode;
  38
  39 struct Nametag {
  40         Nametag(scene::ISceneNode *a_parent_node,
  41                         const std::string &a_nametag_text,
  42                         const video::SColor &a_nametag_color):
  43                 parent_node(a_parent_node),
  44                 nametag_text(a_nametag_text),
  45                 nametag_color(a_nametag_color)
  46         {
  47         }
  48         scene::ISceneNode *parent_node;
  49         std::string nametag_text;
  50         video::SColor nametag_color;
  51 };
  52
  53 enum CameraMode {CAMERA_MODE_FIRST, CAMERA_MODE_THIRD, CAMERA_MODE_THIRD_FRONT};
  54
  55 /*
  56         Client camera class, manages the player and camera scene nodes, the viewing distance
  57         and performs view bobbing etc. It also displays the wielded tool in front of the
  58         first-person camera.
  59 */
  60 class Camera
  61 {
  62 public:
  63         Camera(scene::ISceneManager* smgr, MapDrawControl& draw_control,
  64                         Client *client);
  65         ~Camera();
  66
  67         // Get camera scene node.
  68         // It has the eye transformation, pitch and view bobbing applied.
  69         inline scene::ICameraSceneNode* getCameraNode() const
  70         {
  71                 return m_cameranode;
  72         }
  73
  74         // Get the camera position (in absolute scene coordinates).
  75         // This has view bobbing applied.
  76         inline v3f getPosition() const
  77         {
  78                 return m_camera_position;
  79         }
  80
  81         // Get the camera direction (in absolute camera coordinates).
  82         // This has view bobbing applied.
  83         inline v3f getDirection() const
  84         {
  85                 return m_camera_direction;
  86         }
  87
  88         // Get the camera offset
  89         inline v3s16 getOffset() const
  90         {
  91                 return m_camera_offset;
  92         }
  93
  94         // Horizontal field of view
  95         inline f32 getFovX() const
  96         {
  97                 return m_fov_x;
  98         }
  99
 100         // Vertical field of view
 101         inline f32 getFovY() const
 102         {
 103                 return m_fov_y;
 104         }
 105
 106         // Get maximum of getFovX() and getFovY()
 107         inline f32 getFovMax() const
 108         {
 109                 return MYMAX(m_fov_x, m_fov_y);
 110         }
 111
 112         // Checks if the constructor was able to create the scene nodes
 113         bool successfullyCreated(std::string &error_message);
 114
 115         // Step the camera: updates the viewing range and view bobbing.
 116         void step(f32 dtime);
 117
 118         // Update the camera from the local player's position.
 119         // busytime is used to adjust the viewing range.
 120         void update(LocalPlayer* player, f32 frametime, f32 busytime,
 121                         f32 tool_reload_ratio, ClientEnvironment &c_env);
 122
 123         // Update render distance
 124         void updateViewingRange();
 125
 126         // Start digging animation
 127         // Pass 0 for left click, 1 for right click
 128         void setDigging(s32 button);
 129
 130         // Replace the wielded item mesh
 131         void wield(const ItemStack &item);
 132
 133         // Draw the wielded tool.
 134         // This has to happen *after* the main scene is drawn.
 135         // Warning: This clears the Z buffer.
 136         void drawWieldedTool(irr::core::matrix4* translation=NULL);
 137
 138         // Toggle the current camera mode
 139         void toggleCameraMode() {
 140                 if (m_camera_mode == CAMERA_MODE_FIRST)
 141                         m_camera_mode = CAMERA_MODE_THIRD;
 142                 else if (m_camera_mode == CAMERA_MODE_THIRD)
 143                         m_camera_mode = CAMERA_MODE_THIRD_FRONT;
 144                 else
 145                         m_camera_mode = CAMERA_MODE_FIRST;
 146         }
 147
 148         // Set the current camera mode
 149         inline void setCameraMode(CameraMode mode)
 150         {
 151                 m_camera_mode = mode;
 152         }
 153
 154         //read the current camera mode
 155         inline CameraMode getCameraMode()
 156         {
 157                 return m_camera_mode;
 158         }
 159
 160         Nametag *addNametag(scene::ISceneNode *parent_node,
 161                 std::string nametag_text, video::SColor nametag_color);
 162
 163         void removeNametag(Nametag *nametag);
 164
 165         const std::list<Nametag *> &getNametags() { return m_nametags; }
 166
 167         void drawNametags();
 168
 169         inline void addArmInertia(f32 player_yaw, f32 frametime);
 170
 171 private:
 172         // Nodes
 173         scene::ISceneNode *m_playernode = nullptr;
 174         scene::ISceneNode *m_headnode = nullptr;
 175         scene::ICameraSceneNode *m_cameranode = nullptr;
 176
 177         scene::ISceneManager *m_wieldmgr = nullptr;
 178         WieldMeshSceneNode *m_wieldnode = nullptr;
 179
 180         // draw control
 181         MapDrawControl& m_draw_control;
 182
 183         Client *m_client;
 184         video::IVideoDriver *m_driver;
 185
 186         // Absolute camera position
 187         v3f m_camera_position;
 188         // Absolute camera direction
 189         v3f m_camera_direction;
 190         // Camera offset
 191         v3s16 m_camera_offset;
 192
 193         v2f m_wieldmesh_offset = v2f(55.0f, -35.0f);
 194         v2f m_arm_dir;
 195         v2f m_cam_vel;
 196         v2f m_cam_vel_old;
 197         v2f m_last_cam_pos;
 198
 199         // Field of view and aspect ratio stuff
 200         f32 m_aspect = 1.0f;
 201         f32 m_fov_x = 1.0f;
 202         f32 m_fov_y = 1.0f;
 203
 204         // View bobbing animation frame (0 <= m_view_bobbing_anim < 1)
 205         f32 m_view_bobbing_anim = 0.0f;
 206         // If 0, view bobbing is off (e.g. player is standing).
 207         // If 1, view bobbing is on (player is walking).
 208         // If 2, view bobbing is getting switched off.
 209         s32 m_view_bobbing_state = 0;
 210         // Speed of view bobbing animation
 211         f32 m_view_bobbing_speed = 0.0f;
 212         // Fall view bobbing
 213         f32 m_view_bobbing_fall = 0.0f;
 214
 215         // Digging animation frame (0 <= m_digging_anim < 1)
 216         f32 m_digging_anim = 0.0f;
 217         // If -1, no digging animation
 218         // If 0, left-click digging animation
 219         // If 1, right-click digging animation
 220         s32 m_digging_button = -1;
 221
 222         // Animation when changing wielded item
 223         f32 m_wield_change_timer = 0.125f;
 224         ItemStack m_wield_item_next;
 225
 226         CameraMode m_camera_mode = CAMERA_MODE_FIRST;
 227
 228         f32 m_cache_fall_bobbing_amount;
 229         f32 m_cache_view_bobbing_amount;
 230         f32 m_cache_fov;
 231         f32 m_cache_zoom_fov;
 232         bool m_arm_inertia;
 233
 234         std::list<Nametag *> m_nametags;
 235 };
 236
 237 #endif