rebranch from 2.5
[blender.git] / source / gameengine / Network / NG_NetworkScene.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * NetworkSceneManagement generic class
29  */
30 #ifndef __NG_NETWORKSCENE_H
31 #define __NG_NETWORKSCENE_H
32
33 #include "GEN_Map.h"
34 #include "STR_HashedString.h"
35 #include <vector>
36
37 class NG_NetworkDeviceInterface;
38
39 class NG_NetworkScene
40 {
41         class NG_NetworkDeviceInterface *m_networkdevice;       
42         GEN_Map<STR_HashedString, class NG_NetworkObject *> m_networkObjects;
43
44         // GEN_Maps used as a 'Bloom' filter
45         typedef GEN_Map<STR_HashedString, std::vector<class NG_NetworkMessage*>* > TMessageMap;
46         TMessageMap m_messagesByDestinationName;
47         TMessageMap m_messagesBySenderName;
48         TMessageMap m_messagesBySubject;
49
50 public: 
51         NG_NetworkScene(NG_NetworkDeviceInterface *nic);
52         ~NG_NetworkScene();
53
54         /**
55          * progress one frame, handle all network traffic
56          */
57         void proceed(double curtime);
58
59         /**
60          * add a networkobject to the scene
61          */
62         void AddObject(NG_NetworkObject* object);
63
64         /**
65          * remove a networkobject to the scene
66          */
67         void RemoveObject(NG_NetworkObject* object);
68
69         /**
70          * remove all objects at once
71          */
72         void RemoveAllObjects();
73
74         /**
75          *      send a message (ascii text) over the network
76          */
77         void SendMessage(const STR_String& to,const STR_String& from,const STR_String& subject,const STR_String& message);
78
79         /**
80          * find an object by name
81          */
82         NG_NetworkObject* FindNetworkObject(const STR_String& objname);
83
84         bool    ConstraintsAreValid(const STR_String& from,const STR_String& subject,class NG_NetworkMessage* message);
85         vector<NG_NetworkMessage*> FindMessages(const STR_String& to,const STR_String& from,const STR_String& subject,bool spamallowed);
86
87 protected:
88         /**
89          * Releases messages in message map members.
90          */
91         void ClearAllMessageMaps(void);
92
93         /**
94          * Releases messages for the given message map.
95          * @param map   Message map with messages.
96          */
97         void ClearMessageMap(TMessageMap& map); 
98 };
99
100 #endif //__NG_NETWORKSCENE_H
101