|
G3D::GApp Class ReferenceFor each frame, the GApp has several tasks that can be implemented by overriding base class methods. More...
Detailed DescriptionFor each frame, the GApp has several tasks that can be implemented by overriding base class methods.The use of cooperative, round-robbin scheduling avoids the need for threads in most applications. These tasks are:
Other event handlers include onInit/onCleanup, onEvent for fine-grain event handling, and onConsoleCommand.
The onConsoleCommand handler allows you to add an in-game command console to your program. By default it is activated when '~' is pressed; you can also set the GApp::escapeAction to open the console on ESC. The console is a Widget, so you can completely disable it (e.g., in a release build of the program) by executing To invoke a GApp and let it control the main loop, call run().
Member Enumeration Documentation
Constructor & Destructor Documentation
This argument is useful for substituting a different window system (e.g. GlutWindow)
Member Function Documentation
Installs a module. Actual insertion may be delayed until the next frame.
If debugShowText is true, prints to an on-screen buffer that is cleared every frame.
Simulation time that is always advanced by precisely the desiredFrameDuration * simTimeRate, regardless of the actual frame duration.
Invoked after onSimulation is run on the installed GModules and GApp. Not used by most programs.
Invoked before onSimulation is run on the installed GModules and GApp. This is not used by most programs; it is primarily a hook for those performing extensive physical simulation on the GModules that need a setup and cleanup step.
Unload/deallocate your data here. Unlike the constructor, this catches common exceptions. It is called after the last frame is processed.
Invoked when a user presses enter in the in-game console. The default implementation ends the program if the command is "exit".
It is recommended to override onUserInput() instead of this method. Override if you need to explicitly handle events raw in the order they appear rather than once per frame by checking the current system state. Note that the userInput contains a record of all keys pressed/held, mouse, and joystick state, so you do not have to override this method to handle basic input events. Return true if the event has been consumed (i.e., no-one else including GApp should process it further). The default implementation does nothing.
Rendering callback used to paint the screen. Called automatically. Override and implement. The debugCamera's projection and object to world matrices are set by default; you can set other cameras as desired. RenderDevice::beginFrame and endFrame are called for you.
Load your data here. Unlike the constructor, this catches common exceptions. It is called before the first frame is processed.
Update any state you need to here. This is a good place for AI code, for example. Called after network and user input, before simulation.
For a networked app, override this to implement your network message polling.
Called before onGraphics. Append any models that you want rendered (you can also explicitly pose and render in your onGraphics method). The provided arrays will already contain posed models from any installed Widgets.
Override this with your simulation code. Called from GApp::run. Default implementation does nothing. simTime(), idealSimTime() and realTime() are incremented after doSimulation is called, so at the beginning of call the current time is the end of the previous frame.
Routine for processing user input from the previous frame. Default implementation does nothing.
Task to be used for frame rate limiting. Overriding onWait is not recommended. Frame rate limiting is useful to avoid overloading a maching that is running background tasks and for situations where fixed time steps are needed for simulation and there is no reason to render faster. Default implementation System::sleep()s until cumulativeTime + time in wait is greater than or equal to frameDuration = 1 / desiredFrameRate.
Processes all pending events on the GWindow queue into the userInput.
Accumulated wall-clock time since init was called on this applet. Since this time is accumulated, it may drift from the true wall-clock obtained by System::time().
The actual removal of the module may be delayed until the next frame.
Called from GApplet::run immediately after doGraphics to render the debugging text. Does nothing if debugMode is false. It is not usually necessary to override this method.
Call this to run the app.
If debugShowText is true, prints to an on-screen buffer that is cleared every frame. Called by G3D::screenPrintf
The manipulator that positions the defaultCamera every frame. By default, this is set to the defaultController. This may be set to NULL to disable explicit camera positioning.
Change to invoke frame limiting via doWait. Defaults to inf()
Invoke to true to end the program at the end of the next event loop.
In-simulation time since init was called on this applet. Takes into account simTimeSpeed. Automatically incremented after doSimulation.
Amount of time that passes in simTime for every second of realTime. e.g., 1.0 == real-time, 2.0 == fast, 0.5 == slow, 0.0 = stop time. Default is 1.0.
Friends And Related Function Documentation
Member Data DocumentationWhen true and the window is resizable, automatically responds to SDL_RESIZE events by notifying the RenderDevice that the window has been resized and resetting the viewport to full screen. (default is true) When true, there is an assertion failure if an exception is thrown. Default is true. Command console.
Initialized to ", G3D will search for the standard data files.">GApp::Settings::dataDir, or if that is "<AUTO>", to System::demoFindData(). To make your program distributable, override the default and copy all data files you need to a local directory. Recommended setting is "data/" or "./", depending on where you put your data relative to the executable. Your data directory must contain the default debugging font, "console-small.fnt", unless you change it. NULL if not loaded.
debugWindow->pane()
Strings that have been printed with screenPrintf. Protected by m_debugTextMutex. Add your own debugging controls to this window.
A default camera that is driven by the defaultController.
Allows first person (Quake game-style) control using the arrow keys or W,A,S,D and the mouse.
The window that displays buttons for debugging. If GApp::Settings::useDeveloperTools is true this will be created and added as a Widget on the GApp. Otherwise this will be NULL. When true an GKey::ESCAPE keydown event quits the program. (default is true) When true GKey::F2 keydown deactivates the camera and restores the mouse cursor. (default is true). This works even if GApp::Settings::useDeveloperTools is false.
Used to find the frame for defaultCamera.
When true, the G3D::UserInput->beginEvents/endEvents processing is handled for you by calling processGEventQueue() before G3D::GApp::onUserInput is called. If you turn this off, you must call processGEventQueue() or provide your own event to userInput processing in onUserInput. (default is true) When true, debugPrintf prints to the screen. (default is true) When true, renderDebugInfo prints the frame rate and other data to the screen.
The documentation for this class was generated from the following file: Generated on Thu Aug 2 11:40:45 2007 for G3D by 
1.5.2
Hosted by |