add missing files after merging
[blender.git] / source / gameengine / Ketsji / KX_StateActuator.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
30 /** \file KX_StateActuator.h
31  *  \ingroup ketsji
32  *  \brief Actuator to toggle visibility/invisibility of objects
33  */
34
35 #ifndef __KX_STATEACTUATOR
36 #define __KX_STATEACTUATOR
37
38 #include "SCA_IActuator.h"
39
40
41 /*
42  * Use of SG_DList : element of actuator being deactivated
43  *                   Head: SCA_LogicManager::m_removedActuators
44  * Use of SG_QList : element of global activated state actuator list 
45  *                   Head: KX_StateActuator::m_stateActuatorHead
46  */
47 class KX_StateActuator : public SCA_IActuator
48 {
49         Py_Header;
50
51         /** Make visible? */
52         enum {
53                 OP_NOP = -1,
54                 OP_CPY = 0,
55                 OP_SET,
56                 OP_CLR,
57                 OP_NEG,
58                 OP_COUNT
59         };
60         // SG_Dlist: element of objects with active actuators, always put in front of the list
61         //           Head: SCA_LogicManager::m_activeActuators
62         // SG_QList: Head of active state actuators list globally
63         //           Elements: KX_StateActuator
64         static SG_QList m_stateActuatorHead;
65         int                             m_operation;
66         int                             m_mask;
67
68  public:
69         
70         KX_StateActuator(
71                 SCA_IObject* gameobj,
72                 int operation,
73                 unsigned int mask
74         );
75
76         virtual
77                 ~KX_StateActuator(
78                         void
79                         );
80
81         virtual CValue*
82                 GetReplica(
83                         void
84                         );
85
86         virtual bool
87                 Update();
88
89         virtual void Deactivate();
90         virtual void Activate(SG_DList& head);
91
92         /* --------------------------------------------------------------------- */
93         /* Python interface ---------------------------------------------------- */
94         /* --------------------------------------------------------------------- */
95
96 };
97
98 #endif
99