flightgear/src/GUI/gui.h

/**************************************************************************
 * gui.h
 *
 * Written 1998 by Durk Talsma, started Juni, 1998.  For the flight gear
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * $Id$
 **************************************************************************/


#ifndef _GUI_H_
#define _GUI_H_

#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif

#include <plib/pu.h>

#include <simgear/structure/exception.hxx>

#define TR_HIRES_SNAP   1

namespace osg
{
class GraphicsContext;
}
// gui.cxx
extern void guiStartInit(osg::GraphicsContext*);
extern bool guiFinishInit();
extern bool openBrowser(string address);
extern void mkDialog(const char *txt);
extern void guiErrorMessage(const char *txt);
extern void guiErrorMessage(const char *txt, const sg_throwable &throwable);

extern bool fgDumpSnapShot();
extern void fgDumpSceneGraph();
extern void fgDumpTerrainBranch();
extern void fgPrintVisibleSceneInfoCommand();

extern puFont guiFnt;
extern fntTexFont *guiFntHandle;
extern int gui_menu_on;

// from gui_funcs.cxx
extern void fgDumpSnapShotWrapper();
#ifdef TR_HIRES_SNAP
extern void fgHiResDumpWrapper();
extern void fgHiResDump();
#endif

extern void helpCb();

typedef struct {
        const char *name;
        void (*fn)();
} __fg_gui_fn_t;
extern const __fg_gui_fn_t __fg_gui_fn[];

#endif // _GUI_H_
Initial revision. 1998-06-12 01:07:06 +00:00			`/**************************************************************************`
			`* gui.h`
			`*`
			`* Written 1998 by Durk Talsma, started Juni, 1998. For the flight gear`
			`* project.`
			`*`
			`* This program is free software; you can redistribute it and/or`
			`* modify it under the terms of the GNU General Public License as`
			`* published by the Free Software Foundation; either version 2 of the`
			`* License, or (at your option) any later version.`
			`*`
			`* This program is distributed in the hope that it will be useful, but`
			`* WITHOUT ANY WARRANTY; without even the implied warranty of`
			`* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU`
			`* General Public License for more details.`
			`*`
			`* You should have received a copy of the GNU General Public License`
			`* along with this program; if not, write to the Free Software`
new FSF address 2006-02-21 01:16:04 +00:00			`* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.`
Initial revision. 1998-06-12 01:07:06 +00:00			`*`
			`* $Id$`
			`**************************************************************************/`


			`#ifndef _GUI_H_`
			`#define _GUI_H_`

Fix various compiler warnings contributed by Norman Princeton. 2001-04-22 17:00:08 +00:00			`#ifdef HAVE_CONFIG_H`
			`# include <config.h>`
			`#endif`

Yank out all the glut dependencies and concentrate them in a (easily reimplementable) Main/fg_os.cxx file. 2004-03-31 21:10:32 +00:00			`#include <plib/pu.h>`
Initial revision. 1998-06-12 01:07:06 +00:00
Move FGEventMgr and FGSubsystemMgr over to SimGear, add SGEventMgr to FlightGear's globals structre and some small code cleanups 2003-09-24 17:20:55 +00:00			`#include <simgear/structure/exception.hxx>`
- added guiErrorMessage 2001-07-24 23:50:44 +00:00
Erik Hofman: I cleaned up the XML menu code a fair bit, in preparation to C++-ifying it. 2002-08-25 22:53:38 +00:00			`#define TR_HIRES_SNAP 1`

CameraGroup class for managing multiple cameras. CameraGroup supports cameras opened in different windows or in the same window, with flexible view and perspective specification. Clean up mouse click handling via osgViewer. Don't let any camera "have focus;" this forces events to be reported in window coordinates and simplifies life. Don't use the osgViewer::View::requestWarpPointer method; instead use our own code which only deals with window coordinates. Make glut and sdl versions work with CameraGroup too. 2008-08-01 15:57:29 +00:00			`namespace osg`
			`{`
			`class GraphicsContext;`
			`}`
Norman Vine has split up the GUI code into more managable/logical sections. 2001-01-08 20:55:16 +00:00			`// gui.cxx`
CameraGroup class for managing multiple cameras. CameraGroup supports cameras opened in different windows or in the same window, with flexible view and perspective specification. Clean up mouse click handling via osgViewer. Don't let any camera "have focus;" this forces events to be reported in window coordinates and simplifies life. Don't use the osgViewer::View::requestWarpPointer method; instead use our own code which only deals with window coordinates. Make glut and sdl versions work with CameraGroup too. 2008-08-01 15:57:29 +00:00			`extern void guiStartInit(osg::GraphicsContext*);`
Clean up OSG camera setup and interface to plib PUI Switch to defining PU_USE_NONE and providing our own callback functions to pui for "get window" and "get window size." A new WindowSystemAdapter class assigns ID numbers to windows for the purpose of identifying them to plib; the window size can be extracted from the osg::GraphicsContext class in all the different implementations (osgViewer, glut, sdl). Implement a GraphicsContextOperation that runs code in a particular graphics context, perhaps in another thread, and provides an isFinished() method to test if the operation has finished. This allows us to initialize plib PUI properly if there are multiple graphics contexts without using fgMakeCurrent(). fgMakeCurrent() can't work in multi-threaded OSG configurations. Eliminate fgMakeCurrent() and all its uses, either by using GraphicsContextOperation or by seeing that it is not necessary. Attach the GUI camera as a slave camera. Don't manipulate the OSG state in the drawImplementation() functions for SGHUDAndPanelDrawable and SGPuDrawable; it's not needed. 2008-05-19 21:21:03 +00:00			`extern bool guiFinishInit();`
Add generic "open-browser" command to show URLs or local HTML/text pages. Replace deprecated "old-help-dialog" command with generic "open-browser". Can also be used to add links to aircraft manuals in the menubar (local file or http) , i.e. <binding> <command>open-browser</command> <path>Aircraft/ogeL/FlightManual.html</path> </binding> 2011-10-09 10:37:43 +00:00			`extern bool openBrowser(string address);`
GUI updates contributed by Norman Vine. 1999-06-01 21:17:10 +00:00			`extern void mkDialog(const char *txt);`
- added guiErrorMessage 2001-07-24 23:50:44 +00:00			`extern void guiErrorMessage(const char *txt);`
			`extern void guiErrorMessage(const char *txt, const sg_throwable &throwable);`
GUI changes contributed by Norman Vine. 1999-05-12 01:11:17 +00:00
Nicolas: make screenshot target dir configurable (idea and first draft) --prop:sim/paths/screenshot-dir=/tmp 2008-04-26 22:34:46 +00:00			`extern bool fgDumpSnapShot();`
Modified Files: src/GUI/gui.h src/GUI/gui_funcs.cxx src/Main/fg_commands.cxx src/Main/renderer.cxx src/Main/renderer.hxx: Tim Moore: These patches implement a command to dump the entire OSG scene graph as a .osg text file. While large, this allows debuggers to really see what's happening in the scene graph. 2007-05-26 11:39:13 +00:00			`extern void fgDumpSceneGraph();`
Add a command to dump just the terrain portion of the scene graph to a .osg file. Possible uses of this functionality could include converting the model to some other format or coordinate system for use in some other visualization or simulation. 2007-11-21 20:51:49 +00:00			`extern void fgDumpTerrainBranch();`
add a command to print information about visible objects in the scene 2010-11-14 14:12:58 +00:00			`extern void fgPrintVisibleSceneInfoCommand();`
Add a key mapping (F3) for taking a screen snap shot. Keep track of and free index arrays that are fed to ssg. Ssg branch deletion memory leak work around. 1999-10-26 03:45:33 +00:00
GUI changes contributed by Norman Vine. 1999-05-12 01:11:17 +00:00			`extern puFont guiFnt;`
			`extern fntTexFont *guiFntHandle;`
Norman Vine has split up the GUI code into more managable/logical sections. 2001-01-08 20:55:16 +00:00			`extern int gui_menu_on;`
GUI changes contributed by Norman Vine. 1999-05-12 01:11:17 +00:00
Erik Hofman: I cleaned up the XML menu code a fair bit, in preparation to C++-ifying it. 2002-08-25 22:53:38 +00:00			`// from gui_funcs.cxx`
- remove unused puObject args in gui fgcommands - remove no longer used PU macros 2008-06-23 18:28:02 +00:00			`extern void fgDumpSnapShotWrapper();`
Erik Hofman: I cleaned up the XML menu code a fair bit, in preparation to C++-ifying it. 2002-08-25 22:53:38 +00:00			`#ifdef TR_HIRES_SNAP`
- remove unused puObject args in gui fgcommands - remove no longer used PU macros 2008-06-23 18:28:02 +00:00			`extern void fgHiResDumpWrapper();`
Activate the hi res screen capture functionality again, however it is no longer working 100% correctly. :-( 2004-09-27 02:39:54 +00:00			`extern void fgHiResDump();`
Erik Hofman: I cleaned up the XML menu code a fair bit, in preparation to C++-ifying it. 2002-08-25 22:53:38 +00:00			`#endif`
Fix up Win32 GUI code after simgear/screen cleanup; deprecated dialog code going away. 2010-07-31 15:54:37 +00:00
- remove unused puObject args in gui fgcommands - remove no longer used PU macros 2008-06-23 18:28:02 +00:00			`extern void helpCb();`
Erik Hofman: I cleaned up the XML menu code a fair bit, in preparation to C++-ifying it. 2002-08-25 22:53:38 +00:00
			`typedef struct {`
Fixes for compiling with gcc 4.3 Include standard header files and qualify with std:: where needed. Qualify various char parameters and variables with const. 2008-04-13 21:12:36 +00:00			`const char *name;`
- remove unused puObject args in gui fgcommands - remove no longer used PU macros 2008-06-23 18:28:02 +00:00			`void (*fn)();`
Erik Hofman: I cleaned up the XML menu code a fair bit, in preparation to C++-ifying it. 2002-08-25 22:53:38 +00:00			`} __fg_gui_fn_t;`
			`extern const __fg_gui_fn_t __fg_gui_fn[];`

Fixed teleportation and dialog box crashes. 1999-05-06 21:14:06 +00:00			`#endif // _GUI_H_`