Spelling Cleanup
[blender.git] / source / gameengine / Ketsji / KXNetwork / KX_NetworkMessageSensor.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 KX_NetworkMessageSensor.h
29  *  \ingroup ketsjinet
30  *  \brief Ketsji Logic Extension: Network Message Sensor class
31  */
32 #ifndef __KX_NETWORKMESSAGESENSOR_H__
33 #define __KX_NETWORKMESSAGESENSOR_H__
34
35 #include "SCA_ISensor.h"
36
37 class KX_NetworkEventManager;
38 class NG_NetworkScene;
39
40 class KX_NetworkMessageSensor : public SCA_ISensor
41 {
42         // note: Py_Header MUST BE the first listed here
43         Py_Header
44         NG_NetworkScene        *m_NetworkScene;
45
46         // The subject we filter on.
47         STR_String m_subject;
48
49         // The number of messages caught since the last frame.
50         int m_frame_message_count;
51
52         bool m_IsUp;
53
54         class CListValue* m_BodyList;
55         class CListValue* m_SubjectList;
56 public:
57         KX_NetworkMessageSensor(
58                 KX_NetworkEventManager* eventmgr,       // our eventmanager
59                 NG_NetworkScene *NetworkScene,          // our scene
60                 SCA_IObject* gameobj,                           // the sensor controlling object
61                 const STR_String &subject
62         );
63         virtual ~KX_NetworkMessageSensor();
64
65         virtual CValue* GetReplica();
66         virtual bool Evaluate();
67         virtual bool IsPositiveTrigger();
68         virtual void Init();
69         void EndFrame();
70         
71         virtual void Replace_NetworkScene(NG_NetworkScene *val)
72         {
73                 m_NetworkScene= val;
74         };
75
76 #ifdef WITH_PYTHON
77
78         /* ------------------------------------------------------------- */
79         /* Python interface -------------------------------------------- */
80         /* ------------------------------------------------------------- */
81
82         /* attributes */
83         static PyObject*        pyattr_get_bodies(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);     
84         static PyObject*        pyattr_get_subjects(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
85
86 #endif // WITH_PYTHON
87
88 };
89
90 #endif //__KX_NETWORKMESSAGESENSOR_H__
91