removed stupid file headers that eclipse put in

[l2e.git] / src / app / Application.h

diff --git a/src/app/Application.h b/src/app/Application.h
index cf1261b28f1a8c8799c3ce8aa2a5217af9ef3ab2..62d9740b943aa41107d78c32f704671f427a9392 100644 (file)
--- a/src/app/Application.h
+++ b/src/app/Application.h
@@ -1,13 +1,7 @@
-/*
- * Application.h
- *
- *  Created on: Apr 8, 2012
- *      Author: holy
- */
-
 #ifndef APP_APPLICATION_H_
 #define APP_APPLICATION_H_
 
+#include "fwd.h"
 #include "Input.h"
 #include "Timer.h"
 #include "../sdl/InitScreen.h"
@@ -19,12 +13,23 @@
 
 namespace app {
 
-class State;
-
+/// Application controller class.
+/// Operates on a state stack that can be modified via ChangeState, PushState,
+/// and PopState.
+/// All state changes are delayed until the looping mechanism gets control again
+/// (i.e. after a top level state function returns, not during).
+/// SDL key events are preprocessed, see app::Input.
+/// The quit event (typically window closed or signal received) is caught and
+/// results in immediate (that is, after the next input loop) termination.
+/// Popped states will be deleted via the plain delete operator on an app::State
+/// pointer.
+/// Timers created by GlobalTimers() operate on actual application time and are
+/// not paused when the current state is paused (as are the timers started by
+/// the app::State members).
 class Application {
 
 public:
-       Application(sdl::InitScreen *screen, State *initialState);
+       Application(sdl::InitScreen &screen, State *initialState);
        ~Application();
 private:
        Application(const Application &);
@@ -66,12 +71,13 @@ private:
        void Render();
 
 private:
-       sdl::InitScreen *screen;
+       sdl::InitScreen &screen;
        std::stack<State *> states;
        std::queue<StateCommand> stateChanges;
        Timers<Uint32> globalTimers;
        Input input;
        Uint32 last;
+       bool inStateChage;
 
 };