python api for ID property access by Joseph Eager, copied from blender 2.4x.
[blender-staging.git] / source / gameengine / Converter / KX_BlenderSceneConverter.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_BLENDERSCENECONVERTER_H
30 #define __KX_BLENDERSCENECONVERTER_H
31
32 #include "KX_HashedPtr.h"
33 #include "GEN_Map.h"
34
35 #include "KX_ISceneConverter.h"
36 #include "KX_IpoConvert.h"
37
38 class KX_WorldInfo;
39 class SCA_IActuator;
40 class SCA_IController;
41 class RAS_MeshObject;
42 class RAS_IPolyMaterial;
43 class BL_InterpolatorList;
44 class BL_Material;
45 struct IpoCurve;
46 struct Main;
47 struct Scene;
48
49 class KX_BlenderSceneConverter : public KX_ISceneConverter
50 {
51         // Use vector of pairs to allow removal of entities between scene switch
52         vector<pair<KX_Scene*,KX_WorldInfo*> >  m_worldinfos;
53         vector<pair<KX_Scene*,RAS_IPolyMaterial*> > m_polymaterials;
54         vector<pair<KX_Scene*,RAS_MeshObject*> > m_meshobjects;
55         vector<pair<KX_Scene*,BL_Material *> >  m_materials;
56         // Should also have a list of collision shapes. 
57         // For the time being this is held in KX_Scene::m_shapes
58
59         GEN_Map<CHashedPtr,KX_GameObject*>      m_map_blender_to_gameobject;            /* cleared after conversion */
60         GEN_Map<CHashedPtr,RAS_MeshObject*>     m_map_mesh_to_gamemesh;                         /* cleared after conversion */
61         GEN_Map<CHashedPtr,SCA_IActuator*>      m_map_blender_to_gameactuator;          /* cleared after conversion */
62         GEN_Map<CHashedPtr,SCA_IController*>m_map_blender_to_gamecontroller;    /* cleared after conversion */
63         
64         GEN_Map<CHashedPtr,BL_InterpolatorList*> m_map_blender_to_gameAdtList;
65         
66         Main*                                   m_maggie;
67         vector<struct Main*>    m_DynamicMaggie;
68
69         STR_String                              m_newfilename;
70         class KX_KetsjiEngine*  m_ketsjiEngine;
71         class KX_Scene*                 m_currentScene; // Scene being converted
72         bool                                    m_alwaysUseExpandFraming;
73         bool                                    m_usemat;
74         bool                                    m_useglslmat;
75
76         void localDel_ipoCurve ( IpoCurve * icu );
77 //      struct Ipo* findIpoForName(char* objName);
78
79 public:
80         KX_BlenderSceneConverter(
81                 Main* maggie,
82                 class KX_KetsjiEngine* engine
83         );
84
85         virtual ~KX_BlenderSceneConverter();
86
87         /* Scenename: name of the scene to be converted.
88          * destinationscene: pass an empty scene, everything goes into this
89          * dictobj: python dictionary (for pythoncontrollers)
90          */
91         virtual void    ConvertScene(
92                                                 class KX_Scene* destinationscene,
93                                                 class RAS_IRenderTools* rendertools,
94                                                 class RAS_ICanvas* canvas
95                                         );
96         virtual void RemoveScene(class KX_Scene *scene);
97
98         void SetNewFileName(const STR_String& filename);
99         bool TryAndLoadNewFile();
100
101         void SetAlwaysUseExpandFraming(bool to_what);
102         
103         void RegisterGameObject(KX_GameObject *gameobject, struct Object *for_blenderobject);
104         void UnregisterGameObject(KX_GameObject *gameobject);
105         KX_GameObject *FindGameObject(struct Object *for_blenderobject);
106
107         void RegisterGameMesh(RAS_MeshObject *gamemesh, struct Mesh *for_blendermesh);
108         RAS_MeshObject *FindGameMesh(struct Mesh *for_blendermesh/*, unsigned int onlayer*/);
109
110         void RegisterPolyMaterial(RAS_IPolyMaterial *polymat);
111
112         void RegisterBlenderMaterial(BL_Material *mat);
113         
114         void RegisterInterpolatorList(BL_InterpolatorList *adtList, struct AnimData *for_adt);
115         BL_InterpolatorList *FindInterpolatorList(struct AnimData *for_adt);
116
117         void RegisterGameActuator(SCA_IActuator *act, struct bActuator *for_actuator);
118         SCA_IActuator *FindGameActuator(struct bActuator *for_actuator);
119
120         void RegisterGameController(SCA_IController *cont, struct bController *for_controller);
121         SCA_IController *FindGameController(struct bController *for_controller);
122
123         void RegisterWorldInfo(KX_WorldInfo *worldinfo);
124
125         virtual void    ResetPhysicsObjectsAnimationIpo(bool clearIpo);
126
127         ///this is for reseting the position,rotation and scale of the gameobjet that is not dynamic
128         virtual void    resetNoneDynamicObjectToIpo();
129         
130         ///this generates ipo curves for position, rotation, allowing to use game physics in animation
131         virtual void    WritePhysicsObjectToAnimationIpo(int frameNumber);
132         virtual void    TestHandlesPhysicsObjectToAnimationIpo();
133
134         // use blender materials
135         virtual void SetMaterials(bool val);
136         virtual bool GetMaterials();
137
138         // use blender glsl materials
139         virtual void SetGLSLMaterials(bool val);
140         virtual bool GetGLSLMaterials();
141
142         struct Scene* GetBlenderSceneForName(const STR_String& name);
143
144 //      struct Main* GetMain() { return m_maggie; };
145         struct Main*              GetMainDynamicPath(const char *path);
146         vector<struct Main*> &GetMainDynamic();
147         
148         bool LinkBlendFile(const char *path, char *group, KX_Scene *scene_merge, char **err_str);
149         bool MergeScene(KX_Scene *to, KX_Scene *from);
150         RAS_MeshObject *ConvertMeshSpecial(KX_Scene* kx_scene, Main *maggie, const char *name);
151         bool FreeBlendFile(struct Main *maggie);
152         bool FreeBlendFile(const char *path);
153  
154         void PrintStats() {
155                 printf("BGE STATS!\n");
156
157                 printf("\nAssets...\n");
158                 printf("\t m_worldinfos: %d\n", m_worldinfos.size());
159                 printf("\t m_polymaterials: %d\n", m_polymaterials.size());
160                 printf("\t m_meshobjects: %d\n", m_meshobjects.size());
161                 printf("\t m_materials: %d\n", m_materials.size());
162
163                 printf("\nMappings...\n");
164                 printf("\t m_map_blender_to_gameobject: %d\n", m_map_blender_to_gameobject.size());
165                 printf("\t m_map_mesh_to_gamemesh: %d\n", m_map_mesh_to_gamemesh.size());
166                 printf("\t m_map_blender_to_gameactuator: %d\n", m_map_blender_to_gameactuator.size());
167                 printf("\t m_map_blender_to_gamecontroller: %d\n", m_map_blender_to_gamecontroller.size());
168                 printf("\t m_map_blender_to_gameAdtList: %d\n", m_map_blender_to_gameAdtList.size());
169
170 #ifdef WITH_CXX_GUARDEDALLOC
171                 MEM_printmemlist_pydict();
172 #endif
173 //              /printf("\t m_ketsjiEngine->m_scenes: %d\n", m_ketsjiEngine->CurrentScenes()->size());
174         }
175
176
177
178 #ifndef DISABLE_PYTHON
179         PyObject *GetPyNamespace();
180 #endif
181         
182 #ifdef WITH_CXX_GUARDEDALLOC
183 public:
184         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_BlenderSceneConverter"); }
185         void operator delete( void *mem ) { MEM_freeN(mem); }
186 #endif
187 };
188
189 #endif //__KX_BLENDERSCENECONVERTER_H
190