manual merge trunk -r 23037
[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 #include "GEN_Map.h"
36 #include "GEN_HashedPtr.h"
37
38 class SCA_ILogicBrick : public CValue
39 {
40         Py_Header;
41 protected:
42         SCA_IObject*            m_gameobj;
43         int                                     m_Execute_Priority;
44         int                                     m_Execute_Ueber_Priority;
45
46         bool                            m_bActive;
47         CValue*                         m_eventval;
48         STR_String                      m_text;
49         STR_String                      m_name;
50         //unsigned long         m_drawcolor;
51         void RegisterEvent(CValue* eventval);
52         void RemoveEvent();
53         CValue* GetEvent();
54
55 public:
56         SCA_ILogicBrick(SCA_IObject* gameobj);
57         virtual ~SCA_ILogicBrick();
58
59         void SetExecutePriority(int execute_Priority);
60         void SetUeberExecutePriority(int execute_Priority);
61
62         SCA_IObject*    GetParent() { return m_gameobj; }
63
64         virtual void    ReParent(SCA_IObject* parent);
65         virtual void    Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
66         virtual void Delete() { Release(); }
67
68         // act as a BoolValue (with value IsPositiveTrigger)
69         virtual CValue* Calc(VALUE_OPERATOR op, CValue *val);
70         virtual CValue* CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val);
71
72         virtual const STR_String &      GetText();
73         virtual double          GetNumber();
74         virtual STR_String&     GetName();
75         virtual void            SetName(const char *);
76                 
77         bool                            IsActive()
78         {
79                 return m_bActive;
80         }
81
82         void                            SetActive(bool active)
83         {
84                 m_bActive=active;
85         }
86
87         // insert in a QList at position corresponding to m_Execute_Priority
88         void                        InsertActiveQList(SG_QList& head)
89         {
90                 SG_QList::iterator<SCA_ILogicBrick> it(head);
91                 for(it.begin(); !it.end() && m_Execute_Priority > (*it)->m_Execute_Priority; ++it);
92                 it.add_back(this);
93         }
94
95         // insert in a QList at position corresponding to m_Execute_Priority
96         // inside a longer list that contains elements of other objects. 
97         // Sorting is done only between the elements of the same object.
98         // head is the head of the combined list
99         // current points to the first element of the object in the list, NULL if none yet
100         void                        InsertSelfActiveQList(SG_QList& head, SG_QList** current)
101         {
102                 if (!*current)
103                 {
104                         // first element can be put anywhere
105                         head.QAddBack(this);
106                         *current = this;
107                         return;
108                 }
109                 // note: we assume current points actually to one o our element, skip the tests
110                 SG_QList::iterator<SCA_ILogicBrick> it(head,*current);
111                 if (m_Execute_Priority <= (*it)->m_Execute_Priority)
112                 {
113                         // this element comes before the first
114                         *current = this;
115                 }
116                 else
117                 {
118                         for(++it; !it.end() && (*it)->m_gameobj == m_gameobj &&  m_Execute_Priority > (*it)->m_Execute_Priority; ++it);
119                 }
120                 it.add_back(this);
121         }
122
123         virtual bool            LessComparedTo(SCA_ILogicBrick* other);
124
125         static class SCA_LogicManager*  m_sCurrentLogicManager;
126
127
128         // python methods
129         
130         static PyObject*        pyattr_get_owner(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
131
132         // check that attribute is a property
133         static int CheckProperty(void *self, const PyAttributeDef *attrdef);
134
135         enum KX_BOOL_TYPE {
136                 KX_BOOL_NODEF = 0,
137                 KX_TRUE,
138                 KX_FALSE,
139                 KX_BOOL_MAX
140         };
141
142
143 protected: 
144         /* Some conversions to go with the bool type. */
145         /** Convert a KX_TRUE, KX_FALSE in Python to a c++ value. */
146         bool PyArgToBool(int boolArg);
147
148         /** Convert a a c++ value to KX_TRUE, KX_FALSE in Python. */
149         PyObject* BoolToPyArg(bool);
150
151         
152 };
153
154 #endif
155