HeadUpDisplay.h

Go to the documentation of this file.

/*
 
HeadUpDisplay.h
 
Class handling the player ship’s heads-up display, and 2D drawing functions.
 
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 "OOOpenGL.h"
 
#import "OOTypes.h"
#import "OOMaths.h"
#import "MyOpenGLView.h"
#import "ShipEntity.h"
 
@class OOCrosshairs, OOColor;
 
@protocol OOHUDBeaconIcon;
 
 
#define SCANNER_CENTRE_X    0
#define SCANNER_CENTRE_Y    -180
#define SCANNER_SCALE       256
#define SCANNER_WIDTH       288
#define SCANNER_HEIGHT      72
 
#define SCANNER_MAX_ZOOM            5.0
#define SCANNER_ZOOM_LEVELS         5
#define ZOOM_INDICATOR_CENTRE_X     108
#define ZOOM_INDICATOR_CENTRE_Y     -216
#define ZOOM_INDICATOR_WIDTH        11.0f
#define ZOOM_INDICATOR_HEIGHT       14.0f
#define ZOOM_LEVELS_IMAGE           @"zoom.png"
 
#define COMPASS_IMAGE           @"compass.png"
#define COMPASS_CENTRE_X        132
#define COMPASS_CENTRE_Y        -216
#define COMPASS_SIZE            56
#define COMPASS_HALF_SIZE       28
#define COMPASS_REDDOT_IMAGE    @"reddot.png"
#define COMPASS_GREENDOT_IMAGE  @"greendot.png"
#define COMPASS_DOT_SIZE        16
#define COMPASS_HALF_DOT_SIZE   8
 
#define AEGIS_IMAGE             @"aegis.png"
#define AEGIS_CENTRE_X          -132
#define AEGIS_CENTRE_Y          -216
#define AEGIS_WIDTH             24
#define AEGIS_HEIGHT            24
 
#define SPEED_BAR_CENTRE_X      200
#define SPEED_BAR_CENTRE_Y      -145
#define SPEED_BAR_WIDTH         80
#define SPEED_BAR_HEIGHT        8
#define SPEED_BAR_DRAW_SURROUND YES
 
#define ROLL_BAR_CENTRE_X       200
#define ROLL_BAR_CENTRE_Y       -160
#define ROLL_BAR_WIDTH          80
#define ROLL_BAR_HEIGHT         8
#define ROLL_BAR_DRAW_SURROUND  YES
 
#define PITCH_BAR_CENTRE_X      200
#define PITCH_BAR_CENTRE_Y      -170
#define PITCH_BAR_WIDTH         80
#define PITCH_BAR_HEIGHT        8
#define PITCH_BAR_DRAW_SURROUND YES
 
#define ENERGY_GAUGE_CENTRE_X       200
#define ENERGY_GAUGE_CENTRE_Y       -205
#define ENERGY_GAUGE_WIDTH          80
#define ENERGY_GAUGE_HEIGHT         48
#define ENERGY_GAUGE_DRAW_SURROUND  YES
 
#define FORWARD_SHIELD_BAR_CENTRE_X         -200
#define FORWARD_SHIELD_BAR_CENTRE_Y         -146
#define FORWARD_SHIELD_BAR_WIDTH            80
#define FORWARD_SHIELD_BAR_HEIGHT           8
#define FORWARD_SHIELD_BAR_DRAW_SURROUND    YES
 
#define AFT_SHIELD_BAR_CENTRE_X         -200
#define AFT_SHIELD_BAR_CENTRE_Y         -162
#define AFT_SHIELD_BAR_WIDTH            80
#define AFT_SHIELD_BAR_HEIGHT           8
#define AFT_SHIELD_BAR_DRAW_SURROUND    YES
 
#define FUEL_BAR_CENTRE_X           -200
#define FUEL_BAR_CENTRE_Y           -179
#define FUEL_BAR_WIDTH              80
#define FUEL_BAR_HEIGHT             8
 
#define WITCHDEST_CENTRE_X          -200
#define WITCHDEST_CENTRE_Y          -179
#define WITCHDEST_WIDTH             80
#define WITCHDEST_HEIGHT                8
 
#define CABIN_TEMP_BAR_CENTRE_X     -200
#define CABIN_TEMP_BAR_CENTRE_Y     -189
#define CABIN_TEMP_BAR_WIDTH        80
#define CABIN_TEMP_BAR_HEIGHT       8
 
#define WEAPON_TEMP_BAR_CENTRE_X    -200
#define WEAPON_TEMP_BAR_CENTRE_Y    -199
#define WEAPON_TEMP_BAR_WIDTH       80
#define WEAPON_TEMP_BAR_HEIGHT      8
 
#define ALTITUDE_BAR_CENTRE_X       -200
#define ALTITUDE_BAR_CENTRE_Y       -209
#define ALTITUDE_BAR_WIDTH          80
#define ALTITUDE_BAR_HEIGHT         8
 
#define MISSILES_DISPLAY_X          -228
#define MISSILES_DISPLAY_Y          -224
#define MISSILES_DISPLAY_SPACING    16
#define MISSILE_ICON_WIDTH          12
#define MISSILE_ICON_HEIGHT         MISSILE_ICON_WIDTH
 
#define PRIMED_DISPLAY_X                -144
#define PRIMED_DISPLAY_Y                -256
#define PRIMED_DISPLAY_WIDTH            12
#define PRIMED_DISPLAY_HEIGHT       12
 
#define ASCTARGET_DISPLAY_X             64
#define ASCTARGET_DISPLAY_Y             -234
#define ASCTARGET_DISPLAY_WIDTH         10
#define ASCTARGET_DISPLAY_HEIGHT        10
 
#define CLOCK_DISPLAY_X             -44
#define CLOCK_DISPLAY_Y             -234
#define CLOCK_DISPLAY_WIDTH         12
#define CLOCK_DISPLAY_HEIGHT        12
 
#define WEAPONSOFFLINETEXT_DISPLAY_X    -175
#define WEAPONSOFFLINETEXT_DISPLAY_Y    2
#define WEAPONSOFFLINETEXT_WIDTH    8
#define WEAPONSOFFLINETEXT_HEIGHT   8
 
#define FPSINFO_DISPLAY_X           -300
#define FPSINFO_DISPLAY_Y           220
#define FPSINFO_DISPLAY_WIDTH       12
#define FPSINFO_DISPLAY_HEIGHT      12
 
#define STATUS_LIGHT_CENTRE_X       -108
#define STATUS_LIGHT_CENTRE_Y       -216
#define STATUS_LIGHT_WIDTH          8
#define STATUS_LIGHT_HEIGHT         8
 
#define HIT_INDICATOR_CENTRE_X      200
#define HIT_INDICATOR_CENTRE_Y      0
 
#define SCOOPSTATUS_CENTRE_X        -132
#define SCOOPSTATUS_CENTRE_Y        -152
#define SCOOPSTATUS_WIDTH           16.0
#define SCOOPSTATUS_HEIGHT          16.0
 
#define MFD_TEXT_WIDTH          10
#define MFD_TEXT_HEIGHT         10
 
#define DIALS_KEY               @"dials"
#define LEGENDS_KEY             @"legends"
#define MFDS_KEY                @"multi_function_displays"
#define X_KEY                   @"x"
#define Y_KEY                   @"y"
#define X_ORIGIN_KEY            @"x_origin"
#define Y_ORIGIN_KEY            @"y_origin"
#define SPACING_KEY             @"spacing"
#define ALPHA_KEY               @"alpha"
#define SELECTOR_KEY            @"selector"
#define IMAGE_KEY               @"image"
#define WIDTH_KEY               @"width"
#define HEIGHT_KEY              @"height"
#define SPRITE_KEY              @"sprite"
#define DRAW_SURROUND_KEY       @"draw_surround"
#define EQUIPMENT_REQUIRED_KEY  @"equipment_required"
#define ALERT_CONDITIONS_KEY    @"alert_conditions"
#define VIEWSCREEN_KEY          @"viewscreen_only"
#define DIAL_REQUIRED_KEY       @"with_dial"
#define LABELLED_KEY            @"labelled"
#define TEXT_KEY                @"text"
#define RGB_COLOR_KEY           @"rgb_color"
#define COLOR_KEY               @"color"
#define COLOR_KEY_LOW           @"color_low"
#define COLOR_KEY_MEDIUM        @"color_medium"
#define COLOR_KEY_HIGH          @"color_high"
#define COLOR_KEY_CRITICAL      @"color_critical"
#define COLOR_KEY_SURROUND      @"color_surround"
#define N_BARS_KEY              @"n_bars"
#define CUSTOM_DIAL_KEY         @"data_source"
 
#define ROWS_KEY                @"rows"
#define COLUMNS_KEY             @"columns"
#define ROW_HEIGHT_KEY          @"row_height"
#define ROW_START_KEY           @"row_start"
#define TITLE_KEY               @"title"
#define BACKGROUND_RGBA_KEY     @"background_rgba"
#define OVERALL_ALPHA_KEY       @"overall_alpha"
#define NONLINEAR_SCANNER       @"nonlinear_scanner"
 
#define Z1                      [(MyOpenGLView *)[[player universe] gameView] display_z]
 
#define ONE_EIGHTH              0.125
 
#define MAX_ACCURACY_RANGE          7000   // 7.000km
#define ACCURACY_PROBABILITY_DECREASE_FACTOR    0.000035f   // for every 1000km decrease by 3.5% the chance of high accuracy
#define MIN_PROBABILITY_ACCURACY        0.35f   // floor value for probability of high accuracy is 35%
 
enum
{
    OO_RETICLE_COLOR_TARGET  = 0,
    OO_RETICLE_COLOR_TARGET_SENSITIVE,
    OO_RETICLE_COLOR_WORMHOLE
};
 
 
@class Entity, PlayerEntity, OOTextureSprite;
 
 
@interface HeadUpDisplay: NSObject
{
@private
    NSMutableArray      *legendArray;
    NSMutableArray      *dialArray;
    NSMutableArray      *mfdArray;
    
    // zoom level
    GLfloat             scanner_zoom;
    
    //where to draw it
    GLfloat             z1;
    GLfloat             lineWidth;
    
    NSString            *hudName;
    NSString            *deferredHudName;    // Usually it will be nil. If not nil, then it means that we have a deferred HUD waiting to be drawn This may happen
                                            // for example when a script handler attempts to switch HUD while it is being rendered. - Nikos 20110628
    BOOL                hudUpdating;
    
    GLfloat             overallAlpha;
    
    BOOL                reticleTargetSensitive;   // TO DO: Move this into the propertiesReticleTargetSensitive structure (Getafix - 2010/08/21)
    NSMutableDictionary *propertiesReticleTargetSensitive;
    
    BOOL                cloakIndicatorOnStatusLight;
    
    BOOL                hudHidden;
    
    BOOL                allowBigGui;
 
    int                 last_transmitter;
 
    NSMutableSet        *_hiddenSelectors;
    
    // Crosshairs
    OOCrosshairs        *_crosshairs;
    OOWeaponType        _lastWeaponType;
    GLfloat             _lastOverallAlpha;
    BOOL                _lastWeaponsOnline;
    NSDictionary        *_crosshairOverrides;
    OOColor              *_crosshairColor;
    GLfloat             _crosshairScale;
    GLfloat             _crosshairWidth;
    NSString            *crosshairDefinition;
    BOOL                _compassActive;
    
    NSMutableArray      *_reticleColors;
    
    // essentially scanner without gridlines
    BOOL            minimalistic_scanner;
    
    // Nonlinear scanner
    BOOL            nonlinear_scanner;
    BOOL            scanner_ultra_zoom;
 
}
 
- (id) initWithDictionary:(NSDictionary *)hudinfo;
- (id) initWithDictionary:(NSDictionary *)hudinfo inFile:(NSString *)hudFileName;
 
- (void) resetGuis:(NSDictionary *)info;
- (void) resetGuiPositions;
 
- (NSString *) hudName;
- (void) setHudName:(NSString *)newHudName;
 
- (GLfloat) scannerZoom;
- (void) setScannerZoom:(GLfloat)value;
 
- (GLfloat) overallAlpha;
- (void) setOverallAlpha:(GLfloat)newAlphaValue;
 
- (BOOL) reticleTargetSensitive;
- (void) setReticleTargetSensitive:(BOOL)newReticleTargetSensitiveValue;
- (NSMutableDictionary *) propertiesReticleTargetSensitive;
 
- (BOOL) isHidden;
- (void) setHidden:(BOOL)newValue;
 
- (BOOL) allowBigGui;
 
- (BOOL) hasHidden:(NSString *)selectorName;
- (void) setHiddenSelector:(NSString *)selectorName hidden:(BOOL)hide;
- (void) clearHiddenSelectors;
 
- (BOOL) isCompassActive;
- (void) setCompassActive:(BOOL)newValue;
 
- (BOOL) isUpdating;
- (void) setDeferredHudName:(NSString *)newDeferredHudName;
- (NSString *) deferredHudName;
- (NSString *) crosshairDefinition;
- (BOOL) setCrosshairDefinition:(NSString *)newDefinition;
 
- (void) addLegend:(NSDictionary *)info;
- (void) addDial:(NSDictionary *)info;
- (void) addMFD:(NSDictionary *)info;
 
- (NSUInteger) mfdCount;
 
- (void) renderHUD;
 
- (void) refreshLastTransmitter;
 
- (void) setLineWidth:(GLfloat)value;
- (GLfloat) lineWidth;
 
- (BOOL) minimalisticScanner;
- (void) setMinimalisticScanner: (BOOL) newValue;
 
+ (Vector) nonlinearScannerScale:(Vector) V Zoom:(GLfloat) zoom Scale:(double) scale;
- (BOOL) nonlinearScanner;
- (void) setNonlinearScanner: (BOOL)newValue;
 
- (BOOL) scannerUltraZoom;
- (void) setScannerUltraZoom: (BOOL)newValue;
 
- (OOColor *) reticleColorForIndex:(NSUInteger)idx;
- (BOOL) setReticleColorForIndex:(NSUInteger)idx toColor:(OOColor *)newColor;
 
@end
 
 
@interface NSString (OODisplayEncoding)
 
// Return a C string in the 8-bit encoding used for display.
- (const char *) cStringUsingOoliteEncoding;
 
// Return a C string in the 8-bit encoding used for display, with substitutions performed.
- (const char *) cStringUsingOoliteEncodingAndRemapping;
 
@end
 
 
/*
    Protocol for things that can be used as HUD compass items. Really ought
    to grow into a general protocol for HUD elements.
*/
@protocol OOHUDBeaconIcon <NSObject>
 
- (void) oo_drawHUDBeaconIconAt:(NSPoint)where size:(NSSize)size alpha:(GLfloat)alpha z:(GLfloat)z;
 
@end
 
 
@interface NSString (OOHUDBeaconIcon) <OOHUDBeaconIcon>
@end
 
 
void OODrawString(NSString *text, GLfloat x, GLfloat y, GLfloat z, NSSize siz);
void OODrawStringAligned(NSString *text, GLfloat x, GLfloat y, GLfloat z, NSSize siz, BOOL rightAlign);
 
/* OODrawString(Aligned) handles all the string drawing, but because
 * it does texture application and GL_QUADS beginning once per string
 * it's quite slow.
 *
 * Where efficiency is needed, call OOStartDrawingStrings(), then
 * OODrawStringQuadsAligned for each bit of text, then
 * OOStopDrawingStrings().
 *
 * Trying to draw anything else between OOStartDrawingStrings() and
 * OOStopDrawingStrings() will have messy results. You can safely call
 * Stop, draw the other thing you want, then call Start again - it's
 * just a little inefficient. Similarly calling
 * OODrawStringQuadsAligned() without calling OOStartDrawingStrings()
 * won't work very well.
 *
 * - CIM
 */
void OOStartDrawingStrings(void);
void OODrawStringQuadsAligned(NSString *text, GLfloat x, GLfloat y, GLfloat z, NSSize siz, BOOL rightAlign);
void OOStopDrawingStrings(void);
 
 
 
void OODrawHilightedString(NSString *text, GLfloat x, GLfloat y, GLfloat z, NSSize siz);
void OODrawPlanetInfo(int gov, int eco, int tec, GLfloat x, GLfloat y, GLfloat z, NSSize siz);
void OODrawHilightedPlanetInfo(int gov, int eco, int tec, GLfloat x, GLfloat y, GLfloat z, NSSize siz);
NSRect OORectFromString(NSString *text, GLfloat x, GLfloat y, NSSize siz);
CGFloat OOStringWidthInEm(NSString *text);
 
void OOHUDResetTextEngine(void);