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