[#19232] (2.5) Correction of cmake for windows about audio (jack and openal)
[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 #ifdef WITH_CXX_GUARDEDALLOC
38 #include "MEM_guardedalloc.h"
39 #endif
40
41 //MSVC defines SendMessage as a win api function, even though we aren't using it
42 #ifdef SendMessage
43         #undef SendMessage
44 #endif
45
46 class NG_NetworkDeviceInterface;
47
48 class NG_NetworkScene
49 {
50         class NG_NetworkDeviceInterface *m_networkdevice;       
51         GEN_Map<STR_HashedString, class NG_NetworkObject *> m_networkObjects;
52
53         // GEN_Maps used as a 'Bloom' filter
54         typedef GEN_Map<STR_HashedString, std::vector<class NG_NetworkMessage*>* > TMessageMap;
55         TMessageMap m_messagesByDestinationName;
56         TMessageMap m_messagesBySenderName;
57         TMessageMap m_messagesBySubject;
58
59 public:
60         NG_NetworkScene(NG_NetworkDeviceInterface *nic);
61         ~NG_NetworkScene();
62
63         /**
64          * progress one frame, handle all network traffic
65          */
66         void proceed(double curtime);
67
68         /**
69          * add a networkobject to the scene
70          */
71         void AddObject(NG_NetworkObject* object);
72
73         /**
74          * remove a networkobject to the scene
75          */
76         void RemoveObject(NG_NetworkObject* object);
77
78         /**
79          * remove all objects at once
80          */
81         void RemoveAllObjects();
82
83         /**
84          *      send a message (ascii text) over the network
85          */
86         void SendMessage(const STR_String& to,const STR_String& from,const STR_String& subject,const STR_String& message);
87
88         /**
89          * find an object by name
90          */
91         NG_NetworkObject* FindNetworkObject(const STR_String& objname);
92
93         bool    ConstraintsAreValid(const STR_String& from,const STR_String& subject,class NG_NetworkMessage* message);
94         vector<NG_NetworkMessage*> FindMessages(const STR_String& to,const STR_String& from,const STR_String& subject,bool spamallowed);
95
96 protected:
97         /**
98          * Releases messages in message map members.
99          */
100         void ClearAllMessageMaps(void);
101
102         /**
103          * Releases messages for the given message map.
104          * @param map   Message map with messages.
105          */
106         void ClearMessageMap(TMessageMap& map); 
107
108
109 #ifdef WITH_CXX_GUARDEDALLOC
110 public:
111         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:NG_NetworkScene"); }
112         void operator delete( void *mem ) { MEM_freeN(mem); }
113 #endif
114 };
115
116 #endif //__NG_NETWORKSCENE_H
117