NLA SoC: Merge from 2.5
[blender.git] / source / gameengine / Ketsji / KXNetwork / KX_NetworkMessageSensor.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  * Ketsji Logic Extenstion: Network Message Sensor class
29  */
30 #ifndef __KX_NETWORKMESSAGE_SENSOR_H
31 #define __KX_NETWORKMESSAGE_SENSOR_H
32
33 #include "SCA_ISensor.h"
34
35 class KX_NetworkEventManager;
36 class NG_NetworkScene;
37
38 class KX_NetworkMessageSensor : public SCA_ISensor
39 {
40         // note: Py_Header MUST BE the first listed here
41         Py_Header;
42         KX_NetworkEventManager *m_Networkeventmgr;
43         NG_NetworkScene        *m_NetworkScene;
44
45         // The subject we filter on.
46         STR_String m_subject;
47
48         // The number of messages caught since the last frame.
49         int m_frame_message_count;
50
51         bool m_IsUp;
52
53         class CListValue* m_BodyList;
54         class CListValue* m_SubjectList;
55 public:
56         KX_NetworkMessageSensor(
57                 KX_NetworkEventManager* eventmgr,       // our eventmanager
58                 NG_NetworkScene *NetworkScene,          // our scene
59                 SCA_IObject* gameobj,                           // the sensor controlling object
60                 const STR_String &subject
61         );
62         virtual ~KX_NetworkMessageSensor();
63
64         virtual CValue* GetReplica();
65         virtual bool Evaluate();
66         virtual bool IsPositiveTrigger();
67         virtual void Init();
68         void EndFrame();
69         
70         /* ------------------------------------------------------------- */
71         /* Python interface -------------------------------------------- */
72         /* ------------------------------------------------------------- */
73
74         // Deprecated ----->
75         KX_PYMETHOD_DOC_O(KX_NetworkMessageSensor, SetSubjectFilterText);
76         KX_PYMETHOD_DOC_NOARGS(KX_NetworkMessageSensor, GetFrameMessageCount);
77         KX_PYMETHOD_DOC_NOARGS(KX_NetworkMessageSensor, GetBodies);
78         KX_PYMETHOD_DOC_NOARGS(KX_NetworkMessageSensor, GetSubject);
79         KX_PYMETHOD_DOC_NOARGS(KX_NetworkMessageSensor, GetSubjects);
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 };
87
88 #endif //__KX_NETWORKMESSAGE_SENSOR_H
89