BGE API cleanup: StateActuator.
[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., 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  * Actuator to toggle visibility/invisibility of objects
29  */
30
31 #ifndef __KX_STATEACTUATOR
32 #define __KX_STATEACTUATOR
33
34 #include "SCA_IActuator.h"
35
36 class KX_StateActuator : public SCA_IActuator
37 {
38         Py_Header;
39
40         /** Make visible? */
41         enum {
42                 OP_NOP = -1,
43                 OP_CPY = 0,
44                 OP_SET,
45                 OP_CLR,
46                 OP_NEG,
47                 OP_COUNT
48         };
49         int                             m_operation;
50         int                             m_mask;
51
52  public:
53         
54         KX_StateActuator(
55                 SCA_IObject* gameobj,
56                 int operation,
57                 unsigned int mask,
58                 PyTypeObject* T=&Type
59                 );
60
61         virtual
62                 ~KX_StateActuator(
63                         void
64                         );
65
66         virtual CValue*
67                 GetReplica(
68                         void
69                         );
70
71         virtual bool
72                 Update();
73
74         /* --------------------------------------------------------------------- */
75         /* Python interface ---------------------------------------------------- */
76         /* --------------------------------------------------------------------- */
77
78         virtual PyObject* py_getattro(PyObject *attr);
79         virtual int py_setattro(PyObject *attr, PyObject* value);
80         //KX_PYMETHOD_DOC
81         KX_PYMETHOD_DOC(KX_StateActuator,SetOperation);
82         KX_PYMETHOD_DOC(KX_StateActuator,SetMask);
83 };
84
85 #endif
86