Filling in branch from trunk
[blender.git] / source / gameengine / GameLogic / SCA_ILogicBrick.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef __KX_ILOGICBRICK
33 #define __KX_ILOGICBRICK
34
35 #include "Value.h"
36 #include "SCA_IObject.h"
37 #include "BoolValue.h"
38
39 class SCA_ILogicBrick : public CValue
40 {
41         Py_Header;
42 protected:
43         SCA_IObject*            m_gameobj;
44         int                                     m_Execute_Priority;
45         int                                     m_Execute_Ueber_Priority;
46
47         bool                            m_bActive;
48         CValue*                         m_eventval;
49         STR_String                      m_text;
50         STR_String                      m_name;
51         //unsigned long         m_drawcolor;
52         void RegisterEvent(CValue* eventval);
53         void RemoveEvent();
54         CValue* GetEvent();
55
56 public:
57         SCA_ILogicBrick(SCA_IObject* gameobj,PyTypeObject* T );
58         virtual ~SCA_ILogicBrick();
59
60         void SetExecutePriority(int execute_Priority);
61         void SetUeberExecutePriority(int execute_Priority);
62
63         SCA_IObject*    GetParent();
64         virtual void    ReParent(SCA_IObject* parent);
65
66         // act as a BoolValue (with value IsPositiveTrigger)
67         virtual CValue* Calc(VALUE_OPERATOR op, CValue *val);
68         virtual CValue* CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val);
69
70         virtual const STR_String &      GetText();
71         virtual float           GetNumber();
72         virtual STR_String      GetName();
73         virtual void            SetName(STR_String name);
74         virtual void            ReplicaSetName(STR_String name);
75                 
76         bool                            IsActive();
77         void                            SetActive(bool active) ;
78
79         virtual bool            LessComparedTo(SCA_ILogicBrick* other);
80         
81         virtual PyObject* _getattr(const STR_String& attr);
82
83         static class SCA_LogicManager*  m_sCurrentLogicManager;
84
85
86         // python methods
87
88         KX_PYMETHOD(SCA_ILogicBrick,GetOwner);
89         KX_PYMETHOD(SCA_ILogicBrick,SetExecutePriority);
90         KX_PYMETHOD(SCA_ILogicBrick,GetExecutePriority);
91
92         enum KX_BOOL_TYPE {
93                 KX_BOOL_NODEF = 0,
94                 KX_TRUE,
95                 KX_FALSE,
96                 KX_BOOL_MAX
97         };
98
99
100 protected: 
101         /* Some conversions to go with the bool type. */
102         /** Convert a KX_TRUE, KX_FALSE in Python to a c++ value. */
103         bool PyArgToBool(int boolArg);
104
105         /** Convert a a c++ value to KX_TRUE, KX_FALSE in Python. */
106         PyObject* BoolToPyArg(bool);
107
108         
109 };
110
111 #endif
112