Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/pickups/src/network/Synchronisable.h @ 2191

Last change on this file since 2191 was 1910, checked in by scheusso, 16 years ago

reverted a change in ogre.cfg-init

  • Property svn:eol-style set to native
File size: 4.5 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Oliver Scheuss, (C) 2007
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _Synchronisable_H__
30#define _Synchronisable_H__
31
32#include "NetworkPrereqs.h"
33
34#include <list>
35#include <map>
36#include <queue>
37#include "util/Integers.h"
38#include "core/OrxonoxClass.h"
39#include "core/XMLIncludes.h"
40#include "NetworkCallback.h"
41#include "util/Integers.h"
42
43#define REGISTERDATA(varname) registerVar(&varname, sizeof(varname), network::DATA)
44#define REGISTERDATA_WITHDIR(varname, mode) registerVar(&varname, sizeof(varname), network::DATA, mode)
45#define REGISTERSTRING(stringname) registerVar(&stringname, stringname.length()+1, network::STRING)
46#define REGISTERSTRING_WITHDIR(stringname, mode) registerVar(&stringname, stringname.length()+1, network::STRING, mode)
47
48//TODO: this is only a very ugly hack ...
49namespace orxonox{
50class SpaceShip;
51}
52
53namespace network
54{
55  namespace direction{
56    enum syncdirection{
57      toclient=0x1,
58      toserver=0x2,
59      bidirectional=0x3
60    };
61  }
62 
63  namespace syncmode{
64    enum mode{
65      one=0,
66      always=1
67    };
68  }
69 
70  enum variableType{
71    DATA,
72    STRING,
73  };
74
75  struct synchronisableHeader{
76    uint32_t size:31;
77    bool dataAvailable:1;
78    uint32_t objectID;
79    uint32_t classID;
80  };
81
82  typedef struct synchronisableVariable{
83    unsigned int size;
84    int mode; // this determines in which direction the variable gets synchronised
85    void *var;
86    variableType type;
87    NetworkCallbackBase *callback;
88  }SYNCVAR;
89
90  /**
91  * This class is the base class of all the Objects in the universe that need to be synchronised over the network
92   * Every class, that inherits from this class has to link the DATA THAT NEEDS TO BE SYNCHRONISED into the linked list.
93  * @author Oliver Scheuss
94  */
95  class _NetworkExport Synchronisable : virtual public orxonox::OrxonoxClass{
96  public:
97    friend class packet::Gamestate;
98    friend class GamestateClient;
99    friend class Server;
100    friend class orxonox::SpaceShip;
101    virtual ~Synchronisable();
102
103   
104    virtual bool create();
105    static void setClient(bool b);
106   
107    static Synchronisable *fabricate(uint8_t*& mem, int mode=0x0);
108    static bool deleteObject(unsigned int objectID);
109    static Synchronisable *getSynchronisable(unsigned int objectID);
110    static unsigned int getNumberOfDeletedObject(){ return deletedObjects_.size(); }
111    static unsigned int popDeletedObject(){ unsigned int i = deletedObjects_.front(); deletedObjects_.pop(); return i; }
112   
113    inline unsigned int getObjectID(){return objectID;}
114    inline unsigned int getClassID(){return classID;}
115  protected:
116    Synchronisable();
117    void registerVar(void *var, int size, variableType t, int mode=1, NetworkCallbackBase *cb=0);
118    void setObjectMode(int mode);
119    void setObjectFrequency(unsigned int freq){ objectFrequency_ = freq; }
120    virtual void registerAllVariables()=0;
121   
122   
123  private:
124    bool getData(uint8_t*& men, unsigned int id, int mode=0x0);
125    uint32_t getSize(unsigned int id, int mode=0x0);
126    bool updateData(uint8_t*& mem, int mode=0x0);
127    bool isMyData(uint8_t* mem);
128    bool doSelection(unsigned int id);
129    bool isMyTick(unsigned int id);
130   
131    unsigned int objectID;
132    unsigned int classID;
133   
134    std::list<synchronisableVariable *> *syncList;
135    static int state_; // detemines wheter we are server (default) or client
136    bool backsync_; // if true the variables with mode > 1 will be synchronised to server (client -> server)
137    unsigned int objectFrequency_;
138    int objectMode_;
139    static std::map<unsigned int, Synchronisable *> objectMap_;
140    static std::queue<unsigned int> deletedObjects_;
141  };
142}
143
144#endif /* _Synchronisable_H__ */
Note: See TracBrowser for help on using the repository browser.