src/content_cao.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 #pragma once
  21
  22 #include <map>
  23 #include "irrlichttypes_extrabloated.h"
  24 #include "clientobject.h"
  25 #include "object_properties.h"
  26 #include "itemgroup.h"
  27 #include "constants.h"
  28
  29 class Camera;
  30 class Client;
  31 struct Nametag;
  32
  33 /*
  34         SmoothTranslator
  35 */
  36
  37 struct SmoothTranslator
  38 {
  39         v3f vect_old;
  40         v3f vect_show;
  41         v3f vect_aim;
  42         f32 anim_counter = 0;
  43         f32 anim_time = 0;
  44         f32 anim_time_counter = 0;
  45         bool aim_is_end = true;
  46
  47         SmoothTranslator() = default;
  48
  49         void init(v3f vect);
  50
  51         void update(v3f vect_new, bool is_end_position=false, float update_interval=-1);
  52
  53         void translate(f32 dtime);
  54 };
  55
  56 class GenericCAO : public ClientActiveObject
  57 {
  58 private:
  59         // Only set at initialization
  60         std::string m_name = "";
  61         bool m_is_player = false;
  62         bool m_is_local_player = false;
  63         // Property-ish things
  64         ObjectProperties m_prop;
  65         //
  66         scene::ISceneManager *m_smgr = nullptr;
  67         Client *m_client = nullptr;
  68         aabb3f m_selection_box = aabb3f(-BS/3.,-BS/3.,-BS/3., BS/3.,BS/3.,BS/3.);
  69         scene::IMeshSceneNode *m_meshnode = nullptr;
  70         scene::IAnimatedMeshSceneNode *m_animated_meshnode = nullptr;
  71         WieldMeshSceneNode *m_wield_meshnode = nullptr;
  72         scene::IBillboardSceneNode *m_spritenode = nullptr;
  73         Nametag *m_nametag = nullptr;
  74         v3f m_position = v3f(0.0f, 10.0f * BS, 0);
  75         v3f m_velocity;
  76         v3f m_acceleration;
  77         float m_yaw = 0.0f;
  78         s16 m_hp = 1;
  79         SmoothTranslator pos_translator;
  80         // Spritesheet/animation stuff
  81         v2f m_tx_size = v2f(1,1);
  82         v2s16 m_tx_basepos;
  83         bool m_initial_tx_basepos_set = false;
  84         bool m_tx_select_horiz_by_yawpitch = false;
  85         v2s32 m_animation_range;
  86         int m_animation_speed = 15;
  87         int m_animation_blend = 0;
  88         bool m_animation_loop = true;
  89         // stores position and rotation for each bone name
  90         std::unordered_map<std::string, core::vector2d<v3f>> m_bone_position;
  91         std::string m_attachment_bone = "";
  92         v3f m_attachment_position;
  93         v3f m_attachment_rotation;
  94         bool m_attached_to_local = false;
  95         int m_anim_frame = 0;
  96         int m_anim_num_frames = 1;
  97         float m_anim_framelength = 0.2f;
  98         float m_anim_timer = 0.0f;
  99         ItemGroupList m_armor_groups;
 100         float m_reset_textures_timer = -1.0f;
 101         // stores texture modifier before punch update
 102         std::string m_previous_texture_modifier = "";
 103         // last applied texture modifier
 104         std::string m_current_texture_modifier = "";
 105         bool m_visuals_expired = false;
 106         float m_step_distance_counter = 0.0f;
 107         u8 m_last_light = 255;
 108         bool m_is_visible = false;
 109
 110         std::vector<u16> m_children;
 111
 112 public:
 113         GenericCAO(Client *client, ClientEnvironment *env);
 114
 115         ~GenericCAO();
 116
 117         static ClientActiveObject* create(Client *client, ClientEnvironment *env)
 118         {
 119                 return new GenericCAO(client, env);
 120         }
 121
 122         inline ActiveObjectType getType() const
 123         {
 124                 return ACTIVEOBJECT_TYPE_GENERIC;
 125         }
 126
 127         void initialize(const std::string &data);
 128
 129         void processInitData(const std::string &data);
 130
 131         ClientActiveObject *getParent() const;
 132
 133         bool getCollisionBox(aabb3f *toset) const;
 134
 135         bool collideWithObjects() const;
 136
 137         virtual bool getSelectionBox(aabb3f *toset) const;
 138
 139         v3f getPosition();
 140         inline float getYaw() const
 141         {
 142                 return m_yaw;
 143         }
 144
 145         scene::ISceneNode *getSceneNode();
 146
 147         scene::IAnimatedMeshSceneNode *getAnimatedMeshSceneNode();
 148
 149         inline f32 getStepHeight() const
 150         {
 151                 return m_prop.stepheight;
 152         }
 153
 154         inline bool isLocalPlayer() const
 155         {
 156                 return m_is_local_player;
 157         }
 158
 159         inline bool isVisible() const
 160         {
 161                 return m_is_visible;
 162         }
 163
 164         inline void setVisible(bool toset)
 165         {
 166                 m_is_visible = toset;
 167         }
 168
 169         void setChildrenVisible(bool toset);
 170
 171         void setAttachments();
 172
 173         void removeFromScene(bool permanent);
 174
 175         void addToScene(ITextureSource *tsrc);
 176
 177         inline void expireVisuals()
 178         {
 179                 m_visuals_expired = true;
 180         }
 181
 182         void updateLight(u8 light_at_pos);
 183
 184         void updateLightNoCheck(u8 light_at_pos);
 185
 186         v3s16 getLightPosition();
 187
 188         void updateNodePos();
 189
 190         void step(float dtime, ClientEnvironment *env);
 191
 192         void updateTexturePos();
 193
 194         // std::string copy is mandatory as mod can be a class member and there is a swap
 195         // on those class members
 196         void updateTextures(std::string mod);
 197
 198         void updateAnimation();
 199
 200         void updateBonePosition();
 201
 202         void updateAttachments();
 203
 204         void processMessage(const std::string &data);
 205
 206         bool directReportPunch(v3f dir, const ItemStack *punchitem=NULL,
 207                         float time_from_last_punch=1000000);
 208
 209         std::string debugInfoText();
 210
 211         std::string infoText()
 212         {
 213                 return m_prop.infotext;
 214         }
 215 };