org.mapsforge.map.model

Class MapViewPosition

java.lang.Object

org.mapsforge.map.model.common.Observable

org.mapsforge.map.model.MapViewPosition

All Implemented Interfaces:

ObservableInterface, Persistable

public class MapViewPosition
extends Observable
implements Persistable

Constructor Summary

Constructors

Constructor and Description
MapViewPosition(DisplayModel displayModel)

Method Summary

Methods

Modifier and Type	Method and Description
void	animateTo(LatLong latLong) Animate the map towards the given position.
boolean	animationInProgress()
void	destroy()
LatLong	getCenter()
BoundingBox	getMapLimit()
MapPosition	getMapPosition()
LatLong	getPivot() The pivot point is the point the map zooms around.
Point	getPivotXY(byte zoomLevel) The pivot point is the point the map zooms around.
double	getScaleFactor()
byte	getZoomLevel()
byte	getZoomLevelMax()
byte	getZoomLevelMin()
void	init(PreferencesFacade preferencesFacade)
void	moveCenter(double moveHorizontal, double moveVertical) Animates the center position of the map by the given amount of pixels.
void	moveCenter(double moveHorizontal, double moveVertical, boolean animated) Moves the center position of the map by the given amount of pixels.
void	moveCenterAndZoom(double moveHorizontal, double moveVertical, byte zoomLevelDiff) Animates the center position of the map by the given amount of pixels.
void	moveCenterAndZoom(double moveHorizontal, double moveVertical, byte zoomLevelDiff, boolean animated) Moves the center position of the map by the given amount of pixels.
void	save(PreferencesFacade preferencesFacade)
void	setCenter(LatLong latLong) Sets the new center position of the map.
void	setMapLimit(BoundingBox mapLimit) Sets the new limit of the map (might be null).
void	setMapPosition(MapPosition mapPosition) Sets the new center position and zoom level of the map.
void	setMapPosition(MapPosition mapPosition, boolean animated) Sets the new center position and zoom level of the map.
void	setPivot(LatLong pivot) The pivot point is the point the map is scaled around when zooming.
void	setScaleFactor(double scaleFactor) Sets the new scale factor to be applied.
void	setScaleFactorAdjustment(double adjustment)
void	setZoomLevel(byte zoomLevel) Sets the new zoom level of the map.
void	setZoomLevel(byte zoomLevel, boolean animated) Sets the new zoom level of the map
void	setZoomLevelMax(byte zoomLevelMax)
void	setZoomLevelMin(byte zoomLevelMin)
void	zoom(byte zoomLevelDiff) Changes the current zoom level by the given value if possible.
void	zoom(byte zoomLevelDiff, boolean animated) Changes the current zoom level by the given value if possible.
void	zoomIn() Increases the current zoom level by one if possible.
void	zoomIn(boolean animated) Increases the current zoom level by one if possible.
void	zoomOut() Decreases the current zoom level by one if possible.
void	zoomOut(boolean animated) Decreases the current zoom level by one if possible.

Methods inherited from class org.mapsforge.map.model.common.Observable

addObserver, notifyObservers, removeObserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapViewPosition

public MapViewPosition(DisplayModel displayModel)

Method Detail

animateTo

public void animateTo(LatLong latLong)

Animate the map towards the given position.

animationInProgress

public boolean animationInProgress()

destroy

public void destroy()

getCenter

public LatLong getCenter()

Returns:

the current center position of the map.

getMapLimit

public BoundingBox getMapLimit()

Returns:

the current limit of the map (might be null).

getMapPosition

public MapPosition getMapPosition()

Returns:

the current center position and zoom level of the map.

getPivot

public LatLong getPivot()

The pivot point is the point the map zooms around.

Returns:

the lat/long coordinates of the map pivot point if set or null otherwise.

getPivotXY

public Point getPivotXY(byte zoomLevel)

The pivot point is the point the map zooms around. If the map zooms around its center null is returned, otherwise the zoom-specific x/y pixel coordinates for the MercatorProjection (note: not the x/y coordinates for the map view or the frame buffer, the MapViewPosition knows nothing about them).

Parameters:

zoomLevel - the zoomlevel to compute the x/y coordinates for

Returns:

the x/y coordinates of the map pivot point if set or null otherwise.

getScaleFactor

public double getScaleFactor()

getZoomLevel

public byte getZoomLevel()

Returns:

the current zoom level of the map.

getZoomLevelMax

public byte getZoomLevelMax()

getZoomLevelMin

public byte getZoomLevelMin()

init

public void init(PreferencesFacade preferencesFacade)

Specified by:

init in interface Persistable

moveCenter

public void moveCenter(double moveHorizontal,
              double moveVertical)

Animates the center position of the map by the given amount of pixels.

Parameters:

moveHorizontal - the amount of pixels to move this MapViewPosition horizontally.

moveVertical - the amount of pixels to move this MapViewPosition vertically.

moveCenter

public void moveCenter(double moveHorizontal,
              double moveVertical,
              boolean animated)

Moves the center position of the map by the given amount of pixels.

Parameters:

moveHorizontal - the amount of pixels to move this MapViewPosition horizontally.

moveVertical - the amount of pixels to move this MapViewPosition vertically.

animated - whether the move should be animated.

moveCenterAndZoom

public void moveCenterAndZoom(double moveHorizontal,
                     double moveVertical,
                     byte zoomLevelDiff)

Animates the center position of the map by the given amount of pixels.

Parameters:

moveHorizontal - the amount of pixels to move this MapViewPosition horizontally.

moveVertical - the amount of pixels to move this MapViewPosition vertically.

zoomLevelDiff - the difference in desired zoom level.

moveCenterAndZoom

public void moveCenterAndZoom(double moveHorizontal,
                     double moveVertical,
                     byte zoomLevelDiff,
                     boolean animated)

Moves the center position of the map by the given amount of pixels.

Parameters:

moveHorizontal - the amount of pixels to move this MapViewPosition horizontally.

moveVertical - the amount of pixels to move this MapViewPosition vertically.

zoomLevelDiff - the difference in desired zoom level.

animated - whether the move should be animated.

save

public void save(PreferencesFacade preferencesFacade)

Specified by:

save in interface Persistable

setCenter

public void setCenter(LatLong latLong)

Sets the new center position of the map.

setMapLimit

public void setMapLimit(BoundingBox mapLimit)

Sets the new limit of the map (might be null).

setMapPosition

public void setMapPosition(MapPosition mapPosition)

Sets the new center position and zoom level of the map.

Note: The default zoom level changes are animated.

setMapPosition

public void setMapPosition(MapPosition mapPosition,
                  boolean animated)

Sets the new center position and zoom level of the map.

setPivot

public void setPivot(LatLong pivot)

The pivot point is the point the map is scaled around when zooming. In normal mode the pivot point is whatever the view center is (this is indicated by setting the pivot to null), but when hand-zooming the pivot point can be any point on the map. It is stored as lat/long and retrieved as an x/y coordinate depending on the current zoom level.

Parameters:

pivot - lat/long of pivot point, null for map center

setScaleFactor

public void setScaleFactor(double scaleFactor)

Sets the new scale factor to be applied.

setScaleFactorAdjustment

public void setScaleFactorAdjustment(double adjustment)

setZoomLevel

public void setZoomLevel(byte zoomLevel)

Sets the new zoom level of the map.

Note: The default zoom level changes are animated.

Throws:

IllegalArgumentException - if the zoom level is negative.

setZoomLevel

public void setZoomLevel(byte zoomLevel,
                boolean animated)

Sets the new zoom level of the map

Parameters:

zoomLevel - desired zoom level

animated - true if the transition should be animated, false otherwise

Throws:

IllegalArgumentException - if the zoom level is negative.

setZoomLevelMax

public void setZoomLevelMax(byte zoomLevelMax)

setZoomLevelMin

public void setZoomLevelMin(byte zoomLevelMin)

zoom

public void zoom(byte zoomLevelDiff)

Changes the current zoom level by the given value if possible.

Note: The default zoom level changes are animated.

zoom

public void zoom(byte zoomLevelDiff,
        boolean animated)

Changes the current zoom level by the given value if possible.

zoomIn

public void zoomIn()

Increases the current zoom level by one if possible.

Note: The default zoom level changes are animated.

zoomIn

public void zoomIn(boolean animated)

Increases the current zoom level by one if possible.

zoomOut

public void zoomOut()

Decreases the current zoom level by one if possible.

Note: The default zoom level changes are animated.

zoomOut

public void zoomOut(boolean animated)

Decreases the current zoom level by one if possible.