Did all of the .h's in source
[blender.git] / source / gameengine / Ketsji / KX_ISceneConverter.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef __KX_ISCENECONVERTER_H
33 #define __KX_ISCENECONVERTER_H
34
35 #include "STR_String.h"
36
37 #include "KX_Python.h"
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43 class KX_ISceneConverter 
44 {
45
46 public:
47         KX_ISceneConverter() {}
48         virtual ~KX_ISceneConverter () {};
49
50         /*
51         scenename: name of the scene to be converted,
52                 if the scenename is empty, convert the 'default' scene (whatever this means)
53         destinationscene: pass an empty scene, everything goes into this
54         dictobj: python dictionary (for pythoncontrollers)
55         */
56         virtual void ConvertScene(const STR_String& scenename,
57                 class KX_Scene* destinationscene,
58                 PyObject* dictobj,
59                 class SCA_IInputDevice* keyinputdev,
60                 class RAS_IRenderTools* rendertools, 
61                 class RAS_ICanvas*  canvas)=0;
62         
63         virtual void    SetAlwaysUseExpandFraming(bool to_what) = 0;
64
65         virtual void    SetNewFileName(const STR_String& filename) = 0;
66         virtual bool    TryAndLoadNewFile() = 0;
67 };
68
69 #endif //__KX_ISCENECONVERTER_H
70