src/client/clientobject.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 "irrlichttypes_extrabloated.h"
  23 #include "activeobject.h"
  24 #include <unordered_map>
  25 #include <unordered_set>
  26
  27
  28 class ClientEnvironment;
  29 class ITextureSource;
  30 class Client;
  31 class IGameDef;
  32 class LocalPlayer;
  33 struct ItemStack;
  34 class WieldMeshSceneNode;
  35
  36 class ClientActiveObject : public ActiveObject
  37 {
  38 public:
  39         ClientActiveObject(u16 id, Client *client, ClientEnvironment *env);
  40         virtual ~ClientActiveObject();
  41
  42         virtual void addToScene(ITextureSource *tsrc) {}
  43         virtual void removeFromScene(bool permanent) {}
  44         // 0 <= light_at_pos <= LIGHT_SUN
  45         virtual void updateLight(u8 light_at_pos) {}
  46         virtual void updateLightNoCheck(u8 light_at_pos) {}
  47         virtual v3s16 getLightPosition() { return v3s16(0, 0, 0); }
  48         virtual bool getCollisionBox(aabb3f *toset) const { return false; }
  49         virtual bool getSelectionBox(aabb3f *toset) const { return false; }
  50         virtual bool collideWithObjects() const { return false; }
  51         virtual const v3f getPosition() const { return v3f(0.0f); }
  52         virtual scene::ISceneNode *getSceneNode() { return NULL; }
  53         virtual scene::IAnimatedMeshSceneNode *getAnimatedMeshSceneNode() { return NULL; }
  54         virtual bool isLocalPlayer() const { return false; }
  55
  56         virtual ClientActiveObject *getParent() const { return nullptr; };
  57         virtual const std::unordered_set<int> &getAttachmentChildIds() const
  58         { static std::unordered_set<int> rv; return rv; }
  59         virtual void updateAttachments() {};
  60
  61         virtual bool doShowSelectionBox() { return true; }
  62
  63         // Step object in time
  64         virtual void step(float dtime, ClientEnvironment *env) {}
  65
  66         // Process a message sent by the server side object
  67         virtual void processMessage(const std::string &data) {}
  68
  69         virtual std::string infoText() { return ""; }
  70         virtual std::string debugInfoText() { return ""; }
  71
  72         /*
  73                 This takes the return value of
  74                 ServerActiveObject::getClientInitializationData
  75         */
  76         virtual void initialize(const std::string &data) {}
  77
  78         // Create a certain type of ClientActiveObject
  79         static ClientActiveObject *create(ActiveObjectType type, Client *client,
  80                 ClientEnvironment *env);
  81
  82         // If returns true, punch will not be sent to the server
  83         virtual bool directReportPunch(v3f dir, const ItemStack *punchitem = nullptr,
  84                 float time_from_last_punch = 1000000) { return false; }
  85
  86 protected:
  87         // Used for creating objects based on type
  88         typedef ClientActiveObject *(*Factory)(Client *client, ClientEnvironment *env);
  89         static void registerType(u16 type, Factory f);
  90         Client *m_client;
  91         ClientEnvironment *m_env;
  92 private:
  93         // Used for creating objects based on type
  94         static std::unordered_map<u16, Factory> m_types;
  95 };
  96
  97 class DistanceSortedActiveObject
  98 {
  99 public:
 100         ClientActiveObject *obj;
 101
 102         DistanceSortedActiveObject(ClientActiveObject *a_obj, f32 a_d)
 103         {
 104                 obj = a_obj;
 105                 d = a_d;
 106         }
 107
 108         bool operator < (const DistanceSortedActiveObject &other) const
 109         {
 110                 return d < other.d;
 111         }
 112
 113 private:
 114         f32 d;
 115 };