src/clientobject.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 CLIENTOBJECT_HEADER
  21 #define CLIENTOBJECT_HEADER
  22
  23 #include "common_irrlicht.h"
  24 #include "activeobject.h"
  25
  26 /*
  27
  28 Some planning
  29 -------------
  30
  31 * Client receives a network packet with information of added objects
  32   in it
  33 * Client supplies the information to its ClientEnvironment
  34 * The environment adds the specified objects to itself
  35
  36 */
  37
  38 class ClientEnvironment;
  39 class ITextureSource;
  40 class IGameDef;
  41 class LocalPlayer;
  42 struct ItemStack;
  43
  44 class ClientActiveObject : public ActiveObject
  45 {
  46 public:
  47         ClientActiveObject(u16 id, IGameDef *gamedef, ClientEnvironment *env);
  48         virtual ~ClientActiveObject();
  49
  50         virtual void addToScene(scene::ISceneManager *smgr, ITextureSource *tsrc,
  51                         IrrlichtDevice *irr){}
  52         virtual void removeFromScene(){}
  53         // 0 <= light_at_pos <= LIGHT_SUN
  54         virtual void updateLight(u8 light_at_pos){}
  55         virtual v3s16 getLightPosition(){return v3s16(0,0,0);}
  56         virtual core::aabbox3d<f32>* getSelectionBox(){return NULL;}
  57         virtual core::aabbox3d<f32>* getCollisionBox(){return NULL;}
  58         virtual v3f getPosition(){return v3f(0,0,0);}
  59         virtual bool doShowSelectionBox(){return true;}
  60
  61         // Step object in time
  62         virtual void step(float dtime, ClientEnvironment *env){}
  63
  64         // Process a message sent by the server side object
  65         virtual void processMessage(const std::string &data){}
  66
  67         virtual std::string infoText() {return "";}
  68         virtual std::string debugInfoText() {return "";}
  69
  70         /*
  71                 This takes the return value of
  72                 ServerActiveObject::getClientInitializationData
  73         */
  74         virtual void initialize(const std::string &data){}
  75
  76         // Create a certain type of ClientActiveObject
  77         static ClientActiveObject* create(u8 type, IGameDef *gamedef,
  78                         ClientEnvironment *env);
  79
  80         // If returns true, punch will not be sent to the server
  81         virtual bool directReportPunch(v3f dir, const ItemStack *punchitem=NULL,
  82                         float time_from_last_punch=1000000)
  83         { return false; }
  84
  85 protected:
  86         // Used for creating objects based on type
  87         typedef ClientActiveObject* (*Factory)(IGameDef *gamedef, ClientEnvironment *env);
  88         static void registerType(u16 type, Factory f);
  89         IGameDef *m_gamedef;
  90         ClientEnvironment *m_env;
  91 private:
  92         // Used for creating objects based on type
  93         static core::map<u16, Factory> m_types;
  94 };
  95
  96 struct DistanceSortedActiveObject
  97 {
  98         ClientActiveObject *obj;
  99         f32 d;
 100
 101         DistanceSortedActiveObject(ClientActiveObject *a_obj, f32 a_d)
 102         {
 103                 obj = a_obj;
 104                 d = a_d;
 105         }
 106
 107         bool operator < (DistanceSortedActiveObject &other)
 108         {
 109                 return d < other.d;
 110         }
 111 };
 112
 113 #endif
 114