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