2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / GameLogic / SCA_PropertySensor.h
1 /**
2  * Property sensor
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef __KX_PROPERTYSENSOR
33 #define __KX_PROPERTYSENSOR
34
35 #include "SCA_ISensor.h"
36
37 class SCA_PropertySensor : public SCA_ISensor
38 {
39         Py_Header;
40         //class CExpression*    m_rightexpr;
41         int                             m_checktype;
42         STR_String              m_checkpropval;
43         STR_String              m_checkpropmaxval;
44         STR_String              m_checkpropname;
45         STR_String              m_previoustext;
46         bool                    m_lastresult;
47         bool                    m_recentresult;
48         CExpression*    m_range_expr;
49
50  protected:
51
52 public:
53         enum KX_PROPSENSOR_TYPE {
54                 KX_PROPSENSOR_NODEF = 0,
55                 KX_PROPSENSOR_EQUAL,
56                 KX_PROPSENSOR_NOTEQUAL,
57                 KX_PROPSENSOR_INTERVAL,
58                 KX_PROPSENSOR_CHANGED,
59                 KX_PROPSENSOR_EXPRESSION,
60                 KX_PROPSENSOR_MAX
61         };
62
63         const STR_String S_KX_PROPSENSOR_EQ_STRING;
64         
65         SCA_PropertySensor(class SCA_EventManager* eventmgr,
66                                           SCA_IObject* gameobj,
67                                           const STR_String& propname,
68                                           const STR_String& propval,
69                                           const STR_String& propmaxval,
70                                           KX_PROPSENSOR_TYPE checktype,
71                                           PyTypeObject* T=&Type );
72         
73         /** 
74          *  For property sensor, it is used to release the pre-calculated expression
75          *  so that self references are removed before the sensor itself is released
76          */
77         virtual void Delete();
78         virtual ~SCA_PropertySensor();
79         virtual CValue* GetReplica();
80         virtual void Init();
81         void    PrecalculateRangeExpression();
82         bool    CheckPropertyCondition();
83
84         virtual bool Evaluate(CValue* event);
85         virtual bool    IsPositiveTrigger();
86         virtual CValue*         FindIdentifier(const STR_String& identifiername);
87
88         /* --------------------------------------------------------------------- */
89         /* Python interface ---------------------------------------------------- */
90         /* --------------------------------------------------------------------- */
91
92         virtual PyObject* py_getattro(PyObject *attr);
93         virtual int py_setattro(PyObject *attr, PyObject *value);
94
95         /* 1. getType */
96         KX_PYMETHOD_DOC_NOARGS(SCA_PropertySensor,GetType);
97         /* 2. setType */
98         KX_PYMETHOD_DOC_VARARGS(SCA_PropertySensor,SetType);
99         /* 3. setProperty */
100         KX_PYMETHOD_DOC_VARARGS(SCA_PropertySensor,SetProperty);
101         /* 4. getProperty */
102         KX_PYMETHOD_DOC_NOARGS(SCA_PropertySensor,GetProperty);
103         /* 5. getValue */
104         KX_PYMETHOD_DOC_NOARGS(SCA_PropertySensor,GetValue);
105         /* 6. setValue */
106         KX_PYMETHOD_DOC_VARARGS(SCA_PropertySensor,SetValue);
107         /**
108          * Test whether this is a sensible value (type check)
109          */
110         static int validValueForProperty(void* self, const PyAttributeDef*);
111 };
112
113 #endif
114