GuiDisplayGen.h

Go to the documentation of this file.

/*
 
GuiDisplayGen.h
 
Class handling interface elements, primarily text, that are not part of the 3D
game world, together with GuiDisplayGen.
 
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 "OOMaths.h"
#import "OOTypes.h"
#include <jsapi.h>
 
 
#define GUI_DEFAULT_COLUMNS         6
#define GUI_DEFAULT_ROWS            30
 
#define GUI_MAX_ROWS                64
#define GUI_MAX_COLUMNS             40
#define MAIN_GUI_PIXEL_HEIGHT       480
#define MAIN_GUI_PIXEL_WIDTH        480
#define MAIN_GUI_ROW_HEIGHT         16
#define MAIN_GUI_ROW_WIDTH          16
#define MAIN_GUI_PIXEL_ROW_START    40
 
 
typedef enum
{
    GUI_ALIGN_LEFT,
    GUI_ALIGN_RIGHT,
    GUI_ALIGN_CENTER
} OOGUIAlignment;
 
typedef enum
{
    GUI_BACKGROUND_SPECIAL_NONE,
    GUI_BACKGROUND_SPECIAL_CUSTOM,
    GUI_BACKGROUND_SPECIAL_CUSTOM_ANA_SHORTEST,
    GUI_BACKGROUND_SPECIAL_CUSTOM_ANA_QUICKEST,
    GUI_BACKGROUND_SPECIAL_SHORT,
    GUI_BACKGROUND_SPECIAL_SHORT_ANA_SHORTEST,
    GUI_BACKGROUND_SPECIAL_SHORT_ANA_QUICKEST,
    GUI_BACKGROUND_SPECIAL_LONG,
    GUI_BACKGROUND_SPECIAL_LONG_ANA_SHORTEST,
    GUI_BACKGROUND_SPECIAL_LONG_ANA_QUICKEST
} OOGUIBackgroundSpecial;
 
#define GUI_KEY_OK              @"OK"
#define GUI_KEY_SKIP            @"SKIP-ROW"
 
// globals
static NSString * const kGuiDefaultTextColor        = @"default_text_color";
static NSString * const kGuiScreenTitleColor        = @"screen_title_color";
static NSString * const kGuiScreenDividerColor      = @"screen_divider_color";
static NSString * const kGuiSelectedRowBackgroundColor  = @"selected_row_background_color";
static NSString * const kGuiSelectedRowColor        = @"selected_row_color";
static NSString * const kGuiTextInputCursorColor    = @"text_input_cursor_color";
// F3
static NSString * const kGuiEquipmentCashColor      = @"equipment_cash_color";
static NSString * const kGuiEquipmentUnavailableColor   = @"equipment_unavailable_color";
static NSString * const kGuiEquipmentScrollColor    = @"equipment_scroll_color";
static NSString * const kGuiEquipmentOptionColor    = @"equipment_option_color";
static NSString * const kGuiEquipmentRepairColor    = @"equipment_repair_color";
static NSString * const kGuiEquipmentDescriptionColor   = @"equipment_description_color";
static NSString * const kGuiEquipmentLaserColor     = @"equipment_laser_color";
static NSString * const kGuiEquipmentLaserFittedColor   = @"equipment_laser_fitted_color";
static NSString * const kGuiEquipmentTabs           = @"equipment_tabs";
// F3 F3
static NSString * const kGuiShipyardHeadingColor    = @"shipyard_heading_color";
static NSString * const kGuiShipyardScrollColor     = @"shipyard_scroll_color";
static NSString * const kGuiShipyardEntryColor      = @"shipyard_entry_color";
static NSString * const kGuiShipyardNoshipColor     = @"shipyard_noship_color";
static NSString * const kGuiShipyardTradeinColor    = @"shipyard_tradein_color";
static NSString * const kGuiShipyardDescriptionColor    = @"shipyard_description_color";
static NSString * const kGuiShipyardTabs            = @"shipyard_tabs";
// F4
static NSString * const kGuiInterfaceHeadingColor   = @"interface_heading_color";
static NSString * const kGuiInterfaceScrollColor    = @"interface_scroll_color";
static NSString * const kGuiInterfaceEntryColor     = @"interface_entry_color";
static NSString * const kGuiInterfaceDescriptionColor   = @"interface_description_color";
static NSString * const kGuiInterfaceNoneColor      = @"interface_none_color";
static NSString * const kGuiInterfaceTabs           = @"interface_tabs";
// F5
static NSString * const kGuiStatusShipnameColor     = @"status_shipname_color";
static NSString * const kGuiStatusDataColor         = @"status_data_color";
static NSString * const kGuiStatusEquipmentHeadingColor = @"status_equipment_heading_color";
static NSString * const kGuiStatusEquipmentScrollColor  = @"status_equipment_scroll_color";
static NSString * const kGuiStatusEquipmentOkColor  = @"status_equipment_ok_color";
static NSString * const kGuiStatusEquipmentDamagedColor = @"status_equipment_damaged_color";
static NSString * const kGuiStatusTabs              = @"status_tabs";
static NSString * const kGuiStatusPrioritiseDamaged = @"status_prioritise_damaged";
// F5 F5
static NSString * const kGuiManifestSubheadColor    = @"manifest_subhead_color";
static NSString * const kGuiManifestEntryColor      = @"manifest_entry_color";
static NSString * const kGuiManifestScrollColor     = @"manifest_scroll_color";
static NSString * const kGuiManifestNoScrollColor   = @"manifest_no_scroll_color";
static NSString * const kGuiManifestTabs            = @"manifest_tabs";
// F6
static NSString * const kGuiChartLabelScale         = @"chart_label_scale";
static NSString * const kGuiChartCircleScale        = @"chart_circle_scale";
static NSString * const kGuiChartLabelColor         = @"chart_label_color";
static NSString * const kGuiChartLabelReachableColor    = @"chart_labelreachable_color";
static NSString * const kGuiChartRangeColor         = @"chart_range_color";
static NSString * const kGuiChartCrosshairColor     = @"chart_crosshair_color";
static NSString * const kGuiChartCursorColor        = @"chart_cursor_color";
static NSString * const kGuiChartInfoMarkerColor    = @"chart_info_marker_color";
static NSString * const kGuiChartMatchBoxColor      = @"chart_match_box_color";
static NSString * const kGuiChartMatchLabelColor    = @"chart_match_label_color";
static NSString * const kGuiChartConnectionColor    = @"chart_connection_color";
static NSString * const kGuiChartCurrentJumpStartColor  = @"chart_currentjumpstart_color";
static NSString * const kGuiChartCurrentJumpEndColor    = @"chart_currentjumpend_color";
static NSString * const kGuiChartRouteShortColor    = @"chart_route_short_color";
static NSString * const kGuiChartRouteQuickColor    = @"chart_route_quick_color";
static NSString * const kGuiChartTraveltimeTabs     = @"chart_traveltime_tabs";
 
static NSString * const kGuiChartEconomyUColor      = @"chart_economy_%lu_color";
static NSString * const kGuiChartGovernmentUColor   = @"chart_government_%lu_color";
static NSString * const kGuiChartTechColor          = @"chart_tech_color";
// F7
static NSString * const kGuiSystemdataFactsColor        = @"systemdata_facts_color";
static NSString * const kGuiSystemdataDescriptionColor  = @"systemdata_description_color";
static NSString * const kGuiSystemdataTabs          = @"systemdata_tabs";
// F8
static NSString * const kGuiMarketHeadingColor      = @"market_heading_color";
static NSString * const kGuiMarketCommodityColor    = @"market_commodity_color";
static NSString * const kGuiMarketScrollColor       = @"market_scroll_color";
static NSString * const kGuiMarketFilteredAllColor  = @"market_filtered_all_color";
static NSString * const kGuiMarketFilterInfoColor   = @"market_filter_info_color";
static NSString * const kGuiMarketCashColor         = @"market_cash_color";
// F8 F8 extras
static NSString * const kGuiMarketContractedColor   = @"market_contracted_color";
static NSString * const kGuiMarketDescriptionColor  = @"market_description_color";
static NSString * const kGuiMarketTabs              = @"market_tabs";
// Docking report
static NSString * const kGuiDockingReportColor      = @"docking_report_color";
static NSString * const kGuiDockingSummaryColor     = @"docking_summary_color";
static NSString * const kGuiDockingContinueColor    = @"docking_continue_color";
 
 
 
@class OOSound, OOColor, OOTexture, OOTextureSprite, HeadUpDisplay;
 
 
typedef NSInteger OOGUIRow; // -1 for none
typedef NSInteger OOGUITabStop; // negative value = right align text
typedef OOGUITabStop OOGUITabSettings[GUI_MAX_COLUMNS];
 
 
@interface GuiDisplayGen: NSObject
{
@private
    NSSize                  size_in_pixels;
    unsigned                n_columns;
    unsigned                n_rows;
    int                     pixel_row_center;
    unsigned                pixel_row_height;
    int                     pixel_row_start;
    NSSize                  pixel_text_size;
    
    BOOL                    showAdvancedNavArray;
    
    NSSize                  pixel_title_size;
    
    OOColor                 *backgroundColor;
    OOColor                 *textColor;
    OOColor                 *textCommsColor;
    
    OOTextureSprite         *backgroundSprite;
    OOTextureSprite         *foregroundSprite;
    OOGUIBackgroundSpecial  backgroundSpecial;  
    
    NSString                *title;
    
    NSMutableArray          *rowText;
    NSMutableArray          *rowKey;
    NSMutableArray          *rowColor;
    
    Vector                  drawPosition;
    
    NSPoint                 rowPosition[GUI_MAX_ROWS];
    OOGUIAlignment          rowAlignment[GUI_MAX_ROWS];
    float                   rowFadeTime[GUI_MAX_ROWS];
    
    OOGUITabSettings        tabStops;
    
    NSDictionary            *guiUserSettings;
 
    NSRange                 rowRange;
    
    OOGUIRow                selectedRow;
    NSRange                 selectableRange;
    
    BOOL                    showTextCursor;
    OOGUIRow                currentRow;
    
    GLfloat                 max_alpha;          // main alpha setting
    GLfloat                 fade_alpha;         // for fade-in / fade-out
    GLfloat                 fade_sign;          //  -1.0 to 1.0
    NSUInteger              statusPage;         // status  screen: paging equipped items
    OOSystemID              foundSystem;
}
 
- (id) init;
- (id) initWithPixelSize:(NSSize)gui_size
                 columns:(int)gui_cols 
                    rows:(int)gui_rows 
               rowHeight:(int)gui_row_height
                rowStart:(int)gui_row_start
                   title:(NSString*)gui_title;
 
- (void) resizeWithPixelSize:(NSSize)gui_size
                     columns:(int)gui_cols
                        rows:(int)gui_rows
                   rowHeight:(int)gui_row_height
                    rowStart:(int)gui_row_start
                       title:(NSString*) gui_title;
- (void) resizeTo:(NSSize)gui_size
  characterHeight:(int)csize
            title:(NSString*)gui_title;
- (NSSize)size;
- (unsigned)columns;
- (unsigned)rows;
- (unsigned)rowHeight;
- (int)rowStart;
 
- (NSString *)title;
- (void) setTitle:(NSString *)str;
 
- (void) dealloc;
 
- (void) setDrawPosition:(Vector) vector;
- (Vector) drawPosition;
 
- (NSDictionary *) userSettings;
 
- (void) fadeOutFromTime:(OOTimeAbsolute) now_time overDuration:(OOTimeDelta) duration;
- (void) stopFadeOuts;
 
- (GLfloat) alpha;
- (void) setAlpha:(GLfloat) an_alpha;
- (void) setMaxAlpha:(GLfloat) an_alpha;
 
- (void) setBackgroundColor:(OOColor*) color;
 
- (OOColor *) textColor;
- (void) setTextColor:(OOColor*) color;
- (OOColor *) textCommsColor;
- (void) setTextCommsColor:(OOColor*) color;
- (OOColor *) colorFromSetting:(NSString *)setting defaultValue:(OOColor *)def;
- (void) setGLColorFromSetting:(NSString *)setting defaultValue:(OOColor *)def alpha:(GLfloat)alpha;
- (void) setGuiColorSettingFromKey:(NSString *) key color:(OOColor *)col;
 
- (void) setCharacterSize:(NSSize) character_size;
 
- (void) setShowAdvancedNavArray:(BOOL)inFlag;
 
- (void) setColor:(OOColor *)color forRow:(OOGUIRow)row;
 
- (id) objectForRow:(OOGUIRow)row;
- (NSString *) keyForRow:(OOGUIRow)row;
- (OOGUIRow) rowForKey:(NSString*)key;
- (OOGUIRow) selectedRow;
- (BOOL) setSelectedRow:(OOGUIRow)row;
- (BOOL) setNextRow:(int) direction;
- (BOOL) setFirstSelectableRow;
- (BOOL) setLastSelectableRow;
- (void) setNoSelectedRow;
- (NSString *) selectedRowText;
- (NSString *) selectedRowKey;
 
- (void) setShowTextCursor:(BOOL) yesno;
- (void) setCurrentRow:(OOGUIRow) value;
 
- (NSRange) selectableRange;
- (void) setSelectableRange:(NSRange) range;
 
- (void) setTabStops:(OOGUITabSettings)stops;
- (void) overrideTabs:(OOGUITabSettings)stops from:(NSString *)setting length:(NSUInteger)len;
 
 
- (void) clear;
- (void) clearAndKeepBackground:(BOOL)keepBackground;
 
- (void) setKey:(NSString *)str forRow:(OOGUIRow)row;
- (void) setText:(NSString *)str forRow:(OOGUIRow)row;
- (void) setText:(NSString *)str forRow:(OOGUIRow)row align:(OOGUIAlignment)alignment;
- (NSString *) reflowTextForMFD:(NSString *)input;
- (OOGUIRow) addLongText:(NSString *)str
           startingAtRow:(OOGUIRow)row
                   align:(OOGUIAlignment)alignment;
- (void) printLongText:(NSString *)str
                 align:(OOGUIAlignment)alignment
                 color:(OOColor *)text_color
              fadeTime:(float)text_fade
                   key:(NSString *)text_key
            addToArray:(NSMutableArray *)text_array;
- (void) printLineNoScroll:(NSString *)str
                     align:(OOGUIAlignment)alignment
                     color:(OOColor *)text_color
                  fadeTime:(float)text_fade
                       key:(NSString *)text_key
                addToArray:(NSMutableArray *)text_array;
 
- (void) setArray:(NSArray *)arr forRow:(OOGUIRow)row;
 
- (void) insertItemsFromArray:(NSArray *)items
                     withKeys:(NSArray *)item_keys
                      intoRow:(OOGUIRow)row
                        color:(OOColor *)text_color;
 
 
- (void) scrollUp:(int) how_much;
 
/* allows the use of special dynamic backgrounds */
- (void) setBackgroundTextureSpecial:(OOGUIBackgroundSpecial)spec withBackground:(BOOL)withBackground;
 
/*
    A background/foreground texture descriptor is a dictionary with a string
    property keyed "name" and optional number properties keyed "width" and
    "height".
*/
 
- (BOOL) setBackgroundTextureDescriptor:(NSDictionary *)descriptor;
- (BOOL) setForegroundTextureDescriptor:(NSDictionary *)descriptor;
- (BOOL) setBackgroundTextureKey:(NSString *)key;
- (BOOL) setForegroundTextureKey:(NSString *)key;
 
- (BOOL) preloadGUITexture:(NSDictionary *)descriptor;
 
/*
    Interpret a JavaScript value as a texture descriptor for
    -[GUIDisplayGen set{Background|Foreground}TextureDescriptor:]. Also starts
    preloading the texture.
    
    callerDescription is a string describing the context in which this was
    called, generally a method name (like "mission.runScreen()") for warning
    generation.
    
    Requires a request on context.
*/
- (NSDictionary *) textureDescriptorFromJSValue:(jsval)value inContext:(JSContext *)context callerDescription:(NSString *)callerDescription;
 
- (void) clearBackground;
 
- (void) leaveLastLine;
- (NSArray *) getLastLines;
 
- (int) drawGUI:(GLfloat) alpha drawCursor:(BOOL) drawCursor;
- (void) drawGUIBackground;
- (void) setStatusPage:(NSInteger) pageNum;
- (NSUInteger) statusPage;
- (void) refreshStarChart;
- (void) setStarChartTitle;
 
- (OOSystemID) targetNextFoundSystem:(int)direction;
 
@end