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 "clientobject.h"
25 #include "object_properties.h"
26 #include "itemgroup.h"
27 #include "constants.h"
39 struct SmoothTranslator
45 f32 anim_time_counter = 0;
46 bool aim_is_end = true;
48 SmoothTranslator() = default;
52 void update(T new_target, bool is_end_position = false,
53 float update_interval = -1);
55 void translate(f32 dtime);
58 struct SmoothTranslatorWrapped : SmoothTranslator<f32>
60 void translate(f32 dtime);
63 struct SmoothTranslatorWrappedv3f : SmoothTranslator<v3f>
65 void translate(f32 dtime);
68 class GenericCAO : public ClientActiveObject
71 // Only set at initialization
72 std::string m_name = "";
73 bool m_is_player = false;
74 bool m_is_local_player = false;
75 // Property-ish things
76 ObjectProperties m_prop;
78 scene::ISceneManager *m_smgr = nullptr;
79 Client *m_client = nullptr;
80 aabb3f m_selection_box = aabb3f(-BS/3.,-BS/3.,-BS/3., BS/3.,BS/3.,BS/3.);
81 scene::IMeshSceneNode *m_meshnode = nullptr;
82 scene::IAnimatedMeshSceneNode *m_animated_meshnode = nullptr;
83 WieldMeshSceneNode *m_wield_meshnode = nullptr;
84 scene::IBillboardSceneNode *m_spritenode = nullptr;
85 scene::IDummyTransformationSceneNode *m_matrixnode = nullptr;
86 Nametag *m_nametag = nullptr;
87 v3f m_position = v3f(0.0f, 10.0f * BS, 0);
92 SmoothTranslator<v3f> pos_translator;
93 SmoothTranslatorWrappedv3f rot_translator;
94 // Spritesheet/animation stuff
95 v2f m_tx_size = v2f(1,1);
97 bool m_initial_tx_basepos_set = false;
98 bool m_tx_select_horiz_by_yawpitch = false;
99 v2s32 m_animation_range;
100 float m_animation_speed = 15.0f;
101 float m_animation_blend = 0.0f;
102 bool m_animation_loop = true;
103 // stores position and rotation for each bone name
104 std::unordered_map<std::string, core::vector2d<v3f>> m_bone_position;
105 std::string m_attachment_bone = "";
106 v3f m_attachment_position;
107 v3f m_attachment_rotation;
108 bool m_attached_to_local = false;
109 int m_anim_frame = 0;
110 int m_anim_num_frames = 1;
111 float m_anim_framelength = 0.2f;
112 float m_anim_timer = 0.0f;
113 ItemGroupList m_armor_groups;
114 float m_reset_textures_timer = -1.0f;
115 // stores texture modifier before punch update
116 std::string m_previous_texture_modifier = "";
117 // last applied texture modifier
118 std::string m_current_texture_modifier = "";
119 bool m_visuals_expired = false;
120 float m_step_distance_counter = 0.0f;
121 u8 m_last_light = 255;
122 bool m_is_visible = false;
125 std::vector<u16> m_children;
128 GenericCAO(Client *client, ClientEnvironment *env);
132 static ClientActiveObject* create(Client *client, ClientEnvironment *env)
134 return new GenericCAO(client, env);
137 inline ActiveObjectType getType() const
139 return ACTIVEOBJECT_TYPE_GENERIC;
141 inline const ItemGroupList &getGroups() const
143 return m_armor_groups;
145 void initialize(const std::string &data);
147 void processInitData(const std::string &data);
149 bool getCollisionBox(aabb3f *toset) const;
151 bool collideWithObjects() const;
153 virtual bool getSelectionBox(aabb3f *toset) const;
157 inline const v3f &getRotation()
162 const bool isImmortal();
164 scene::ISceneNode *getSceneNode();
166 scene::IAnimatedMeshSceneNode *getAnimatedMeshSceneNode();
168 // m_matrixnode controls the position and rotation of the child node
169 // for all scene nodes, as a workaround for an Irrlicht problem with
170 // rotations. The child node's position can't be used because it's
171 // rotated, and must remain as 0.
172 // Note that m_matrixnode.setPosition() shouldn't be called. Use
173 // m_matrixnode->getRelativeTransformationMatrix().setTranslation()
174 // instead (aka getPosRotMatrix().setTranslation()).
175 inline core::matrix4 &getPosRotMatrix()
177 assert(m_matrixnode);
178 return m_matrixnode->getRelativeTransformationMatrix();
181 inline f32 getStepHeight() const
183 return m_prop.stepheight;
186 inline bool isLocalPlayer() const
188 return m_is_local_player;
191 inline bool isVisible() const
196 inline void setVisible(bool toset)
198 m_is_visible = toset;
201 void setChildrenVisible(bool toset);
203 ClientActiveObject *getParent() const;
205 void setAttachments();
207 void removeFromScene(bool permanent);
209 void addToScene(ITextureSource *tsrc);
211 inline void expireVisuals()
213 m_visuals_expired = true;
216 void updateLight(u8 light_at_pos);
218 void updateLightNoCheck(u8 light_at_pos);
220 v3s16 getLightPosition();
222 void updateNodePos();
224 void step(float dtime, ClientEnvironment *env);
226 void updateTexturePos();
228 // ffs this HAS TO BE a string copy! See #5739 if you think otherwise
229 // Reason: updateTextures(m_previous_texture_modifier);
230 void updateTextures(std::string mod);
232 void updateAnimation();
234 void updateAnimationSpeed();
236 void updateBonePosition();
238 void updateAttachments();
240 void processMessage(const std::string &data);
242 bool directReportPunch(v3f dir, const ItemStack *punchitem=NULL,
243 float time_from_last_punch=1000000);
245 std::string debugInfoText();
247 std::string infoText()
249 return m_prop.infotext;