Package worldBuilder

Interface Exporter

All Known Implementing Classes:

FoundExporter, JsonExporter, ObjectExporter, RPGMTiler

public interface Exporter

a class to write out a map for importation into other software

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Exporter.WhichMap	what type of preview are we to generate?

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEPTH
static int	EROSION
static int	FAUNA
static int	FLORA
static int	HEIGHT
static int	MINERALS
static int	RAINFALL

Method Summary

Modifier and Type	Method	Description
void	erodeMap(double[][] erode)	Up-load the net erosion/deposition for every tile
int	export_height()
int	export_width()	return the region width/height (in tiles)
void	faunaMap(double[][] fauna, java.lang.String[] names)	Up-load the fauna distribution for every tile
void	floraMap(double[][] flora, java.lang.String[] names)	Up-load the floral ecotope for every tile
void	heightMap(double[][] heights)	Up-load the altitude of every tile
int	neededInfo()	return a list of the maps this exporter requires
void	position(double lat, double lon)	Set the lat/lon of the region being exported
void	preview(Exporter.WhichMap chosen, java.awt.Color[] colorMap)	generate a preview of the currently up-loaded export
void	rainMap(double[][] rain)	Up-load the annual rainfall for every tile
void	soilMap(double[][] soil, java.lang.String[] names)	Up-load the soil type for every tile
void	temps(double meanTemp, double meanSummer, double meanWinter)	Set seasonal temperature range for region being exported
void	tileSize(int meters)	Set the size of a single tile
void	waterMap(double[][] depths)	Up-load the surface-water-depth (delta-Z) for every tile
boolean	writeFile(java.lang.String outputFile)	Export the up-loaded information in selected format

Field Detail

HEIGHT

static final int HEIGHT

See Also:

Constant Field Values

DEPTH

static final int DEPTH

See Also:

Constant Field Values

EROSION

static final int EROSION

See Also:

Constant Field Values

RAINFALL

static final int RAINFALL

See Also:

Constant Field Values

MINERALS

static final int MINERALS

See Also:

Constant Field Values

FLORA

static final int FLORA

See Also:

Constant Field Values

FAUNA

static final int FAUNA

See Also:

Constant Field Values

Method Detail

neededInfo

int neededInfo()

return a list of the maps this exporter requires

tileSize

void tileSize(int meters)

Set the size of a single tile

Parameters:

meters - real-world width of a tile

export_width

int export_width()

return the region width/height (in tiles)

export_height

int export_height()

position

void position(double lat,
              double lon)

Set the lat/lon of the region being exported

Parameters:

lat - real world latitude of map center

lon - real world longitude of map center

temps

void temps(double meanTemp,
           double meanSummer,
           double meanWinter)

Set seasonal temperature range for region being exported

Parameters:

meanTemp - mean (all year) temperature

meanSummer - mean (summer) temperature

meanWinter - mean (winter) temperature

heightMap

void heightMap(double[][] heights)

Up-load the altitude of every tile

Parameters:

heights - height (Z value) of every point

erodeMap

void erodeMap(double[][] erode)

Up-load the net erosion/deposition for every tile

Parameters:

erode - per point height (Z value) of soil lost to erosion negative means sedimentation

rainMap

void rainMap(double[][] rain)

Up-load the annual rainfall for every tile

Parameters:

rain - per point depth (in meters) of annual rainfall

soilMap

void soilMap(double[][] soil,
             java.lang.String[] names)

Up-load the soil type for every tile

Parameters:

soil - - per point soil type

names - - per-type name strings

waterMap

void waterMap(double[][] depths)

Up-load the surface-water-depth (delta-Z) for every tile

Parameters:

depth - - per point depth of water

floraMap

void floraMap(double[][] flora,
              java.lang.String[] names)

Up-load the floral ecotope for every tile

Parameters:

flora - - per point flora types

names - - per-type name strings

faunaMap

void faunaMap(double[][] fauna,
              java.lang.String[] names)

Up-load the fauna distribution for every tile

Parameters:

fauna - - per point fauna types

names - - per-type name strings

writeFile

boolean writeFile(java.lang.String outputFile)

Export the up-loaded information in selected format

Parameters:

outputFile - - name of output file

preview

void preview(Exporter.WhichMap chosen,
             java.awt.Color[] colorMap)

generate a preview of the currently up-loaded export

Parameters:

chosen - map type (e.g. height, flora)

colorMap - - palette to be used in preview