oolite/Universe.h

//
//  Universe.h
/*
 *
 *  Oolite
 *
 *  Created by Giles Williams on Sat Apr 03 2004.
 *  Copyright (c) 2004 for aegidian.org. All rights reserved.
 *

Copyright (c) 2004, Giles C Williams
All rights reserved.

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/2.0/
or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

You are free:

•	to copy, distribute, display, and perform the work
•	to make derivative works

Under the following conditions:

•	Attribution. You must give the original author credit.

•	Noncommercial. You may not use this work for commercial purposes.

•	Share Alike. If you alter, transform, or build upon this work,
you may distribute the resulting work only under a license identical to this one.

For any reuse or distribution, you must make clear to others the license terms of this work.

Any of these conditions can be waived if you get permission from the copyright holder.

Your fair use and other rights are in no way affected by the above.

*/

#define SCANNER_CENTRE_X	0
#define SCANNER_CENTRE_Y	-180
#define SCANNER_SCALE		256

#define SCANNER_MAX_ZOOM			5.0
#define SCANNER_ZOOM_LEVELS			5
#define ZOOM_INDICATOR_CENTRE_X		108
#define ZOOM_INDICATOR_CENTRE_Y		-216

#define COMPASS_IMAGE			@"compass.png"
#define COMPASS_CENTRE_X		132
#define COMPASS_CENTRE_Y		-216
#define COMPASS_SIZE			64
#define COMPASS_HALF_SIZE		32
#define COMPASS_REDDOT_IMAGE	@"reddot.png"
#define COMPASS_GREENDOT_IMAGE  @"greendot.png"
#define COMPASS_DOT_SIZE		16
#define COMPASS_HALF_DOT_SIZE	8

#define TEXT_MESSAGE_Y			-144

#define AEGIS_CENTRE_X		-132
#define AEGIS_CENTRE_Y		-216

#define SCANNER_IMAGE			@"scanner.png"
#define SCANNER_IMAGE_WIDTH		512
#define SCANNER_IMAGE_HEIGHT	128

#define CROSSHAIR_IMAGE			@"crosshair.png"
#define CROSSHAIR_IMAGE_WIDTH   64
#define CROSSHAIR_IMAGE_HEIGHT	64
#define CROSSHAIR_SIZE			32.0

#define VIEW_FORWARD			0
#define VIEW_AFT				1
#define VIEW_PORT				2
#define VIEW_STARBOARD			3
#define VIEW_NONE				-1
#define VIEW_DOCKED				100
#define VIEW_BREAK_PATTERN		200

#define UNITS_TONS			0
#define UNITS_KILOGRAMS		1
#define UNITS_GRAMS			2

#define DEMO_NO_DEMO		0
#define DEMO_FLY_IN			101
#define DEMO_SHOW_THING		102
#define DEMO_FLY_OUT		103

#define MARKET_NAME					0
#define MARKET_QUANTITY				1
#define MARKET_PRICE				2
#define MARKET_BASE_PRICE			3
#define MARKET_ECO_ADJUST_PRICE		4
#define MARKET_ECO_ADJUST_QUANTITY  5
#define MARKET_BASE_QUANTITY		6
#define MARKET_MASK_PRICE			7
#define MARKET_MASK_QUANTITY		8
#define MARKET_UNITS				9

#define EQUIPMENT_TECH_LEVEL_INDEX  0
#define EQUIPMENT_PRICE_INDEX		1
#define EQUIPMENT_SHORT_DESC_INDEX  2
#define EQUIPMENT_KEY_INDEX			3
#define EQUIPMENT_LONG_DESC_INDEX   4

#define MAX_MESSAGES		5

#define PROXIMITY_WARN_DISTANCE2	36.0
#define PROXIMITY_AVOID_DISTANCE	10.0

#define SUN_SKIM_RADIUS_FACTOR		1.15470053838
#define SUN_SPARKS_RADIUS_FACTOR	2.0

#define KEY_TECHLEVEL				@"techlevel"
#define KEY_ECONOMY					@"economy"
#define KEY_GOVERNMENT				@"government"
#define KEY_POPULATION				@"population"
#define KEY_PRODUCTIVITY			@"productivity"
#define KEY_RADIUS					@"radius"
#define KEY_NAME					@"name"
#define KEY_INHABITANTS				@"inhabitants"
#define KEY_DESCRIPTION				@"description"
#define KEY_SHORT_DESCRIPTION		@"short_description"

#define KEY_CHANCE					@"chance"
#define KEY_PRICE					@"price"
#define KEY_OPTIONAL_EQUIPMENT		@"optional_equipment"
#define KEY_STANDARD_EQUIPMENT		@"standard_equipment"
#define KEY_EQUIPMENT_MISSILES			@"missiles"
#define KEY_EQUIPMENT_FORWARD_WEAPON	@"forward_weapon_type"
#define KEY_EQUIPMENT_EXTRAS			@"extras"
#define KEY_WEAPON_FACINGS			@"weapon_facings"

#define KEY_SCRIPT_ACTIONS			@"script_actions"
	// used by cargo-containers with CARGO_SCRIPT_ACTION when you scoop them, used by Stations when you dock with them, used during custom system set up too
#define KEY_LAUNCH_ACTIONS			@"launch_actions"
#define KEY_DEATH_ACTIONS			@"death_actions"
#define KEY_SETUP_ACTIONS			@"setup_actions"

#define SHIPYARD_KEY_ID				@"id"
#define SHIPYARD_KEY_SHIPDATA_KEY	@"shipdata_key"
#define SHIPYARD_KEY_SHIP			@"ship"
#define SHIPYARD_KEY_PRICE			@"price"
#define SHIPYARD_KEY_DESCRIPTION	@"description"

#define PLANETINFO_UNIVERSAL_KEY	@"universal"

#define MAX_ENTITY_UID				1000

#define	NUMBER_OF_STRICT_EQUIPMENT_ITEMS	16

//#import <OpenGL/glu.h>
#ifdef LINUX
#include "oolite-linux.h"
#else
#import <OpenGL/gl.h>
#endif

#ifdef GNUSTEP
#import <Foundation/Foundation.h>
#import <AppKit/AppKit.h>
#else
#import <Cocoa/Cocoa.h>
#endif

#import "entities.h"
#import "GuiDisplayGen.h"

@class TextureStore, OpenGLSprite, GameController, ShipEntity;

extern int debug;

@interface Universe : NSObject
{
		NSView			*gameView;
        TextureStore	*textureStore;
        
#ifndef GNUSTEP        
		SpeechChannel		speechChannel;
		//Jester Speech Begin
		NSArray				*speechArray;
		//Jester Speech End
#endif

//		NSMutableDictionary *universal_id_dictionary;
		int					next_universal_id;
		Entity*				entity_for_uid[MAX_ENTITY_UID];
		
		NSLock				*recycleLock;
		NSMutableDictionary *entityRecyclePool;

		NSMutableDictionary *preloadedDataFiles;

		NSMutableArray	*entities;
        NSMutableArray	*entsInDrawOrder;
				
		int				station;
		int				sun;
		int				planet;
		
		int				firstBeacon, lastBeacon;
		
		GLfloat			sky_clear_color[4];
		
//        double			messageDisplayDuration;
//        double			fpsDisplayDuration;
        NSString		*currentMessage;
//		OpenGLSprite	*messageSprite;
//		OpenGLSprite	*msSpriteArray[MAX_MESSAGES];
//		double			msDuration[MAX_MESSAGES];
		
		GuiDisplayGen*	gui;
		GuiDisplayGen*	message_gui;
		GuiDisplayGen*	comm_log_gui;
		
		OpenGLSprite	*textDisplaySprite;
		BOOL			displayGUI;
		BOOL			displayCursor;
		
		BOOL			reducedDetail;
        
		BOOL			displayFPS;		
        OpenGLSprite	*cursorSprite;
		
		
		int				viewDirection;
		
		double			universal_time;
		double			time_delta;
		double			ai_think_time;
		
		double			demo_stage_time;
		int				demo_stage;
		int				demo_ship_index;
		NSArray			*demo_ships;
		
		GLfloat			sun_center_position[4];
		
		BOOL			dumpCollisionInfo;
		
		NSDictionary	*shipdata;			// holds data on all ships available, loaded at initialisation
		NSDictionary	*shipyard;			// holds data on all ships for sale, loaded at initialisation
		
		NSDictionary	*commoditylists;	// holds data on commodities for various types of station, loaded at initialisation
		NSArray			*commoditydata;		// holds data on commodities extracted from commoditylists
		
		NSDictionary	*illegal_goods;		// holds the legal penalty for illicit commodities, loaded at initialisation
		NSDictionary	*descriptions;		// holds descriptive text for lots of stuff, loaded at initialisation
		NSDictionary	*planetinfo;		// holds overrides for individual planets, keyed by "g# p#" where g# is the galaxy number 0..7 and p# the planet number 0..255
		NSDictionary	*missiontext;		// holds descriptive text for missions, loaded at initialisation
		NSArray			*equipmentdata;		// holds data on available equipment, loaded at initialisation
		
		Random_Seed		galaxy_seed;
		Random_Seed		system_seed;
		Random_Seed		target_system_seed;
		
		Random_Seed		systems[256];		// hold pregenerated universe info
		NSString*		system_names[256];		// hold pregenerated universe info
		BOOL			system_found[256];		// holds matches for input strings
		
		int				breakPatternCounter;
		
		ShipEntity		*demo_ship;
		
		StationEntity*	cachedStation;
		PlanetEntity*	cachedPlanet;
		PlanetEntity*	cachedSun;
		Entity*			cachedEntityZero;
		
		BOOL			strict;
		
		BOOL			no_update;
		
		NSMutableDictionary*	local_planetinfo_overrides;
//		NSLock*			universe_lock;
}

- (id) init;
- (void) dealloc;

- (BOOL) strict;
- (void) setStrict:(BOOL) value;

- (void) reinit;

- (int) obj_count;

- (void) sleepytime: (id) thing;

- (void) set_up_universe_from_station;
- (void) set_up_universe_from_witchspace;
- (void) set_up_universe_from_misjump;
- (void) set_up_witchspace;
- (void) set_up_space;
- (void) populateSpaceFromHyperPoint:(Vector) h1_pos toPlanetPosition:(Vector) p1_pos andSunPosition:(Vector) s1_pos;
- (int)	scatterAsteroidsAt:(Vector) spawnPos withVelocity:(Vector) spawnVel includingRockHermit:(BOOL) spawnHermit;
- (void) addShipWithRole:(NSString *) desc nearRouteOneAt:(double) route_fraction;
- (BOOL) addShipWithRole:(NSString *) desc nearPosition:(Vector) pos withCoordinateSystem:(NSString *) system;
- (void) witchspaceShipWithRole:(NSString *) desc;
- (void) spawnShipWithRole:(NSString *) desc near:(Entity *) entity;
- (void) set_up_break_pattern:(Vector) pos quaternion:(Quaternion) q;
- (void) game_over;

- (void) set_up_intro1;
- (void) set_up_intro2;

- (StationEntity *) station;
- (PlanetEntity *) planet;
- (PlanetEntity *) sun;

- (void) resetBeacons;
- (ShipEntity *) firstBeacon;
- (ShipEntity *) lastBeacon;
- (void) setNextBeacon:(ShipEntity *) beaconShip;

- (GLfloat *) sky_clear_color;
- (void) setSky_clear_color:(GLfloat) red :(GLfloat) green :(GLfloat) blue :(GLfloat) alpha;

- (BOOL) breakPatternOver;
- (BOOL) breakPatternHide;

- (id) recycleOrDiscard:(Entity *) entity;
- (Entity *) recycledOrNew:(NSString *) classname;

- (NSMutableDictionary *) preloadedDataFiles;

- (ShipEntity *) getShipWithRole:(NSString *) desc;
- (ShipEntity *) getShip:(NSString *) desc;
- (NSDictionary *) getDictionaryForShip:(NSString *) desc;

- (int) maxCargoForShip:(NSString *) desc;

- (int) getPriceForWeaponSystemWithKey:(NSString *)weapon_key;

- (int) legal_status_of_manifest:(NSArray *)manifest;

- (NSArray *) getContainersOfPlentifulGoods:(int) how_many;
- (NSArray *) getContainersOfScarceGoods:(int) how_many;
- (NSArray *) getContainersOfDrugs:(int) how_many;
- (NSArray *) getContainersOfCommodity:(NSString*) commodity_name :(int) how_many;

- (int) getRandomCommodity;
- (int) getRandomAmountOfCommodity:(int) co_type;

- (int) commodityForName:(NSString *) co_name;
- (NSString *) nameForCommodity:(int) co_type;
- (int) unitsForCommodity:(int) co_type;
- (NSString *) describeCommodity:(int) co_type amount:(int) co_amount;

- (void) setGameView:(NSView *)view;
- (NSView *) gameView;
- (GameController *) gameController;

- (TextureStore *) textureStore;

- (void) drawFromEntity:(int) n;
- (void) drawCrosshairs;
- (void) drawMessage;

- (Entity *) entityZero;

- (Entity *) entityForUniversalID:(int)u_id;
- (BOOL) addEntity:(Entity *) entity;
- (BOOL) removeEntity:(Entity *) entity;
- (void) removeAllEntitiesExceptPlayer:(BOOL) restore;
- (void) removeDemoShips;
- (NSArray *) getAllEntities;

- (BOOL) isVectorClearFromEntity:(Entity *) e1 toDistance:(double)dist fromPoint:(Vector) p2;
- (Vector) getSafeVectorFromEntity:(Entity *) e1 toDistance:(double)dist fromPoint:(Vector) p2;

- (NSArray *) getLaserLineEntitiesForEntity:(Entity *) e1 inView:(int) viewdir;
- (int) getFirstEntityHitByLaserFromEntity:(Entity *) e1;
- (int) getFirstEntityHitByLaserFromEntity:(Entity *) e1 inView:(int) viewdir;
- (int) getFirstEntityTargettedFromEntity:(Entity *) e1 inView:(int) viewdir;

- (NSArray *) getEntitiesWithinRange:(double) range1 ofEntity:(Entity *) e1;
- (int) countShipsWithRole:(NSString *) desc inRange:(double) range1 ofEntity:(Entity *)e1;
- (int) countShipsWithRole:(NSString *) desc;
- (void) sendShipsWithRole:(NSString *) desc messageToAI:(NSString *) ms;

- (double) getTime;
- (double) getTimeDelta;

- (void) findCollisions;
- (void) dumpCollisions;

- (void) setViewDirection:(int) vd;
- (int) viewDir;

- (void) clearPreviousMessage;
- (void) displayMessage:(NSString *) text forCount:(int) count;
- (void) displayCountdownMessage:(NSString *) text forCount:(int) count;
- (void) addDelayedMessage:(NSString *) text forCount:(int) count afterDelay:(double) delay;
- (void) addDelayedMessage:(NSDictionary *) textdict;
- (void) addMessage:(NSString *) text forCount:(int) count;
- (void) addCommsMessage:(NSString *) text forCount:(int) count;
- (void) showCommsLog:(double) how_long;

- (void) update:(double) delta_t;

///////////////////////////////////////

- (void) setGalaxy_seed:(Random_Seed) gal_seed;

- (void) setSystemTo:(Random_Seed) s_seed;

- (Random_Seed) systemSeed;
- (Random_Seed) systemSeedForSystemNumber:(int) n;

- (NSDictionary *) shipyard;
- (NSDictionary *) descriptions;
- (NSDictionary *) missiontext;

- (NSString *) keyForPlanetOverridesForSystemSeed:(Random_Seed) s_seed inGalaxySeed:(Random_Seed) g_seed;
- (NSDictionary *) generateSystemData:(Random_Seed) system_seed;
- (NSDictionary *) currentSystemData;
- (void) setSystemDataKey:(NSString*) key value:(NSObject*) object;
- (NSString *) getSystemName:(Random_Seed) s_seed;
- (NSString *) getSystemInhabitants:(Random_Seed) s_seed;
- (NSString *) generateSystemName:(Random_Seed) system_seed;
- (NSString *) generatePhoneticSystemName:(Random_Seed) s_seed;
- (NSString *) generateSystemInhabitants:(Random_Seed) s_seed;
- (Random_Seed) findSystemAtCoords:(NSPoint) coords withGalaxySeed:(Random_Seed) gal_seed;
- (Random_Seed) findNeighbouringSystemToCoords:(NSPoint) coords withGalaxySeed:(Random_Seed) gal_seed;
- (Random_Seed) findConnectedSystemAtCoords:(NSPoint) coords withGalaxySeed:(Random_Seed) gal_seed;
- (int) findSystemNumberAtCoords:(NSPoint) coords withGalaxySeed:(Random_Seed) gal_seed;
- (NSPoint) findSystemCoordinatesWithPrefix:(NSString *) p_fix withGalaxySeed:(Random_Seed) gal_seed;
- (BOOL*) systems_found;
- (NSString*) systemNameIndex:(int) index;
- (NSDictionary *) routeFromSystem:(int) start ToSystem:(int) goal;
- (NSArray *) neighboursToSystem:(int) system_number;

- (NSMutableDictionary*) local_planetinfo_overrides;
- (void) setLocal_planetinfo_overrides:(NSDictionary*) dict;

- (NSArray *) equipmentdata;
- (NSDictionary *) commoditylists;
- (NSArray *) commoditydata;

- (BOOL) generateEconomicDataWithEconomy:(int) economy andRandomFactor:(int) random_factor;
- (NSArray *) commodityDataForEconomy:(int) economy andStation:(StationEntity *)some_station andRandomFactor:(int) random_factor;

double estimatedTimeForJourney(double distance, int hops);

- (NSArray *) passengersForSystem:(Random_Seed) s_seed atTime:(double) current_time;
- (NSString *) timeDescription:(double) interval;
- (NSString *) shortTimeDescription:(double) interval;
- (NSArray *) contractsForSystem:(Random_Seed) s_seed atTime:(double) current_time;

- (NSArray *) shipsForSaleForSystem:(Random_Seed) s_seed atTime:(double) current_time;
NSComparisonResult compareName( id dict1, id dict2, void * context);
NSComparisonResult comparePrice( id dict1, id dict2, void * context);
- (int) tradeInValueForCommanderDictionary:(NSDictionary*) cmdr_dict;
- (int) weaponForEquipmentKey:(NSString*) weapon_string;
- (NSString*) equipmentKeyForWeapon:(int) weapon;

- (NSString *) generateSystemDescription:(Random_Seed) s_seed;
- (NSString *) expandDescription:(NSString *) desc forSystem:(Random_Seed)s_seed;
- (NSString *) getRandomDigrams;

- (Vector) getWitchspaceExitPosition;
- (Quaternion) getWitchspaceExitRotation;

- (Vector) getSunSkimStartPositionForShip:(ShipEntity*) ship;
- (Vector) getSunSkimEndPositionForShip:(ShipEntity*) ship;

///////////////////////////////////////

- (void) clearGUIs;

- (GuiDisplayGen *) gui;
- (GuiDisplayGen *) comm_log_gui;

- (void) guiUpdated;

- (void) resetCommsLogColor;

- (void) setDisplayCursor:(BOOL) value;
- (BOOL) displayCursor;

- (void) setDisplayText:(BOOL) value;
- (BOOL) displayGUI;

- (void) setDisplayFPS:(BOOL) value;
- (BOOL) displayFPS;

- (void) setReducedDetail:(BOOL) value;
- (BOOL) reducedDetail;

// speech routines
//
- (void) startSpeakingString:(NSString *) text;
//
- (void) stopSpeaking;
//
- (BOOL) isSpeaking;
//
////

@end