3 Copyright (C) 2010-2013 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 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.
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.
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.
23 #include "irrlichttypes_extrabloated.h"
24 #include "inventory.h"
26 #include "client/tile.h"
27 #include "util/numeric.h"
28 #include <ICameraSceneNode.h>
29 #include <ISceneNode.h>
35 struct MapDrawControl;
37 class WieldMeshSceneNode;
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)
48 scene::ISceneNode *parent_node;
49 std::string nametag_text;
50 video::SColor nametag_color;
53 enum CameraMode {CAMERA_MODE_FIRST, CAMERA_MODE_THIRD, CAMERA_MODE_THIRD_FRONT};
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
63 Camera(MapDrawControl &draw_control, Client *client);
66 // Get camera scene node.
67 // It has the eye transformation, pitch and view bobbing applied.
68 inline scene::ICameraSceneNode* getCameraNode() const
73 // Get the camera position (in absolute scene coordinates).
74 // This has view bobbing applied.
75 inline v3f getPosition() const
77 return m_camera_position;
80 // Get the camera direction (in absolute camera coordinates).
81 // This has view bobbing applied.
82 inline v3f getDirection() const
84 return m_camera_direction;
87 // Get the camera offset
88 inline v3s16 getOffset() const
90 return m_camera_offset;
93 // Horizontal field of view
94 inline f32 getFovX() const
99 // Vertical field of view
100 inline f32 getFovY() const
105 // Get maximum of getFovX() and getFovY()
106 inline f32 getFovMax() const
108 return MYMAX(m_fov_x, m_fov_y);
111 // Checks if the constructor was able to create the scene nodes
112 bool successfullyCreated(std::string &error_message);
114 // Step the camera: updates the viewing range and view bobbing.
115 void step(f32 dtime);
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);
122 // Update render distance
123 void updateViewingRange();
125 // Start digging animation
126 // Pass 0 for left click, 1 for right click
127 void setDigging(s32 button);
129 // Replace the wielded item mesh
130 void wield(const ItemStack &item);
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);
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;
144 m_camera_mode = CAMERA_MODE_FIRST;
147 // Set the current camera mode
148 inline void setCameraMode(CameraMode mode)
150 m_camera_mode = mode;
153 //read the current camera mode
154 inline CameraMode getCameraMode()
156 return m_camera_mode;
159 Nametag *addNametag(scene::ISceneNode *parent_node,
160 std::string nametag_text, video::SColor nametag_color);
162 void removeNametag(Nametag *nametag);
164 const std::list<Nametag *> &getNametags() { return m_nametags; }
168 inline void addArmInertia(f32 player_yaw);
172 scene::ISceneNode *m_playernode = nullptr;
173 scene::ISceneNode *m_headnode = nullptr;
174 scene::ICameraSceneNode *m_cameranode = nullptr;
176 scene::ISceneManager *m_wieldmgr = nullptr;
177 WieldMeshSceneNode *m_wieldnode = nullptr;
180 MapDrawControl& m_draw_control;
184 // Absolute camera position
185 v3f m_camera_position;
186 // Absolute camera direction
187 v3f m_camera_direction;
189 v3s16 m_camera_offset;
191 v2f m_wieldmesh_offset = v2f(55.0f, -35.0f);
197 // Field of view and aspect ratio stuff
202 // View bobbing animation frame (0 <= m_view_bobbing_anim < 1)
203 f32 m_view_bobbing_anim = 0.0f;
204 // If 0, view bobbing is off (e.g. player is standing).
205 // If 1, view bobbing is on (player is walking).
206 // If 2, view bobbing is getting switched off.
207 s32 m_view_bobbing_state = 0;
208 // Speed of view bobbing animation
209 f32 m_view_bobbing_speed = 0.0f;
211 f32 m_view_bobbing_fall = 0.0f;
213 // Digging animation frame (0 <= m_digging_anim < 1)
214 f32 m_digging_anim = 0.0f;
215 // If -1, no digging animation
216 // If 0, left-click digging animation
217 // If 1, right-click digging animation
218 s32 m_digging_button = -1;
220 // Animation when changing wielded item
221 f32 m_wield_change_timer = 0.125f;
222 ItemStack m_wield_item_next;
224 CameraMode m_camera_mode = CAMERA_MODE_FIRST;
226 f32 m_cache_fall_bobbing_amount;
227 f32 m_cache_view_bobbing_amount;
229 f32 m_cache_zoom_fov;
232 std::list<Nametag *> m_nametags;