use const for readonly strings and set some functions to static
[blender.git] / source / gameengine / Ketsji / KX_SceneActuator.h
1 //
2 // ***** BEGIN GPL LICENSE BLOCK *****
3 //
4 // This program is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU General Public License
6 // as published by the Free Software Foundation; either version 2
7 // of the License, or (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software Foundation,
16 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 //
18 // The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19 // All rights reserved.
20 //
21 // The Original Code is: all of this file.
22 //
23 // Contributor(s): none yet.
24 //
25 // ***** END GPL LICENSE BLOCK *****
26 //
27
28 /** \file KX_SceneActuator.h
29  *  \ingroup ketsji
30  */
31
32 #ifndef __KX_SCENEACTUATOR
33 #define __KX_SCENEACTUATOR
34
35 #include "SCA_IActuator.h"
36 #include "SCA_IScene.h" /* Replace_IScene only */
37 #include "KX_Scene.h" /* Replace_IScene only */
38
39 class KX_SceneActuator : public SCA_IActuator
40 {
41         Py_Header;
42         
43         int                                                     m_mode;
44         // (restart) has become a toggle internally... not in the interface though
45         bool                                            m_restart;
46         // (set Scene) Scene
47         /** The current scene. */
48         class   KX_Scene*                       m_scene;
49         class   KX_KetsjiEngine*        m_KetsjiEngine;
50         /** The scene to switch to. */
51         STR_String                                      m_nextSceneName;
52         
53         // (Set Camera) Object
54         class KX_Camera*                        m_camera;
55
56         /** Is this a valid scene? */
57         class KX_Scene* FindScene(const char* sceneName);
58         /** Is this a valid camera? */
59         class KX_Camera* FindCamera(const char* cameraName);
60         
61  public:
62         enum SCA_SceneActuatorMode
63         {
64                 KX_SCENE_NODEF = 0,
65                 KX_SCENE_RESTART,
66                 KX_SCENE_SET_SCENE,
67                 KX_SCENE_SET_CAMERA,
68                 KX_SCENE_ADD_FRONT_SCENE,
69                 KX_SCENE_ADD_BACK_SCENE,
70                 KX_SCENE_REMOVE_SCENE,
71                 KX_SCENE_SUSPEND,
72                 KX_SCENE_RESUME,
73                 KX_SCENE_MAX
74         };
75         
76         KX_SceneActuator(SCA_IObject* gameobj,
77                                          int mode,
78                                          KX_Scene* scene,
79                                          KX_KetsjiEngine* ketsjiEngine,
80                                          const STR_String& nextSceneName,
81                                          KX_Camera* camera);
82         virtual ~KX_SceneActuator();
83
84         virtual CValue* GetReplica();
85         virtual void ProcessReplica();
86         virtual bool UnlinkObject(SCA_IObject* clientobj);
87         virtual void Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);
88
89         virtual bool Update();
90         
91 #ifdef WITH_PYTHON
92
93         virtual void Replace_IScene(SCA_IScene *val)
94         {
95                 m_scene= static_cast<KX_Scene *>(val);
96         };
97
98         /* --------------------------------------------------------------------- */
99         /* Python interface ---------------------------------------------------- */
100         /* --------------------------------------------------------------------- */
101         
102         static PyObject* pyattr_get_camera(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
103         static int pyattr_set_camera(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
104
105 #endif // WITH_PYTHON
106
107 }; /* end of class KXSceneActuator */
108
109 #endif
110