NLA SoC: Merge from 2.5
[blender.git] / source / gameengine / Ketsji / KX_VisibilityActuator.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_VISIBILITYACTUATOR
32 #define __KX_VISIBILITYACTUATOR
33
34 #include "SCA_IActuator.h"
35
36 class KX_VisibilityActuator : public SCA_IActuator
37 {
38         Py_Header;
39
40         /** Make visible? */
41         bool m_visible;
42         bool m_occlusion;
43         bool m_recursive;
44
45  public:
46         
47         KX_VisibilityActuator(
48                 SCA_IObject* gameobj,
49                 bool visible,
50                 bool occlusion,
51                 bool recursive);
52
53         virtual
54                 ~KX_VisibilityActuator(
55                         void
56                         );
57
58         virtual CValue*
59                 GetReplica(
60                         void
61                         );
62
63         virtual bool
64                 Update();
65
66         /* --------------------------------------------------------------------- */
67         /* Python interface ---------------------------------------------------- */
68         /* --------------------------------------------------------------------- */
69
70         // Deprecated ----->
71         KX_PYMETHOD_DOC_VARARGS(KX_VisibilityActuator,SetVisible);
72         // <-----
73
74
75 };
76
77 #endif
78