Changeset 41

Timestamp:

01/12/10 22:31:22 (2 years ago)

Author:

Carsten

Message:

a) Updated the defaults in CompilerSetup.py.tmpl.
b) The OpenGL rendering context and MatSys initialization is now delayed until the initial canvas is actually shown on screen. Fixes #3.

Location:

cafu/trunk

Files:

• CaWE/AppCaWE.cpp (modified) (8 diffs)
• CaWE/AppCaWE.hpp (modified) (2 diffs)
• CaWE/ParentFrame.cpp (modified) (9 diffs)
• CaWE/ParentFrame.hpp (modified) (2 diffs)
• CompilerSetup.py.tmpl (modified) (1 diff)

cafu/trunk/CaWE/AppCaWE.cpp

@@ -31 +31 @@
 #include "wx/splash.h"
 #include "wx/stdpaths.h"
-
-#if defined(_WIN32)
-#define WIN32_LEAN_AND_MEAN
-#include <windows.h>
-#include <direct.h>
-#endif
 
 #include "AppCaWE.hpp"
@@ -51 +45 @@
 #include "Tool.hpp"
 #include "ToolManager.hpp"
+
+#include "ClipSys/CollisionModelMan_impl.hpp"
 #include "ConsoleCommands/Console.hpp"
 #include "ConsoleCommands/ConsoleStdout.hpp"
@@ -58 +54 @@
 #include "ConsoleCommands/ConFunc.hpp"
 #include "FileSys/FileManImpl.hpp"
-#include "MaterialSystem/MapComposition.hpp"
+#include "GuiSys/GuiMan.hpp"
+#include "GuiSys/Window.hpp"
 #include "MaterialSystem/MaterialManagerImpl.hpp"
-#include "MaterialSystem/Renderer.hpp"
-#include "MaterialSystem/TextureMap.hpp"
-#include "PlatformAux.hpp"
-#include "GuiSys/GuiMan.hpp"
-#include "GuiSys/GuiManImpl.hpp"
-#include "GuiSys/Window.hpp"
 #include "TypeSys.hpp"
-#include "ClipSys/CollisionModelMan_impl.hpp"
-
-#ifdef _WIN32
-#elif __linux__
-#include <dirent.h>
-#include <dlfcn.h>
-#define __stdcall
-#define GetProcAddress dlsym
-#define FreeLibrary dlclose
-#endif
 
 
@@ -103 +84 @@
     : wxApp(),
       m_FileConfig(NULL),
-      m_ParentFrame(NULL),
-      m_RendererDLL(NULL)
+      m_ParentFrame(NULL)
 {
     static ConsoleInterpreterImplT ConInterpreterImpl;
@@ -166 +146 @@
     m_FileConfig=new wxFileConfig("CaWE", "Carsten Fuchs Software", UserDataDir+"/CaWE.config");
     wxConfigBase::Set(m_FileConfig);
+
+
+    // Setup the global Material Manager pointer.
+    static MaterialManagerImplT MatManImpl;
+
+    MaterialManager=&MatManImpl;
+
+    // Register the material script with the CaWE materials definitions.
+    if (MaterialManager->RegisterMaterialScript(AppDir+"/res/CaWE.cmat", AppDir+"/res/").Size()==0)
+        wxMessageBox("CaWE.cmat not found in \""+AppDir+"\".", "WARNING");
 
 
@@ -228 +218 @@
     /**********************************************/
 
-    // Setup the global Material Manager pointer.
-    static MaterialManagerImplT MatManImpl;
-
-    MaterialManager=&MatManImpl;
-
-
-    // Prepare the name strings.
-#ifdef SCONS_BUILD_DIR
-    #define QUOTE(str) QUOTE_HELPER(str)
-    #define QUOTE_HELPER(str) #str
-
-    #ifdef _WIN32
-    const wxString MatSysRendererDLLName=wxString("Libs/")+QUOTE(SCONS_BUILD_DIR)+"/MaterialSystem/RendererOpenGL12.dll";
-    #else
-    const wxString MatSysRendererDLLName=wxString("Libs/")+QUOTE(SCONS_BUILD_DIR)+"/MaterialSystem/libRendererOpenGL12.so";
-    #endif
-
-    #undef QUOTE
-    #undef QUOTE_HELPER
-#else
-    const wxString MatSysRendererDLLName=wxString("Renderers/RendererOpenGL12")+PlatformAux::GetEnvFileSuffix().c_str()+".dll";
-#endif
-
-
-    // Load the DLL.
-    #ifdef _WIN32
-        m_RendererDLL=LoadLibrary(L"./RendererOpenGL12.dll");
-
-        if (m_RendererDLL==NULL)
-            m_RendererDLL=LoadLibrary(MatSysRendererDLLName);
-    #else
-        // Note that RTLD_GLOBAL must *not* be passed-in here, or else we get in trouble with subsequently loaded libraries.
-        // (E.g. dlsym(RendererDLL, "GetRenderer") return identical results for different RendererDLLs.)
-        // Please refer to the man page of dlopen for more details.
-        m_RendererDLL=dlopen("./libRendererOpenGL12.so", RTLD_NOW);
-        if (!m_RendererDLL) m_RendererDLL=dlopen(MatSysRendererDLLName.c_str(), RTLD_NOW);
-
-        if (!m_RendererDLL) printf("%s\n", dlerror());
-    #endif
-
-    if (m_RendererDLL==NULL) { wxMessageBox("FAILED - could not load the library at "+MatSysRendererDLLName, "ERROR"); return false; }
-
-
-    // Get the renderer.
-    typedef MatSys::RendererI* (__stdcall *GetRendererT)(cf::ConsoleI* Console_, cf::FileSys::FileManI* FileMan_);
-
-    #ifdef _WIN32
-        GetRendererT GetRenderer=(GetRendererT)GetProcAddress(m_RendererDLL, "_GetRenderer@8");
-    #else
-        GetRendererT GetRenderer=(GetRendererT)GetProcAddress(m_RendererDLL, "GetRenderer");
-    #endif
-
-    if (!GetRenderer) { wxMessageBox("FAILED - could not get the address of the GetRenderer() function.", "ERROR"); FreeLibrary(m_RendererDLL); return false; }
-
-    // When we get here, the console and the file man must already have been initialized.
-    assert(Console!=NULL);
-    assert(cf::FileSys::FileMan!=NULL);
-    MatSys::Renderer=GetRenderer(Console, cf::FileSys::FileMan);
-
-    if (MatSys::Renderer==NULL) { wxMessageBox("FAILED - could not get the renderer.", "ERROR"); FreeLibrary(m_RendererDLL); return false; }
-
-
-    // Check if we already have OpenGL errors here.
-    // Shouldn't be the case though, because any errors here must have been caused by the ParentFrames wxCanvas ctor.
-    GLenum Error=glGetError();
-    if (Error!=GL_NO_ERROR) wxMessageBox(wxString::Format("glGetError() reported error %i!", Error));
-
-    if (!MatSys::Renderer->IsSupported())
-    {
-        wxMessageBox("Renderer "+MatSysRendererDLLName+" says that it's not supported.\n\n"
-                     "(This may be caused by your desktop being set to 16 BPP (or less).\n"
-                     "Please set your desktop bit-depth to 32 BPP (True Color), and try again.)");
-        FreeLibrary(m_RendererDLL);
-        return false;
-    }
-
-    MatSys::Renderer->Initialize();
-
-
-    // Get the texture manager.
-    typedef MatSys::TextureMapManagerI* (__stdcall *GetTMMT)();
-
-    #ifdef _WIN32
-        GetTMMT GetTMM=(GetTMMT)GetProcAddress(m_RendererDLL, "_GetTextureMapManager@0");
-    #else
-        GetTMMT GetTMM=(GetTMMT)GetProcAddress(m_RendererDLL, "GetTextureMapManager");
-    #endif
-
-    if (!GetTMM) { wxMessageBox("FAILED - could not get the address of the GetTextureMapManager() function.", "ERROR"); FreeLibrary(m_RendererDLL); return false; }
-    MatSys::TextureMapManager=GetTMM();
-    if (MatSys::TextureMapManager==NULL) { wxMessageBox("No TextureMapManager obtained.", "ERROR"); FreeLibrary(m_RendererDLL); return false; }
-
-    // Register the material script with the CaWE materials definitions.
-    if (MaterialManager->RegisterMaterialScript(AppDir+"/res/CaWE.cmat", AppDir+"/res/").Size()==0)
-        wxMessageBox("CaWE.cmat not found in \""+AppDir+"\".", "WARNING");
-
-    // Create a very simple lightmap for the materials that need one, and register it with the renderer.
-    char Data[]={ 255, 255, 255, 255, 255, 255, 0, 0,
-                  255, 255, 255, 255, 255, 255, 0, 0 };
-
-    MatSys::Renderer->SetCurrentLightMap(MatSys::TextureMapManager->GetTextureMap2D(Data, 2, 2, 3, true, MapCompositionT(MapCompositionT::Linear, MapCompositionT::Linear)));
-    MatSys::Renderer->SetCurrentLightDirMap(NULL);      // The MatSys provides a default for LightDirMaps when NULL is set.
-
-
     // Initialize the global options from the CaWE config files.
     Options.Init();
@@ -339 +225 @@
     CursorMan=new CursorManT;
 
-    // Initialize the GUI managager.
-    // This has to be done after all materials are loaded (during Options initialization) so the GuiManager finds its default material.
-    cf::GuiSys::GuiMan=new cf::GuiSys::GuiManImplT();
-
     return wxApp::OnInit();
 }
@@ -356 +238 @@
     m_FileConfig=NULL;
 
-    // Release the GuiManager BEFORE the renderer.
-    delete cf::GuiSys::GuiMan;
-    cf::GuiSys::GuiMan=NULL;
-
-    // Unload the Cafu Material System.
-    // Checks for NULL are required to gracefully handle (DLL loading, and other) failures in InitInstance().
-    if (MatSys::Renderer!=NULL && m_RendererDLL)
-    {
-        MatSys::Renderer->Release();
-        FreeLibrary(m_RendererDLL);
-    }
-
     // TODO: delete cf::FileSys::FileMan;   // Shoud have   cf::FileSys::FileMan=new cf::FileSys::FileManImplT;   in OnInit().
     cf::FileSys::FileMan=NULL;

cafu/trunk/CaWE/AppCaWE.hpp

@@ -27 +27 @@
 #include "wx/wx.h"
 
-#if __linux__
-#define HMODULE void*
-#endif
-
-
 class ParentFrameT;
 class wxFileConfig;
@@ -54 +49 @@
     wxFileConfig* m_FileConfig;
     ParentFrameT* m_ParentFrame;
-    HMODULE       m_RendererDLL;
 };
 

cafu/trunk/CaWE/ParentFrame.cpp

@@ -35 +35 @@
 #include "ModelEditor/Document.hpp"
 
+#include "ConsoleCommands/Console.hpp"
+#include "FileSys/FileManImpl.hpp"
 #include "GuiSys/GuiImpl.hpp"   // Needed to catch InitErrorT if GUI document creation fails.
+#include "GuiSys/GuiManImpl.hpp"
+#include "MaterialSystem/MapComposition.hpp"
+#include "MaterialSystem/Renderer.hpp"
+#include "MaterialSystem/TextureMap.hpp"
 #include "TextParser/TextParser.hpp"
+#include "PlatformAux.hpp"
 
 #include "wx/wx.h"
@@ -50 +57 @@
 #include <fstream>
 
+#ifdef _WIN32
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+#include <direct.h>
+#elif __linux__
+#include <dirent.h>
+#include <dlfcn.h>
+#define __stdcall
+#define GetProcAddress dlsym
+#define FreeLibrary dlclose
+#endif
+
 
 BEGIN_EVENT_TABLE(ParentFrameT, wxMDIParentFrame)
@@ -55 +74 @@
     EVT_SIZE(ParentFrameT::OnSize)
 #endif
+    EVT_SHOW(ParentFrameT::OnShow)
     EVT_CLOSE(ParentFrameT::OnClose)
     EVT_MENU_RANGE(ID_MENU_FILE_NEW_MAP,  ID_MENU_FILE_EXIT,  ParentFrameT::OnMenuFile)
@@ -85 +105 @@
 #endif
       m_GLCanvas(NULL),
-      m_GLContext(NULL)
+      m_GLContext(NULL),
+      m_RendererDLL(NULL)
 {
     wxMenuBar *item0 = new wxMenuBar;
@@ -142 +163 @@
 
 
-    // Create the parent GL canvas.
-    m_GLCanvas=new wxGLCanvas(this, -1, OpenGLAttributeList, wxPoint(600, 5), wxSize(10, 10), 0, "ParentGLCanvas");
-
-
-    Centre(wxBOTH);
-    Maximize(true);             // The wxMAXIMIZE frame style does not seem to have any effect for this frame...(?)
-    Show(true);
+    // Create the parent GL canvas and a GL context.
+    m_GLCanvas =new wxGLCanvas(this, -1, OpenGLAttributeList, wxPoint(600, 5), wxSize(10, 10), 0, "ParentGLCanvas");
     m_GLContext=new wxGLContext(m_GLCanvas);
-    wxASSERT(m_GLContext);
-    m_GLCanvas->SetCurrent(*m_GLContext);   // Aha - under X11 this must be *after* Show(true), not before the window is opened!
-
-    // The above attribute list can certainly NOT be met on 16 BPP desktops.
-    // However, we do not check if the RC of the m_GLCanvas is valid here (it should),
-    // as the IsSupported() method of each MatSys Renderer does the same check, too,
-    // and I have adjusted the error message appropriately there (see AppCaWE.cpp,
-    // the user is told to check whether his desktop is set to 32 BPP if IsSupported() fails).
-    // const char* Version=(char const*)glGetString(GL_VERSION);     // Another way to see if the RC is valid: Version!=NULL <==> RC valid.
-    // printf("%s (%u): GL_VERSION string is \"%s\".\n", __FILE__, __LINE__, Version==NULL ? "NULL" : Version);
+
+    Maximize();     // Under wxGTK, the wxMAXIMIZE frame style does not seem to suffice...
+    Show();         // Without this, the parent frame is not shown...
+
+#ifdef __WXMSW__
+    // ARGH! See my message "wx 2.9.0, Showing parent frame during app init" to wx-users
+    // at http://article.gmane.org/gmane.comp.lib.wxwindows.general/68490 for details.
+    wxShowEvent SE(0, true);
+    OnShow(SE);
+#endif
 }
 
@@ -166 +182 @@
 {
     m_FileHistory.Save(*wxConfigBase::Get());
+
+    // Release the GuiManager (BEFORE the renderer).
+    if (cf::GuiSys::GuiMan!=NULL)
+    {
+        delete cf::GuiSys::GuiMan;
+        cf::GuiSys::GuiMan=NULL;
+    }
+
+    // Release the Cafu Material System.
+    MatSys::TextureMapManager=NULL;
+
+    if (MatSys::Renderer!=NULL)
+    {
+        MatSys::Renderer->Release();
+        MatSys::Renderer=NULL;
+    }
+
+    if (m_RendererDLL!=NULL)
+    {
+        FreeLibrary(m_RendererDLL);
+        m_RendererDLL=NULL;
+    }
 }
 
@@ -204 +242 @@
 }
 #endif
+
+
+void ParentFrameT::OnShow(wxShowEvent& SE)
+{
+    if (SE.IsShown() && m_RendererDLL==NULL)
+    {
+        // Initialize the Material System.
+        // This code is in this place due to a few peculiarities of OpenGL under GTK that do not exist under MSW:
+        //   - First, an OpenGL context can only be made current with a canvas that is shown on the screen.
+        //   - Second, calling Show() in the ctor above doesn't show the frame immediately - that requires
+        //     getting back to the main event loop first.
+        // Consequently, the first and best opportunity for initializing the MatSys is here.
+        wxASSERT(m_GLCanvas->IsShownOnScreen());
+
+        // If this was in the ctor, it would trigger an assertion in debug build and yield an invalid (unusable)
+        // OpenGL context in release builds (the GL code in the MatSys::Renderer->IsSupported() methods would fail).
+        m_GLCanvas->SetCurrent(*m_GLContext);
+
+        // Prepare the name strings.
+        #ifdef SCONS_BUILD_DIR
+            #define QUOTE(str) QUOTE_HELPER(str)
+            #define QUOTE_HELPER(str) #str
+
+            #ifdef _WIN32
+            const wxString MatSysRendererDLLName=wxString("Libs/")+QUOTE(SCONS_BUILD_DIR)+"/MaterialSystem/RendererOpenGL12.dll";
+            #else
+            const wxString MatSysRendererDLLName=wxString("Libs/")+QUOTE(SCONS_BUILD_DIR)+"/MaterialSystem/libRendererOpenGL12.so";
+            #endif
+
+            #undef QUOTE
+            #undef QUOTE_HELPER
+        #else
+            const wxString MatSysRendererDLLName=wxString("Renderers/RendererOpenGL12")+PlatformAux::GetEnvFileSuffix().c_str()+".dll";
+        #endif
+
+
+        // Load the DLL.
+        #ifdef _WIN32
+            m_RendererDLL=LoadLibrary(L"./RendererOpenGL12.dll");
+
+            if (m_RendererDLL==NULL)
+                m_RendererDLL=LoadLibrary(MatSysRendererDLLName);
+        #else
+            // Note that RTLD_GLOBAL must *not* be passed-in here, or else we get in trouble with subsequently loaded libraries.
+            // (E.g. dlsym(RendererDLL, "GetRenderer") return identical results for different RendererDLLs.)
+            // Please refer to the man page of dlopen for more details.
+            m_RendererDLL=dlopen("./libRendererOpenGL12.so", RTLD_NOW);
+            if (!m_RendererDLL) m_RendererDLL=dlopen(MatSysRendererDLLName.c_str(), RTLD_NOW);
+
+            if (!m_RendererDLL) printf("%s\n", dlerror());
+        #endif
+
+        if (m_RendererDLL==NULL) { wxMessageBox("FAILED - could not load the library at "+MatSysRendererDLLName, "ERROR"); Destroy(); return; }
+
+
+        // Get the renderer.
+        typedef MatSys::RendererI* (__stdcall *GetRendererT)(cf::ConsoleI* Console_, cf::FileSys::FileManI* FileMan_);
+
+        #ifdef _WIN32
+            GetRendererT GetRenderer=(GetRendererT)GetProcAddress(m_RendererDLL, "_GetRenderer@8");
+        #else
+            GetRendererT GetRenderer=(GetRendererT)GetProcAddress(m_RendererDLL, "GetRenderer");
+        #endif
+
+        if (!GetRenderer) { wxMessageBox("FAILED - could not get the address of the GetRenderer() function.", "ERROR"); Destroy(); return; }
+
+        // When we get here, the console and the file man must already have been initialized.
+        wxASSERT(Console!=NULL);
+        wxASSERT(cf::FileSys::FileMan!=NULL);
+        MatSys::Renderer=GetRenderer(Console, cf::FileSys::FileMan);
+
+        if (MatSys::Renderer==NULL) { wxMessageBox("FAILED - could not get the renderer.", "ERROR"); Destroy(); return; }
+
+
+        // Check if we already have OpenGL errors here.
+        // Shouldn't be the case though, because any errors here must have been caused by the ParentFrames wxCanvas ctor.
+        GLenum Error=glGetError();
+        if (Error!=GL_NO_ERROR) wxMessageBox(wxString::Format("glGetError() reported error %i!", Error));
+
+        if (!MatSys::Renderer->IsSupported())
+        {
+            wxMessageBox("Renderer "+MatSysRendererDLLName+" says that it's not supported.\n\n"
+                         "This may be caused by your desktop being set to 16 BPP (or less).\n"
+                         "Please set your desktop bit-depth to 24 or 32 BPP (True Color), and try again.");
+            Destroy();
+            return;
+        }
+
+        MatSys::Renderer->Initialize();
+
+
+        // Get the texture manager.
+        typedef MatSys::TextureMapManagerI* (__stdcall *GetTMMT)();
+
+        #ifdef _WIN32
+            GetTMMT GetTMM=(GetTMMT)GetProcAddress(m_RendererDLL, "_GetTextureMapManager@0");
+        #else
+            GetTMMT GetTMM=(GetTMMT)GetProcAddress(m_RendererDLL, "GetTextureMapManager");
+        #endif
+
+        if (!GetTMM) { wxMessageBox("FAILED - could not get the address of the GetTextureMapManager() function.", "ERROR"); Destroy(); return; }
+        MatSys::TextureMapManager=GetTMM();
+        if (MatSys::TextureMapManager==NULL) { wxMessageBox("No TextureMapManager obtained.", "ERROR"); Destroy(); return; }
+
+        // Create a very simple lightmap for the materials that need one, and register it with the renderer.
+        char Data[]={ 255, 255, 255, 255, 255, 255, 0, 0,
+                      255, 255, 255, 255, 255, 255, 0, 0 };
+
+        MatSys::Renderer->SetCurrentLightMap(MatSys::TextureMapManager->GetTextureMap2D(Data, 2, 2, 3, true, MapCompositionT(MapCompositionT::Linear, MapCompositionT::Linear)));
+        MatSys::Renderer->SetCurrentLightDirMap(NULL);      // The MatSys provides a default for LightDirMaps when NULL is set.
+
+
+        // Initialize the GUI managager.
+        // This has to be done after all materials are loaded (AppCaWE::OnInit()) and after the MatSys::Renderer has been initialized,
+        // so that the GuiManager finds its default material and can register it for rendering.
+        cf::GuiSys::GuiMan=new cf::GuiSys::GuiManImplT();
+    }
+}
 
 
@@ -312 +468 @@
 void ParentFrameT::OnMenuFile(wxCommandEvent& CE)
 {
+    wxASSERT(m_RendererDLL!=NULL && MatSys::Renderer!=NULL);
+
     switch (CE.GetId())
     {
@@ -670 +828 @@
 void ParentFrameT::OnMenuHelp(wxCommandEvent& CE)
 {
+    wxASSERT(m_RendererDLL!=NULL && MatSys::Renderer!=NULL);
+
     switch (CE.GetId())
     {

cafu/trunk/CaWE/ParentFrame.hpp

@@ -28 +28 @@
 #include "wx/mdi.h"
 #include "Templates/Array.hpp"
+
+#if __linux__
+#define HMODULE void*
+#endif
 
 
@@ -110 +114 @@
     void OnSize    (wxSizeEvent&    SE);
 #endif
+    void OnShow    (wxShowEvent&    SE);    ///< Event handler for "has been shown" events.
     void OnClose   (wxCloseEvent&   CE);    ///< Event handler for close events, e.g. after a system close button or command or a call to Close(). See wx Window Deletion Overview for more details.
     void OnMenuFile(wxCommandEvent& CE);    ///< Event handler for File menu events.
     void OnMenuHelp(wxCommandEvent& CE);    ///< Event handler for Help menu events.
+
+    HMODULE m_RendererDLL;
 
     DECLARE_EVENT_TABLE()

cafu/trunk/CompilerSetup.py.tmpl

@@ -1 +1 @@
 # Edit the settings and paths in this file as required for your system.
-#
-# The correct paths are easily determined by browsing your programs folder with
-# the Windows Explorer, by opening the Visual Studio Command Prompt and viewing
-# the environment variables (enter the SET command in order to output them all),
-# or by looking them up in the Visual Studio IDE.
-
 
 # The default compiler to be used for each platform.
 # Note that this can easily be overridden at the command-line
-# by the "cmp" parameter. Example: scons -Q cmp=vc9
-defaultCompilerWin32="vc8";     # Valid values are "vc8" and "vc9".
+# by the "cmp" parameter. Example: scons -Q cmp=vc8
+defaultCompilerWin32="vc9";     # Valid values are "vc8" and "vc9".
 defaultCompilerLinux="g++";     # Currently, only "g++" is a valid value.