GameController.h

Go to the documentation of this file.

/*
 
GameController.h
 
Main application controller class.
 
Oolite
Copyright (C) 2004-2013 Giles C Williams and contributors
 
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.
 
*/
 
 
#import "OOCocoa.h"
#import "OOFunctionAttributes.h"
#import "OOFullScreenController.h"
#import "OOMouseInteractionMode.h"
 
 
#if OOLITE_MAC_OS_X
#import <Quartz/Quartz.h>   // For PDFKit.
#endif
 
#define MINIMUM_GAME_TICK       0.25
// * reduced from 0.5s for tgape * //
 
#define MINIMUM_ANIMATION_TICK  0.0041667
// 1.0 / (desired framerate cap)
 
 
@class MyOpenGLView, OOFullScreenController;
 
 
// TEMP: whether to use separate OOFullScreenController object, will hopefully be used for all builds soon.
#define OO_USE_FULLSCREEN_CONTROLLER    OOLITE_MAC_OS_X
 
 
@interface GameController: NSObject
{
@private
#if OOLITE_MAC_OS_X
    IBOutlet NSTextField    *splashProgressTextField;
    IBOutlet NSView         *splashView;
    IBOutlet NSWindow       *gameWindow;
    IBOutlet PDFView        *helpView;
    IBOutlet NSMenu         *dockMenu;
#endif
    
    IBOutlet MyOpenGLView   *gameView;
    
    NSTimeInterval          last_timeInterval;
    double                  delta_t;
    
    int                     my_mouse_x, my_mouse_y;
 
    NSString                *playerFileDirectory;
    NSString                *playerFileToLoad;
    NSMutableArray          *expansionPathsToInclude;
    
    NSTimer                 *timer;
    NSTimeInterval          _animationTimerInterval;
    
    NSDate                  *_splashStart;
    
    SEL                     pauseSelector;
    NSObject                *pauseTarget;
    
    BOOL                    gameIsPaused;
    
    OOMouseInteractionMode  _mouseMode;
    OOMouseInteractionMode  _resumeMode;
    
// Fullscreen mode stuff.
#if OO_USE_FULLSCREEN_CONTROLLER
    OOFullScreenController  *_fullScreenController;
#elif OOLITE_SDL
    NSRect                  fsGeometry;
    MyOpenGLView            *switchView;
    
    NSMutableArray          *displayModes;
    
    unsigned int            width, height;
    unsigned int            refresh;
    BOOL                    fullscreen;
    NSDictionary            *originalDisplayMode;
    NSDictionary            *fullscreenDisplayMode;
    
    BOOL                    stayInFullScreenMode;
    BOOL                    _finishedLaunching;
#endif
}
 
+ (GameController *) sharedController;
 
- (void) applicationDidFinishLaunching:(NSNotification *)notification;
- (BOOL) finishedLaunching;
 
- (BOOL) isGamePaused;
- (void) setGamePaused:(BOOL)value;
 
/*
  Eco Quality of Service currently implemented only on Windows.
  It sets the game to low power consumption mode when it loses
  focus or is paused. When EcoQoS is active:
  - Windows schedules the appliation on more efficient CPU cores
  - The CPU is kept at a more efficient clock frequency
  
  On non-Windows platforms it is a no-op.
*/
- (void) setEcoQoS: (BOOL)efficiencyModeRequested;
 
- (OOMouseInteractionMode) mouseInteractionMode;
- (void) setMouseInteractionMode:(OOMouseInteractionMode)mode;
- (void) setMouseInteractionModeForFlight;  // Chooses mouse control mode appropriately.
- (void) setMouseInteractionModeForUIWithMouseInteraction:(BOOL)interaction;
 
- (void) performGameTick:(id)sender;
 
#if OOLITE_MAC_OS_X
- (IBAction) showLogAction:(id)sender;
- (IBAction) showLogFolderAction:(id)sender;
- (IBAction) showSnapshotsAction:(id)sender;
- (IBAction) showAddOnsAction:(id)sender;
- (void) recenterVirtualJoystick;
#endif
 
- (void) exitAppWithContext:(NSString *)context;
- (void) exitAppCommandQ;
 
- (NSString *) playerFileToLoad;
- (void) setPlayerFileToLoad:(NSString *)filename;
 
- (NSString *) playerFileDirectory;
- (void) setPlayerFileDirectory:(NSString *)filename;
 
- (void) loadPlayerIfRequired;
 
- (void) beginSplashScreen;
- (void) logProgress:(NSString *)message;
#if OO_DEBUG
- (void) debugLogProgress:(NSString *)format, ...  OO_TAKES_FORMAT_STRING(1, 2);
- (void) debugLogProgress:(NSString *)format arguments:(va_list)arguments  OO_TAKES_FORMAT_STRING(1, 0);
- (void) debugPushProgressMessage:(NSString *)format, ...  OO_TAKES_FORMAT_STRING(1, 2);
- (void) debugPopProgressMessage;
#endif
- (void) endSplashScreen;
 
- (void) startAnimationTimer;
- (void) stopAnimationTimer;
 
- (MyOpenGLView *) gameView;
- (void) setGameView:(MyOpenGLView *)view;
 
- (void)windowDidResize:(NSNotification *)aNotification;
 
- (void)setUpBasicOpenGLStateWithSize:(NSSize)viewSize;
 
- (NSURL *) snapshotsURLCreatingIfNeeded:(BOOL)create;
 
@end
 
 
@interface GameController (FullScreen)
 
#if OO_USE_FULLSCREEN_CONTROLLER
#if OOLITE_MAC_OS_X
- (IBAction) toggleFullScreenAction:(id)sender;
#endif
 
- (void) setFullScreenMode:(BOOL)value;
#endif
 
- (void) exitFullScreenMode;    // FIXME: should be setFullScreenMode:NO
- (BOOL) inFullScreenMode;
 
- (BOOL) setDisplayWidth:(unsigned int) d_width Height:(unsigned int)d_height Refresh:(unsigned int) d_refresh;
- (NSDictionary *) findDisplayModeForWidth:(unsigned int)d_width Height:(unsigned int) d_height Refresh:(unsigned int) d_refresh;
- (NSArray *) displayModes;
- (NSUInteger) indexOfCurrentDisplayMode;
 
- (void) pauseFullScreenModeToPerform:(SEL) selector onTarget:(id) target;
 
 
// Internal use only.
- (void) setUpDisplayModes;
 
@end
 
 
#if OO_DEBUG
#define OO_DEBUG_PROGRESS(...)      [[GameController sharedController] debugLogProgress:__VA_ARGS__]
#define OO_DEBUG_PUSH_PROGRESS(...) [[GameController sharedController] debugPushProgressMessage:__VA_ARGS__]
#define OO_DEBUG_POP_PROGRESS()     [[GameController sharedController] debugPopProgressMessage]
#else
#define OO_DEBUG_PROGRESS(...)      do {} while (0)
#define OO_DEBUG_PUSH_PROGRESS(...) do {} while (0)
#define OO_DEBUG_POP_PROGRESS()     do {} while (0)
#endif