svn merge -r 14236:14505 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / gameengine / GameLogic / SCA_ILogicBrick.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  */
29 #ifndef __KX_ILOGICBRICK
30 #define __KX_ILOGICBRICK
31
32 #include "Value.h"
33 #include "SCA_IObject.h"
34 #include "BoolValue.h"
35
36 class SCA_ILogicBrick : public CValue
37 {
38         Py_Header;
39 protected:
40         SCA_IObject*            m_gameobj;
41         int                                     m_Execute_Priority;
42         int                                     m_Execute_Ueber_Priority;
43
44         bool                            m_bActive;
45         CValue*                         m_eventval;
46         STR_String                      m_text;
47         STR_String                      m_name;
48         //unsigned long         m_drawcolor;
49         void RegisterEvent(CValue* eventval);
50         void RemoveEvent();
51         CValue* GetEvent();
52
53 public:
54         SCA_ILogicBrick(SCA_IObject* gameobj,PyTypeObject* T );
55         virtual ~SCA_ILogicBrick();
56
57         void SetExecutePriority(int execute_Priority);
58         void SetUeberExecutePriority(int execute_Priority);
59
60         SCA_IObject*    GetParent();
61         virtual void    ReParent(SCA_IObject* parent);
62
63         // act as a BoolValue (with value IsPositiveTrigger)
64         virtual CValue* Calc(VALUE_OPERATOR op, CValue *val);
65         virtual CValue* CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val);
66
67         virtual const STR_String &      GetText();
68         virtual float           GetNumber();
69         virtual STR_String      GetName();
70         virtual void            SetName(STR_String name);
71         virtual void            ReplicaSetName(STR_String name);
72                 
73         bool                            IsActive();
74         void                            SetActive(bool active) ;
75
76         virtual bool            LessComparedTo(SCA_ILogicBrick* other);
77         
78         virtual PyObject* _getattr(const STR_String& attr);
79
80         static class SCA_LogicManager*  m_sCurrentLogicManager;
81
82
83         // python methods
84
85         KX_PYMETHOD(SCA_ILogicBrick,GetOwner);
86         KX_PYMETHOD(SCA_ILogicBrick,SetExecutePriority);
87         KX_PYMETHOD(SCA_ILogicBrick,GetExecutePriority);
88
89         enum KX_BOOL_TYPE {
90                 KX_BOOL_NODEF = 0,
91                 KX_TRUE,
92                 KX_FALSE,
93                 KX_BOOL_MAX
94         };
95
96
97 protected: 
98         /* Some conversions to go with the bool type. */
99         /** Convert a KX_TRUE, KX_FALSE in Python to a c++ value. */
100         bool PyArgToBool(int boolArg);
101
102         /** Convert a a c++ value to KX_TRUE, KX_FALSE in Python. */
103         PyObject* BoolToPyArg(bool);
104
105         
106 };
107
108 #endif
109