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