uk.me.parabola.mkgmap.combiners
Interface OverviewMap

All Superinterfaces:
Configurable, LoadableMapDataSource, MapCollector, MapDataSource
All Known Implementing Classes:
OverviewMapDataSource

public interface OverviewMap
extends LoadableMapDataSource, MapCollector

This is the interface that is used to create the overview map. We will then read back the map via a LoadableMapDataSource.

Author:
Steve Ratcliffe

Method Summary
 void addCopyright(java.lang.String cw)
          Add a copyright string to the map.
 int getShift()
          Get the 'shift' value of the overview map.
 
Methods inherited from interface uk.me.parabola.mkgmap.general.LoadableMapDataSource
copyrightMessages, isFileSupported, load, mapLevels
 
Methods inherited from interface uk.me.parabola.mkgmap.general.MapDataSource
getBounds, getLines, getOverviews, getPoints, getRoadNetwork, getShapes
 
Methods inherited from interface uk.me.parabola.util.Configurable
config
 
Methods inherited from interface uk.me.parabola.mkgmap.general.MapCollector
addLine, addPoint, addRestriction, addRoad, addShape, addThroughRoute, addToBounds
 

Method Detail

addCopyright

void addCopyright(java.lang.String cw)
Add a copyright string to the map.

Parameters:
cw - The string to add.

getShift

int getShift()
Get the 'shift' value of the overview map. This is used for rounding coordinates of objects that are added to the map.

Returns:
An integer shift value, that is 24-bits.