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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
39 // don't show stl-warnings
40 #pragma warning (disable:4786)
45 #include "KX_BlenderGL.h"
46 #include "KX_BlenderCanvas.h"
47 #include "KX_BlenderKeyboardDevice.h"
48 #include "KX_BlenderMouseDevice.h"
49 #include "KX_BlenderRenderTools.h"
50 #include "KX_BlenderSystem.h"
51 #include "BL_Material.h"
53 #include "KX_KetsjiEngine.h"
54 #include "KX_BlenderSceneConverter.h"
55 #include "KX_PythonInit.h"
56 #include "KX_PyConstraintBinding.h"
58 #include "RAS_GLExtensionManager.h"
59 #include "RAS_OpenGLRasterizer.h"
60 #include "RAS_VAOpenGLRasterizer.h"
61 #include "RAS_ListRasterizer.h"
63 #include "NG_LoopBackNetworkDeviceInterface.h"
65 #include "SYS_System.h"
67 #include "GPU_extensions.h"
76 #include "DNA_view3d_types.h"
77 #include "DNA_screen_types.h"
78 #include "DNA_windowmanager_types.h"
79 #include "BKE_global.h"
80 #include "BKE_report.h"
82 #include "BKE_utildefines.h"
83 //XXX #include "BIF_screen.h"
84 //XXX #include "BIF_scrarea.h"
87 #include "BLI_blenlib.h"
88 #include "BLO_readfile.h"
89 #include "DNA_scene_types.h"
92 #include "AUD_C-API.h"
94 //XXX #include "BSE_headerbuttons.h"
95 #include "BKE_context.h"
96 #include "../../blender/windowmanager/WM_types.h"
97 #include "../../blender/windowmanager/wm_window.h"
98 #include "../../blender/windowmanager/wm_event_system.h"
104 static BlendFileData *load_game_data(char *filename)
109 BKE_reports_init(&reports, RPT_STORE);
110 bfd= BLO_read_from_file(filename, &reports);
113 printf("Loading %s failed: ", filename);
114 BKE_reports_print(&reports, RPT_ERROR);
117 BKE_reports_clear(&reports);
122 extern "C" void StartKetsjiShell(struct bContext *C, struct ARegion *ar, int always_use_expand_framing)
125 struct wmWindow *win= CTX_wm_window(C);
126 struct Scene *scene= CTX_data_scene(C);
127 struct Main* maggie1= CTX_data_main(C);
130 int exitrequested = KX_EXIT_REQUEST_NO_REQUEST;
131 Main* blenderdata = maggie1;
133 char* startscenename = scene->id.name+2;
134 char pathname[FILE_MAXDIR+FILE_MAXFILE], oldsce[FILE_MAXDIR+FILE_MAXFILE];
135 STR_String exitstring = "";
136 BlendFileData *bfd= NULL;
138 BLI_strncpy(pathname, blenderdata->name, sizeof(pathname));
139 BLI_strncpy(oldsce, G.sce, sizeof(oldsce));
140 resetGamePythonPath(); // need this so running a second time wont use an old blendfiles path
141 setGamePythonPath(G.sce);
143 // Acquire Python's GIL (global interpreter lock)
144 // so we can safely run Python code and API calls
145 PyGILState_STATE gilstate = PyGILState_Ensure();
147 PyObject *pyGlobalDict = PyDict_New(); /* python utility storage, spans blend file loading */
149 bgl::InitExtensions(true);
153 View3D *v3d= CTX_wm_view3d(C);
154 RegionView3D *rv3d= CTX_wm_region_view3d(C);
156 // get some preferences
157 SYS_SystemHandle syshandle = SYS_GetSystem();
158 bool properties = (SYS_GetCommandLineInt(syshandle, "show_properties", 0) != 0);
159 bool usefixed = (SYS_GetCommandLineInt(syshandle, "fixedtime", 0) != 0);
160 bool profile = (SYS_GetCommandLineInt(syshandle, "show_profile", 0) != 0);
161 bool frameRate = (SYS_GetCommandLineInt(syshandle, "show_framerate", 0) != 0);
162 bool game2ipo = (SYS_GetCommandLineInt(syshandle, "game2ipo", 0) != 0);
163 bool displaylists = (SYS_GetCommandLineInt(syshandle, "displaylists", 0) != 0);
164 bool nodepwarnings = (SYS_GetCommandLineInt(syshandle, "ignore_deprecation_warnings", 0) != 0);
165 bool novertexarrays = (SYS_GetCommandLineInt(syshandle, "novertexarrays", 0) != 0);
166 // create the canvas, rasterizer and rendertools
167 RAS_ICanvas* canvas = new KX_BlenderCanvas(win, ar);
168 canvas->SetMouseState(RAS_ICanvas::MOUSE_INVISIBLE);
169 RAS_IRenderTools* rendertools = new KX_BlenderRenderTools();
170 RAS_IRasterizer* rasterizer = NULL;
173 if (GLEW_VERSION_1_1 && !novertexarrays)
174 rasterizer = new RAS_ListRasterizer(canvas, true, true);
176 rasterizer = new RAS_ListRasterizer(canvas);
178 else if (GLEW_VERSION_1_1 && !novertexarrays)
179 rasterizer = new RAS_VAOpenGLRasterizer(canvas, false);
181 rasterizer = new RAS_OpenGLRasterizer(canvas);
183 // create the inputdevices
184 KX_BlenderKeyboardDevice* keyboarddevice = new KX_BlenderKeyboardDevice();
185 KX_BlenderMouseDevice* mousedevice = new KX_BlenderMouseDevice();
187 // create a networkdevice
188 NG_NetworkDeviceInterface* networkdevice = new
189 NG_LoopBackNetworkDeviceInterface();
192 // create a ketsji/blendersystem (only needed for timing and stuff)
193 KX_BlenderSystem* kxsystem = new KX_BlenderSystem();
195 // create the ketsjiengine
196 KX_KetsjiEngine* ketsjiengine = new KX_KetsjiEngine(kxsystem);
199 ketsjiengine->SetKeyboardDevice(keyboarddevice);
200 ketsjiengine->SetMouseDevice(mousedevice);
201 ketsjiengine->SetNetworkDevice(networkdevice);
202 ketsjiengine->SetCanvas(canvas);
203 ketsjiengine->SetRenderTools(rendertools);
204 ketsjiengine->SetRasterizer(rasterizer);
205 ketsjiengine->SetNetworkDevice(networkdevice);
206 ketsjiengine->SetUseFixedTime(usefixed);
207 ketsjiengine->SetTimingDisplay(frameRate, profile, properties);
209 CValue::SetDeprecationWarnings(nodepwarnings);
212 //lock frame and camera enabled - storing global values
213 int tmp_lay= scene->lay;
214 Object *tmp_camera = scene->camera;
216 if (v3d->scenelock==0){
217 scene->lay= v3d->lay;
218 scene->camera= v3d->camera;
221 // some blender stuff
222 MT_CmMatrix4x4 projmat;
223 MT_CmMatrix4x4 viewmat;
227 for (i = 0; i < 16; i++)
229 float *viewmat_linear= (float*) rv3d->viewmat;
230 viewmat.setElem(i, viewmat_linear[i]);
232 for (i = 0; i < 16; i++)
234 float *projmat_linear= (float*) rv3d->winmat;
235 projmat.setElem(i, projmat_linear[i]);
238 if(rv3d->persp==V3D_CAMOB) {
239 camzoom = (1.41421 + (rv3d->camzoom / 50.0));
245 camzoom = 4.0 / camzoom;
247 ketsjiengine->SetDrawType(v3d->drawtype);
248 ketsjiengine->SetCameraZoom(camzoom);
250 // if we got an exitcode 3 (KX_EXIT_REQUEST_START_OTHER_GAME) load a different file
251 if (exitrequested == KX_EXIT_REQUEST_START_OTHER_GAME || exitrequested == KX_EXIT_REQUEST_RESTART_GAME)
253 exitrequested = KX_EXIT_REQUEST_NO_REQUEST;
254 if (bfd) BLO_blendfiledata_free(bfd);
257 // base the actuator filename with respect
258 // to the original file working directory
260 if (exitstring != "")
261 strcpy(basedpath, exitstring.Ptr());
263 // load relative to the last loaded file, this used to be relative
264 // to the first file but that makes no sense, relative paths in
265 // blend files should be relative to that file, not some other file
266 // that happened to be loaded first
267 BLI_convertstringcode(basedpath, pathname);
268 bfd = load_game_data(basedpath);
270 // if it wasn't loaded, try it forced relative
273 // just add "//" in front of it
275 strcpy(temppath, "//");
276 strcat(temppath, basedpath);
278 BLI_convertstringcode(temppath, pathname);
279 bfd = load_game_data(temppath);
282 // if we got a loaded blendfile, proceed
285 blenderdata = bfd->main;
286 startscenename = bfd->curscene->id.name + 2;
289 BLI_strncpy(G.sce, blenderdata->name, sizeof(G.sce));
290 BLI_strncpy(pathname, blenderdata->name, sizeof(pathname));
291 setGamePythonPath(G.sce);
294 // else forget it, we can't find it
297 exitrequested = KX_EXIT_REQUEST_QUIT_GAME;
301 Scene *blscene = NULL;
304 blscene = (Scene*) blenderdata->scene.first;
305 for (Scene *sce= (Scene*) blenderdata->scene.first; sce; sce= (Scene*) sce->id.next)
307 if (startscenename == (sce->id.name+2))
314 blscene = bfd->curscene;
319 int startFrame = blscene->r.cfra;
320 ketsjiengine->SetGame2IpoMode(game2ipo,startFrame);
322 // Quad buffered needs a special window.
323 if(blscene->gm.stereoflag == STEREO_ENABLED){
324 if (blscene->gm.stereomode != RAS_IRasterizer::RAS_STEREO_QUADBUFFERED)
325 rasterizer->SetStereoMode((RAS_IRasterizer::StereoMode) blscene->gm.stereomode);
329 if (exitrequested != KX_EXIT_REQUEST_QUIT_GAME)
331 if (rv3d->persp != V3D_CAMOB)
333 ketsjiengine->EnableCameraOverride(startscenename);
334 ketsjiengine->SetCameraOverrideUseOrtho((rv3d->persp == V3D_ORTHO));
335 ketsjiengine->SetCameraOverrideProjectionMatrix(projmat);
336 ketsjiengine->SetCameraOverrideViewMatrix(viewmat);
337 ketsjiengine->SetCameraOverrideClipping(v3d->near, v3d->far);
338 ketsjiengine->SetCameraOverrideLens(v3d->lens);
341 // create a scene converter, create and convert the startingscene
342 KX_ISceneConverter* sceneconverter = new KX_BlenderSceneConverter(blenderdata, ketsjiengine);
343 ketsjiengine->SetSceneConverter(sceneconverter);
344 sceneconverter->addInitFromFrame=false;
345 if (always_use_expand_framing)
346 sceneconverter->SetAlwaysUseExpandFraming(true);
348 bool usemat = false, useglslmat = false;
350 if(GLEW_ARB_multitexture && GLEW_VERSION_1_1)
353 if(GPU_extensions_minimum_support())
355 else if(blscene->gm.matmode == GAME_MAT_GLSL)
358 if(usemat && (blscene->gm.matmode != GAME_MAT_TEXFACE))
359 sceneconverter->SetMaterials(true);
360 if(useglslmat && (blscene->gm.matmode == GAME_MAT_GLSL))
361 sceneconverter->SetGLSLMaterials(true);
363 KX_Scene* startscene = new KX_Scene(keyboarddevice,
369 // some python things
370 PyObject* dictionaryobject = initGamePythonScripting("Ketsji", psl_Lowest, blenderdata);
371 ketsjiengine->SetPythonDictionary(dictionaryobject);
372 initRasterizer(rasterizer, canvas);
373 PyObject *gameLogic = initGameLogic(ketsjiengine, startscene);
374 PyDict_SetItemString(PyModule_GetDict(gameLogic), "globalDict", pyGlobalDict); // Same as importing the module.
375 PyObject *gameLogic_keys = PyDict_Keys(PyModule_GetDict(gameLogic));
376 PyDict_SetItemString(dictionaryobject, "GameLogic", gameLogic); // Same as importing the module.
379 initPythonConstraintBinding();
387 //initialize Dome Settings
388 if(blscene->gm.stereoflag == STEREO_DOME)
389 ketsjiengine->InitDome(blscene->gm.dome.res, blscene->gm.dome.mode, blscene->gm.dome.angle, blscene->gm.dome.resbuf, blscene->gm.dome.tilt, blscene->gm.dome.warptext);
391 // initialize 3D Audio Settings
392 AUD_set3DSetting(AUD_3DS_SPEED_OF_SOUND, blscene->audio.speed_of_sound);
393 AUD_set3DSetting(AUD_3DS_DOPPLER_FACTOR, blscene->audio.doppler_factor);
394 AUD_set3DSetting(AUD_3DS_DISTANCE_MODEL, blscene->audio.distance_model);
398 // convert and add scene
399 sceneconverter->ConvertScene(
404 ketsjiengine->AddScene(startscene);
406 // init the rasterizer
410 ketsjiengine->StartEngine(true);
413 // Set the animation playback rate for ipo's and actions
414 // the framerate below should patch with FPS macro defined in blendef.h
415 // Could be in StartEngine set the framerate, we need the scene to do this
416 ketsjiengine->SetAnimFrameRate( (((double) blscene->r.frs_sec) / blscene->r.frs_sec_base) );
419 printf("\nBlender Game Engine Started\n\n");
420 while (!exitrequested)
422 // first check if we want to exit
423 exitrequested = ketsjiengine->GetExitCode();
426 bool render = ketsjiengine->NextFrame(); // XXX 2.5 Bug, This is never true! FIXME- Campbell
431 ketsjiengine->Render();
434 wm_window_process_events_nosleep(C);
436 // test for the ESC key
437 //XXX while (qtest())
438 while(wmEvent *event= (wmEvent *)win->queue.first)
441 //unsigned short event = 0; //XXX extern_qread(&val);
443 if (keyboarddevice->ConvertBlenderEvent(event->type,event->val))
444 exitrequested = KX_EXIT_REQUEST_BLENDER_ESC;
446 /* Coordinate conversion... where
447 * should this really be?
449 if (event->type==MOUSEMOVE) {
450 /* Note nice! XXX 2.5 event hack */
451 val = event->x - ar->winrct.xmin;
452 mousedevice->ConvertBlenderEvent(MOUSEX, val);
454 val = ar->winy - (event->y - ar->winrct.ymin) - 1;
455 mousedevice->ConvertBlenderEvent(MOUSEY, val);
458 mousedevice->ConvertBlenderEvent(event->type,event->val);
461 BLI_remlink(&win->queue, event);
462 wm_event_free(event);
466 printf("\nBlender Game Engine Finished\n\n");
467 exitstring = ketsjiengine->GetExitString();
470 // when exiting the mainloop
472 // Clears the dictionary by hand:
473 // This prevents, extra references to global variables
474 // inside the GameLogic dictionary when the python interpreter is finalized.
475 // which allows the scene to safely delete them :)
476 // see: (space.c)->start_game
478 //PyDict_Clear(PyModule_GetDict(gameLogic));
480 // Keep original items, means python plugins will autocomplete members
482 PyObject *gameLogic_keys_new = PyDict_Keys(PyModule_GetDict(gameLogic));
483 for (listIndex=0; listIndex < PyList_Size(gameLogic_keys_new); listIndex++) {
484 PyObject* item = PyList_GET_ITEM(gameLogic_keys_new, listIndex);
485 if (!PySequence_Contains(gameLogic_keys, item)) {
486 PyDict_DelItem( PyModule_GetDict(gameLogic), item);
489 Py_DECREF(gameLogic_keys_new);
490 gameLogic_keys_new = NULL;
492 ketsjiengine->StopEngine();
493 exitGamePythonScripting();
494 networkdevice->Disconnect();
498 delete sceneconverter;
499 sceneconverter = NULL;
502 Py_DECREF(gameLogic_keys);
503 gameLogic_keys = NULL;
505 //lock frame and camera enabled - restoring global values
506 if (v3d->scenelock==0){
508 scene->camera= tmp_camera;
511 // set the cursor back to normal
512 canvas->SetMouseState(RAS_ICanvas::MOUSE_NORMAL);
514 // clean up some stuff
527 delete networkdevice;
528 networkdevice = NULL;
532 delete keyboarddevice;
533 keyboarddevice = NULL;
556 } while (exitrequested == KX_EXIT_REQUEST_RESTART_GAME || exitrequested == KX_EXIT_REQUEST_START_OTHER_GAME);
558 Py_DECREF(pyGlobalDict);
560 if (bfd) BLO_blendfiledata_free(bfd);
562 BLI_strncpy(G.sce, oldsce, sizeof(G.sce));
564 // Release Python's GIL
565 PyGILState_Release(gilstate);
568 extern "C" void StartKetsjiShellSimulation(struct wmWindow *win,
572 int always_use_expand_framing)
574 int exitrequested = KX_EXIT_REQUEST_NO_REQUEST;
576 Main* blenderdata = maggie;
578 char* startscenename = scenename;
579 char pathname[FILE_MAXDIR+FILE_MAXFILE];
580 STR_String exitstring = "";
582 BLI_strncpy(pathname, blenderdata->name, sizeof(pathname));
584 // Acquire Python's GIL (global interpreter lock)
585 // so we can safely run Python code and API calls
586 PyGILState_STATE gilstate = PyGILState_Ensure();
588 bgl::InitExtensions(true);
593 // get some preferences
594 SYS_SystemHandle syshandle = SYS_GetSystem();
596 bool properties = (SYS_GetCommandLineInt(syshandle, "show_properties", 0) != 0);
597 bool usefixed = (SYS_GetCommandLineInt(syshandle, "fixedtime", 0) != 0);
598 bool profile = (SYS_GetCommandLineInt(syshandle, "show_profile", 0) != 0);
599 bool frameRate = (SYS_GetCommandLineInt(syshandle, "show_framerate", 0) != 0);
601 bool game2ipo = true;//(SYS_GetCommandLineInt(syshandle, "game2ipo", 0) != 0);
602 bool displaylists = (SYS_GetCommandLineInt(syshandle, "displaylists", 0) != 0);
605 // create the canvas, rasterizer and rendertools
606 RAS_ICanvas* canvas = new KX_BlenderCanvas(win, ar);
607 //canvas->SetMouseState(RAS_ICanvas::MOUSE_INVISIBLE);
608 RAS_IRenderTools* rendertools = new KX_BlenderRenderTools();
609 RAS_IRasterizer* rasterizer = NULL;
612 if (GLEW_VERSION_1_1)
613 rasterizer = new RAS_ListRasterizer(canvas, true, true);
615 rasterizer = new RAS_ListRasterizer(canvas);
617 else if (GLEW_VERSION_1_1)
618 rasterizer = new RAS_VAOpenGLRasterizer(canvas, false);
620 rasterizer = new RAS_OpenGLRasterizer(canvas);
622 // create the inputdevices
623 KX_BlenderKeyboardDevice* keyboarddevice = new KX_BlenderKeyboardDevice();
624 KX_BlenderMouseDevice* mousedevice = new KX_BlenderMouseDevice();
626 // create a networkdevice
627 NG_NetworkDeviceInterface* networkdevice = new
628 NG_LoopBackNetworkDeviceInterface();
630 // create a ketsji/blendersystem (only needed for timing and stuff)
631 KX_BlenderSystem* kxsystem = new KX_BlenderSystem();
633 // create the ketsjiengine
634 KX_KetsjiEngine* ketsjiengine = new KX_KetsjiEngine(kxsystem);
636 Scene *blscene = NULL;
638 blscene = (Scene*) maggie->scene.first;
639 for (Scene *sce= (Scene*) maggie->scene.first; sce; sce= (Scene*) sce->id.next)
641 if (startscenename == (sce->id.name+2))
648 int cframe = 1, startFrame;
651 cframe=blscene->r.cfra;
652 startFrame = blscene->r.sfra;
653 blscene->r.cfra=startFrame;
654 // update_for_newframe(); // XXX scene_update_for_newframe wont cut it!
655 ketsjiengine->SetGame2IpoMode(game2ipo,startFrame);
658 // Quad buffered needs a special window.
659 if(blscene->gm.stereoflag == STEREO_ENABLED){
660 if (blscene->gm.stereomode != RAS_IRasterizer::RAS_STEREO_QUADBUFFERED)
661 rasterizer->SetStereoMode((RAS_IRasterizer::StereoMode) blscene->gm.stereomode);
664 if (exitrequested != KX_EXIT_REQUEST_QUIT_GAME)
666 // create a scene converter, create and convert the startingscene
667 KX_ISceneConverter* sceneconverter = new KX_BlenderSceneConverter(maggie, ketsjiengine);
668 ketsjiengine->SetSceneConverter(sceneconverter);
669 sceneconverter->addInitFromFrame=true;
671 if (always_use_expand_framing)
672 sceneconverter->SetAlwaysUseExpandFraming(true);
675 sceneconverter->SetMaterials(true);
677 KX_Scene* startscene = new KX_Scene(keyboarddevice,
683 // some python things
684 PyObject* dictionaryobject = initGamePythonScripting("Ketsji", psl_Lowest, blenderdata);
685 ketsjiengine->SetPythonDictionary(dictionaryobject);
686 initRasterizer(rasterizer, canvas);
687 PyObject *gameLogic = initGameLogic(ketsjiengine, startscene);
688 PyDict_SetItemString(dictionaryobject, "GameLogic", gameLogic); // Same as importing the module
690 initPythonConstraintBinding();
700 // convert and add scene
701 sceneconverter->ConvertScene(
706 ketsjiengine->AddScene(startscene);
709 ketsjiengine->StartEngine(false);
711 ketsjiengine->SetUseFixedTime(true);
713 ketsjiengine->SetTicRate(
714 (double) blscene->r.frs_sec /
715 (double) blscene->r.frs_sec_base);
718 while ((blscene->r.cfra<=blscene->r.efra)&&(!exitrequested))
720 printf("frame %i\n",blscene->r.cfra);
721 // first check if we want to exit
722 exitrequested = ketsjiengine->GetExitCode();
725 ketsjiengine->NextFrame();
726 blscene->r.cfra=blscene->r.cfra+1;
727 // update_for_newframe(); // XXX scene_update_for_newframe wont cut it
730 exitstring = ketsjiengine->GetExitString();
734 delete sceneconverter;
735 sceneconverter = NULL;
738 blscene->r.cfra=cframe;
739 // set the cursor back to normal
740 canvas->SetMouseState(RAS_ICanvas::MOUSE_NORMAL);
742 // clean up some stuff
755 delete networkdevice;
756 networkdevice = NULL;
760 delete keyboarddevice;
761 keyboarddevice = NULL;
779 } while (exitrequested == KX_EXIT_REQUEST_RESTART_GAME || exitrequested == KX_EXIT_REQUEST_START_OTHER_GAME);
781 // Release Python's GIL
782 PyGILState_Release(gilstate);