4 * ***** BEGIN GPL LICENSE BLOCK *****
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.
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.
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.
20 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21 * All rights reserved.
23 * The Original Code is: all of this file.
25 * Contributor(s): none yet.
27 * ***** END GPL LICENSE BLOCK *****
28 * Blender's Ketsji startpoint
31 /** \file gameengine/BlenderRoutines/BL_KetsjiEmbedStart.cpp
40 #if defined(WIN32) && !defined(FREE_WINDOWS)
41 // don't show stl-warnings
42 #pragma warning (disable:4786)
47 #include "KX_BlenderGL.h"
48 #include "KX_BlenderCanvas.h"
49 #include "KX_BlenderKeyboardDevice.h"
50 #include "KX_BlenderMouseDevice.h"
51 #include "KX_BlenderRenderTools.h"
52 #include "KX_BlenderSystem.h"
53 #include "BL_Material.h"
55 #include "KX_KetsjiEngine.h"
56 #include "KX_BlenderSceneConverter.h"
57 #include "KX_PythonInit.h"
58 #include "KX_PyConstraintBinding.h"
60 #include "RAS_GLExtensionManager.h"
61 #include "RAS_OpenGLRasterizer.h"
62 #include "RAS_VAOpenGLRasterizer.h"
63 #include "RAS_ListRasterizer.h"
65 #include "NG_LoopBackNetworkDeviceInterface.h"
67 #include "BL_System.h"
69 #include "GPU_extensions.h"
78 #include "DNA_view3d_types.h"
79 #include "DNA_screen_types.h"
80 #include "DNA_userdef_types.h"
81 #include "DNA_windowmanager_types.h"
82 #include "BKE_global.h"
83 #include "BKE_report.h"
84 /* #include "BKE_screen.h" */ /* cant include this because of 'new' function name */
85 extern float BKE_screen_view3d_zoom_to_fac(float camzoom);
88 //XXX #include "BIF_screen.h"
89 //XXX #include "BIF_scrarea.h"
92 #include "BLI_blenlib.h"
93 #include "BLO_readfile.h"
94 #include "DNA_scene_types.h"
98 //XXX #include "BSE_headerbuttons.h"
99 #include "BKE_context.h"
100 #include "../../blender/windowmanager/WM_types.h"
101 #include "../../blender/windowmanager/wm_window.h"
102 #include "../../blender/windowmanager/wm_event_system.h"
107 #ifdef WITH_AUDASPACE
108 # include "AUD_C-API.h"
109 # include "AUD_I3DDevice.h"
110 # include "AUD_IDevice.h"
113 static BlendFileData *load_game_data(char *filename)
118 BKE_reports_init(&reports, RPT_STORE);
119 bfd= BLO_read_from_file(filename, &reports);
122 printf("Loading %s failed: ", filename);
123 BKE_reports_print(&reports, RPT_ERROR);
126 BKE_reports_clear(&reports);
131 extern "C" void StartKetsjiShell(struct bContext *C, struct ARegion *ar, rcti *cam_frame, int always_use_expand_framing)
134 struct wmWindow *win= CTX_wm_window(C);
135 struct Scene *startscene= CTX_data_scene(C);
136 struct Main* maggie1= CTX_data_main(C);
140 area_rect.SetLeft(cam_frame->xmin);
141 area_rect.SetBottom(cam_frame->ymin);
142 area_rect.SetRight(cam_frame->xmax);
143 area_rect.SetTop(cam_frame->ymax);
145 int exitrequested = KX_EXIT_REQUEST_NO_REQUEST;
146 Main* blenderdata = maggie1;
148 char* startscenename = startscene->id.name+2;
149 char pathname[FILE_MAXDIR+FILE_MAXFILE], oldsce[FILE_MAXDIR+FILE_MAXFILE];
150 STR_String exitstring = "";
151 BlendFileData *bfd= NULL;
153 BLI_strncpy(pathname, blenderdata->name, sizeof(pathname));
154 BLI_strncpy(oldsce, G.main->name, sizeof(oldsce));
156 resetGamePythonPath(); // need this so running a second time wont use an old blendfiles path
157 setGamePythonPath(G.main->name);
159 // Acquire Python's GIL (global interpreter lock)
160 // so we can safely run Python code and API calls
161 PyGILState_STATE gilstate = PyGILState_Ensure();
163 PyObject *pyGlobalDict = PyDict_New(); /* python utility storage, spans blend file loading */
166 bgl::InitExtensions(true);
168 // VBO code for derived mesh is not compatible with BGE (couldn't find why), so disable
169 int disableVBO = (U.gameflags & USER_DISABLE_VBO);
170 U.gameflags |= USER_DISABLE_VBO;
174 View3D *v3d= CTX_wm_view3d(C);
175 RegionView3D *rv3d= CTX_wm_region_view3d(C);
177 // get some preferences
178 SYS_SystemHandle syshandle = SYS_GetSystem();
179 bool properties = (SYS_GetCommandLineInt(syshandle, "show_properties", 0) != 0);
180 bool usefixed = (SYS_GetCommandLineInt(syshandle, "fixedtime", 0) != 0);
181 bool profile = (SYS_GetCommandLineInt(syshandle, "show_profile", 0) != 0);
182 bool frameRate = (SYS_GetCommandLineInt(syshandle, "show_framerate", 0) != 0);
183 bool animation_record = (SYS_GetCommandLineInt(syshandle, "animation_record", 0) != 0);
184 bool displaylists = (SYS_GetCommandLineInt(syshandle, "displaylists", 0) != 0);
186 bool nodepwarnings = (SYS_GetCommandLineInt(syshandle, "ignore_deprecation_warnings", 0) != 0);
188 bool novertexarrays = (SYS_GetCommandLineInt(syshandle, "novertexarrays", 0) != 0);
189 bool mouse_state = startscene->gm.flag & GAME_SHOW_MOUSE;
190 bool restrictAnimFPS = startscene->gm.flag & GAME_RESTRICT_ANIM_UPDATES;
192 if(animation_record) usefixed= true; /* override since you's always want fixed time for sim recording */
194 // create the canvas, rasterizer and rendertools
195 RAS_ICanvas* canvas = new KX_BlenderCanvas(win, area_rect, ar);
197 // default mouse state set on render panel
199 canvas->SetMouseState(RAS_ICanvas::MOUSE_NORMAL);
201 canvas->SetMouseState(RAS_ICanvas::MOUSE_INVISIBLE);
202 RAS_IRenderTools* rendertools = new KX_BlenderRenderTools();
203 RAS_IRasterizer* rasterizer = NULL;
206 if (GLEW_VERSION_1_1 && !novertexarrays)
207 rasterizer = new RAS_ListRasterizer(canvas, true, true);
209 rasterizer = new RAS_ListRasterizer(canvas);
211 else if (GLEW_VERSION_1_1 && !novertexarrays)
212 rasterizer = new RAS_VAOpenGLRasterizer(canvas, false);
214 rasterizer = new RAS_OpenGLRasterizer(canvas);
216 // create the inputdevices
217 KX_BlenderKeyboardDevice* keyboarddevice = new KX_BlenderKeyboardDevice();
218 KX_BlenderMouseDevice* mousedevice = new KX_BlenderMouseDevice();
220 // create a networkdevice
221 NG_NetworkDeviceInterface* networkdevice = new
222 NG_LoopBackNetworkDeviceInterface();
225 // create a ketsji/blendersystem (only needed for timing and stuff)
226 KX_BlenderSystem* kxsystem = new KX_BlenderSystem();
228 // create the ketsjiengine
229 KX_KetsjiEngine* ketsjiengine = new KX_KetsjiEngine(kxsystem);
232 ketsjiengine->SetKeyboardDevice(keyboarddevice);
233 ketsjiengine->SetMouseDevice(mousedevice);
234 ketsjiengine->SetNetworkDevice(networkdevice);
235 ketsjiengine->SetCanvas(canvas);
236 ketsjiengine->SetRenderTools(rendertools);
237 ketsjiengine->SetRasterizer(rasterizer);
238 ketsjiengine->SetUseFixedTime(usefixed);
239 ketsjiengine->SetTimingDisplay(frameRate, profile, properties);
240 ketsjiengine->SetRestrictAnimationFPS(restrictAnimFPS);
243 CValue::SetDeprecationWarnings(nodepwarnings);
246 //lock frame and camera enabled - storing global values
247 int tmp_lay= startscene->lay;
248 Object *tmp_camera = startscene->camera;
250 if (v3d->scenelock==0){
251 startscene->lay= v3d->lay;
252 startscene->camera= v3d->camera;
255 // some blender stuff
257 int draw_letterbox = 0;
259 if(rv3d->persp==RV3D_CAMOB) {
260 if(startscene->gm.framing.type == SCE_GAMEFRAMING_BARS) { /* Letterbox */
265 camzoom = 1.0 / BKE_screen_view3d_zoom_to_fac(rv3d->camzoom);
273 ketsjiengine->SetDrawType(v3d->drawtype);
274 ketsjiengine->SetCameraZoom(camzoom);
276 // if we got an exitcode 3 (KX_EXIT_REQUEST_START_OTHER_GAME) load a different file
277 if (exitrequested == KX_EXIT_REQUEST_START_OTHER_GAME || exitrequested == KX_EXIT_REQUEST_RESTART_GAME)
279 exitrequested = KX_EXIT_REQUEST_NO_REQUEST;
280 if (bfd) BLO_blendfiledata_free(bfd);
283 // base the actuator filename with respect
284 // to the original file working directory
286 if (exitstring != "")
287 strcpy(basedpath, exitstring.Ptr());
289 // load relative to the last loaded file, this used to be relative
290 // to the first file but that makes no sense, relative paths in
291 // blend files should be relative to that file, not some other file
292 // that happened to be loaded first
293 BLI_path_abs(basedpath, pathname);
294 bfd = load_game_data(basedpath);
296 // if it wasn't loaded, try it forced relative
299 // just add "//" in front of it
301 strcpy(temppath, "//");
302 strcat(temppath, basedpath);
304 BLI_path_abs(temppath, pathname);
305 bfd = load_game_data(temppath);
308 // if we got a loaded blendfile, proceed
311 blenderdata = bfd->main;
312 startscenename = bfd->curscene->id.name + 2;
315 BLI_strncpy(G.main->name, blenderdata->name, sizeof(G.main->name));
316 BLI_strncpy(pathname, blenderdata->name, sizeof(pathname));
318 setGamePythonPath(G.main->name);
322 // else forget it, we can't find it
325 exitrequested = KX_EXIT_REQUEST_QUIT_GAME;
329 Scene *scene= bfd ? bfd->curscene : (Scene *)BLI_findstring(&blenderdata->scene, startscenename, offsetof(ID, name) + 2);
333 int startFrame = scene->r.cfra;
334 ketsjiengine->SetAnimRecordMode(animation_record, startFrame);
336 // Quad buffered needs a special window.
337 if(scene->gm.stereoflag == STEREO_ENABLED){
338 if (scene->gm.stereomode != RAS_IRasterizer::RAS_STEREO_QUADBUFFERED)
339 rasterizer->SetStereoMode((RAS_IRasterizer::StereoMode) scene->gm.stereomode);
341 rasterizer->SetEyeSeparation(scene->gm.eyeseparation);
344 rasterizer->SetBackColor(scene->gm.framing.col[0], scene->gm.framing.col[1], scene->gm.framing.col[2], 0.0f);
347 if (exitrequested != KX_EXIT_REQUEST_QUIT_GAME)
349 if (rv3d->persp != RV3D_CAMOB)
351 ketsjiengine->EnableCameraOverride(startscenename);
352 ketsjiengine->SetCameraOverrideUseOrtho((rv3d->persp == RV3D_ORTHO));
353 ketsjiengine->SetCameraOverrideProjectionMatrix(MT_CmMatrix4x4(rv3d->winmat));
354 ketsjiengine->SetCameraOverrideViewMatrix(MT_CmMatrix4x4(rv3d->viewmat));
355 ketsjiengine->SetCameraOverrideClipping(v3d->near, v3d->far);
356 ketsjiengine->SetCameraOverrideLens(v3d->lens);
359 // create a scene converter, create and convert the startingscene
360 KX_ISceneConverter* sceneconverter = new KX_BlenderSceneConverter(blenderdata, ketsjiengine);
361 ketsjiengine->SetSceneConverter(sceneconverter);
362 sceneconverter->addInitFromFrame=false;
363 if (always_use_expand_framing)
364 sceneconverter->SetAlwaysUseExpandFraming(true);
366 bool usemat = false, useglslmat = false;
368 if(GLEW_ARB_multitexture && GLEW_VERSION_1_1)
371 if(GPU_glsl_support())
373 else if(scene->gm.matmode == GAME_MAT_GLSL)
376 if(usemat && (scene->gm.matmode != GAME_MAT_TEXFACE))
377 sceneconverter->SetMaterials(true);
378 if(useglslmat && (scene->gm.matmode == GAME_MAT_GLSL))
379 sceneconverter->SetGLSLMaterials(true);
381 KX_Scene* startscene = new KX_Scene(keyboarddevice,
389 // some python things
390 PyObject *gameLogic, *gameLogic_keys;
391 setupGamePython(ketsjiengine, startscene, blenderdata, pyGlobalDict, &gameLogic, &gameLogic_keys, 0, NULL);
392 #endif // WITH_PYTHON
394 //initialize Dome Settings
395 if(scene->gm.stereoflag == STEREO_DOME)
396 ketsjiengine->InitDome(scene->gm.dome.res, scene->gm.dome.mode, scene->gm.dome.angle, scene->gm.dome.resbuf, scene->gm.dome.tilt, scene->gm.dome.warptext);
398 // initialize 3D Audio Settings
399 AUD_I3DDevice* dev = AUD_get3DDevice();
402 dev->setSpeedOfSound(scene->audio.speed_of_sound);
403 dev->setDopplerFactor(scene->audio.doppler_factor);
404 dev->setDistanceModel(AUD_DistanceModel(scene->audio.distance_model));
407 // from see blender.c:
408 // FIXME: this version patching should really be part of the file-reading code,
409 // but we still get too many unrelated data-corruption crashes otherwise...
410 if (blenderdata->versionfile < 250)
411 do_versions_ipos_to_animato(blenderdata);
415 // convert and add scene
416 sceneconverter->ConvertScene(
420 ketsjiengine->AddScene(startscene);
422 // init the rasterizer
426 ketsjiengine->StartEngine(true);
429 // Set the animation playback rate for ipo's and actions
430 // the framerate below should patch with FPS macro defined in blendef.h
431 // Could be in StartEngine set the framerate, we need the scene to do this
432 ketsjiengine->SetAnimFrameRate(FPS);
435 printf("\nBlender Game Engine Started\n");
436 while (!exitrequested)
438 // first check if we want to exit
439 exitrequested = ketsjiengine->GetExitCode();
442 bool render = ketsjiengine->NextFrame();
447 // Clear screen to border color
448 // We do this here since we set the canvas to be within the frames. This means the engine
449 // itself is unaware of the extra space, so we clear the whole region for it.
450 glClearColor(scene->gm.framing.col[0], scene->gm.framing.col[1], scene->gm.framing.col[2], 1.0f);
451 glViewport(ar->winrct.xmin, ar->winrct.ymin,
452 ar->winrct.xmax - ar->winrct.xmin, ar->winrct.ymax - ar->winrct.ymin);
453 glClear(GL_COLOR_BUFFER_BIT);
457 ketsjiengine->Render();
460 wm_window_process_events_nosleep();
462 // test for the ESC key
463 //XXX while (qtest())
464 while(wmEvent *event= (wmEvent *)win->queue.first)
467 //unsigned short event = 0; //XXX extern_qread(&val);
469 if (keyboarddevice->ConvertBlenderEvent(event->type,event->val))
470 exitrequested = KX_EXIT_REQUEST_BLENDER_ESC;
472 /* Coordinate conversion... where
473 * should this really be?
475 if (event->type==MOUSEMOVE) {
476 /* Note, not nice! XXX 2.5 event hack */
477 val = event->x - ar->winrct.xmin;
478 mousedevice->ConvertBlenderEvent(MOUSEX, val);
480 val = ar->winy - (event->y - ar->winrct.ymin) - 1;
481 mousedevice->ConvertBlenderEvent(MOUSEY, val);
484 mousedevice->ConvertBlenderEvent(event->type,event->val);
487 BLI_remlink(&win->queue, event);
488 wm_event_free(event);
491 if(win != CTX_wm_window(C)) {
492 exitrequested= KX_EXIT_REQUEST_OUTSIDE; /* window closed while bge runs */
495 printf("Blender Game Engine Finished\n");
496 exitstring = ketsjiengine->GetExitString();
499 // when exiting the mainloop
501 // Clears the dictionary by hand:
502 // This prevents, extra references to global variables
503 // inside the GameLogic dictionary when the python interpreter is finalized.
504 // which allows the scene to safely delete them :)
505 // see: (space.c)->start_game
507 //PyDict_Clear(PyModule_GetDict(gameLogic));
509 // Keep original items, means python plugins will autocomplete members
510 PyObject *gameLogic_keys_new = PyDict_Keys(PyModule_GetDict(gameLogic));
511 const Py_ssize_t numitems= PyList_GET_SIZE(gameLogic_keys_new);
512 Py_ssize_t listIndex;
513 for (listIndex=0; listIndex < numitems; listIndex++) {
514 PyObject* item = PyList_GET_ITEM(gameLogic_keys_new, listIndex);
515 if (!PySequence_Contains(gameLogic_keys, item)) {
516 PyDict_DelItem( PyModule_GetDict(gameLogic), item);
519 Py_DECREF(gameLogic_keys_new);
520 gameLogic_keys_new = NULL;
522 ketsjiengine->StopEngine();
524 exitGamePythonScripting();
526 networkdevice->Disconnect();
530 delete sceneconverter;
531 sceneconverter = NULL;
535 Py_DECREF(gameLogic_keys);
536 gameLogic_keys = NULL;
539 //lock frame and camera enabled - restoring global values
540 if (v3d->scenelock==0){
541 startscene->lay= tmp_lay;
542 startscene->camera= tmp_camera;
545 if(exitrequested != KX_EXIT_REQUEST_OUTSIDE)
547 // set the cursor back to normal
548 canvas->SetMouseState(RAS_ICanvas::MOUSE_NORMAL);
551 // clean up some stuff
564 delete networkdevice;
565 networkdevice = NULL;
569 delete keyboarddevice;
570 keyboarddevice = NULL;
593 // stop all remaining playing sounds
594 AUD_getDevice()->stopAll();
596 } while (exitrequested == KX_EXIT_REQUEST_RESTART_GAME || exitrequested == KX_EXIT_REQUEST_START_OTHER_GAME);
599 U.gameflags &= ~USER_DISABLE_VBO;
601 if (bfd) BLO_blendfiledata_free(bfd);
603 BLI_strncpy(G.main->name, oldsce, sizeof(G.main->name));
606 Py_DECREF(pyGlobalDict);
608 // Release Python's GIL
609 PyGILState_Release(gilstate);