Initial revision
[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 class NG_NetworkDeviceInterface;
40
41 class NG_NetworkScene
42 {
43         class NG_NetworkDeviceInterface *m_networkdevice;       
44         GEN_Map<STR_HashedString, class NG_NetworkObject *> m_networkObjects;
45
46         // GEN_Maps used as a 'Bloom' filter
47         typedef GEN_Map<STR_HashedString, std::vector<class NG_NetworkMessage*>* > TMessageMap;
48         TMessageMap m_messagesByDestinationName;
49         TMessageMap m_messagesBySenderName;
50         TMessageMap m_messagesBySubject;
51
52 public: 
53         NG_NetworkScene(NG_NetworkDeviceInterface *nic);
54         ~NG_NetworkScene();
55
56         /**
57          * progress one frame, handle all network traffic
58          */
59         void proceed(double curtime, double deltatime);
60
61         /**
62          * add a networkobject to the scene
63          */
64         void AddObject(NG_NetworkObject* object);
65
66         /**
67          * remove a networkobject to the scene
68          */
69         void RemoveObject(NG_NetworkObject* object);
70
71         /**
72          * remove all objects at once
73          */
74         void RemoveAllObjects();
75
76         /**
77          *      send a message (ascii text) over the network
78          */
79         void SendMessage(const STR_String& to,const STR_String& from,const STR_String& subject,const STR_String& message);
80
81         /**
82          * find an object by name
83          */
84         NG_NetworkObject* FindNetworkObject(const STR_String& objname);
85
86         bool    ConstraintsAreValid(const STR_String& from,const STR_String& subject,class NG_NetworkMessage* message);
87         vector<NG_NetworkMessage*> FindMessages(const STR_String& to,const STR_String& from,const STR_String& subject,bool spamallowed);
88
89 protected:
90         /**
91          * Releases messages in message map members.
92          */
93         void ClearAllMessageMaps(void);
94
95         /**
96          * Releases messages for the given message map.
97          * @param map   Message map with messages.
98          */
99         void ClearMessageMap(TMessageMap& map); 
100 };
101
102 #endif //__NG_NETWORKSCENE_H