Patch to change license to GPL only, from GSR.
[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         /**
51          * Test whether this is a sensible value (type check)
52          */
53         bool validValueForProperty(char *val, STR_String &prop);
54  protected:
55
56 public:
57         enum KX_PROPSENSOR_TYPE {
58                 KX_PROPSENSOR_NODEF = 0,
59                 KX_PROPSENSOR_EQUAL,
60                 KX_PROPSENSOR_NOTEQUAL,
61                 KX_PROPSENSOR_INTERVAL,
62                 KX_PROPSENSOR_CHANGED,
63                 KX_PROPSENSOR_EXPRESSION,
64                 KX_PROPSENSOR_MAX
65         };
66
67         const STR_String S_KX_PROPSENSOR_EQ_STRING;
68         
69         SCA_PropertySensor(class SCA_EventManager* eventmgr,
70                                           SCA_IObject* gameobj,
71                                           const STR_String& propname,
72                                           const STR_String& propval,
73                                           const STR_String& propmaxval,
74                                           KX_PROPSENSOR_TYPE checktype,
75                                           PyTypeObject* T=&Type );
76         
77         virtual ~SCA_PropertySensor();
78         virtual CValue* GetReplica();
79         void    PrecalculateRangeExpression();
80         bool    CheckPropertyCondition();
81
82         virtual bool Evaluate(CValue* event);
83         virtual bool    IsPositiveTrigger();
84         virtual CValue*         FindIdentifier(const STR_String& identifiername);
85
86         /* --------------------------------------------------------------------- */
87         /* Python interface ---------------------------------------------------- */
88         /* --------------------------------------------------------------------- */
89
90         virtual PyObject* _getattr(const STR_String& attr);
91
92         /* 1. getType */
93         KX_PYMETHOD_DOC(SCA_PropertySensor,GetType);
94         /* 2. setType */
95         KX_PYMETHOD_DOC(SCA_PropertySensor,SetType);
96         /* 3. setProperty */
97         KX_PYMETHOD_DOC(SCA_PropertySensor,SetProperty);
98         /* 4. getProperty */
99         KX_PYMETHOD_DOC(SCA_PropertySensor,GetProperty);
100         /* 5. getValue */
101         KX_PYMETHOD_DOC(SCA_PropertySensor,GetValue);
102         /* 6. setValue */
103         KX_PYMETHOD_DOC(SCA_PropertySensor,SetValue);
104         
105 };
106
107 #endif
108