svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22717:22875
[blender.git] / source / gameengine / Ketsji / KX_ISceneConverter.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  */
29 #ifndef __KX_ISCENECONVERTER_H
30 #define __KX_ISCENECONVERTER_H
31
32 #include "STR_String.h"
33 #include "KX_Python.h"
34
35 #ifdef WITH_CXX_GUARDEDALLOC
36 #include "MEM_guardedalloc.h"
37 #endif
38
39 struct Scene;
40
41 class KX_ISceneConverter 
42 {
43
44 public:
45         KX_ISceneConverter() :addInitFromFrame(false) {}//this addInitFromFrame is a back hack, todo remove
46         virtual ~KX_ISceneConverter () {};
47
48         /*
49         scenename: name of the scene to be converted,
50                 if the scenename is empty, convert the 'default' scene (whatever this means)
51         destinationscene: pass an empty scene, everything goes into this
52         dictobj: python dictionary (for pythoncontrollers)
53         */
54         virtual void ConvertScene(
55                 class KX_Scene* destinationscene,
56                 PyObject* dictobj,
57                 class RAS_IRenderTools* rendertools, 
58                 class RAS_ICanvas*  canvas)=0;
59         
60         virtual void RemoveScene(class KX_Scene *scene)=0;
61
62         virtual void    SetAlwaysUseExpandFraming(bool to_what) = 0;
63
64         virtual void    SetNewFileName(const STR_String& filename) = 0;
65         virtual bool    TryAndLoadNewFile() = 0;
66         bool    addInitFromFrame;//rcruiz
67
68         virtual void    ResetPhysicsObjectsAnimationIpo(bool clearIpo) = 0;
69
70         
71         ///this generates ipo curves for position, rotation, allowing to use game physics in animation
72         virtual void    WritePhysicsObjectToAnimationIpo(int frameNumber) = 0;
73         virtual void    TestHandlesPhysicsObjectToAnimationIpo() = 0;
74
75         ///this is for reseting the position,rotation and scale of the gameobjet that is not dynamic
76         virtual void    resetNoneDynamicObjectToIpo()=0;
77
78         // use blender materials
79         virtual void SetMaterials(bool val) =0;
80         virtual bool GetMaterials()=0;
81
82         // use blender glsl materials
83         virtual void SetGLSLMaterials(bool val) =0;
84         virtual bool GetGLSLMaterials()=0;
85
86         virtual struct Scene* GetBlenderSceneForName(const STR_String& name)=0;
87         
88         
89 #ifdef WITH_CXX_GUARDEDALLOC
90 public:
91         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_ISceneConverter"); }
92         void operator delete( void *mem ) { MEM_freeN(mem); }
93 #endif
94 };
95
96 #endif //__KX_ISCENECONVERTER_H
97