org.osmdroid.views.overlay

Class ScaleBarOverlay

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.ScaleBarOverlay

All Implemented Interfaces:

GeoConstants, OverlayConstants

public class ScaleBarOverlay
extends Overlay
implements GeoConstants

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScaleBarOverlay.UnitsOfMeasure

Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alignBottom
protected boolean	alignRight
protected Path	barPath
(package private) boolean	latitudeBar
protected Rect	latitudeBarRect
(package private) boolean	longitudeBar
protected Rect	longitudeBarRect
(package private) int	minZoom
int	screenHeight
int	screenWidth
(package private) ScaleBarOverlay.UnitsOfMeasure	unitsOfMeasure
float	xdpi
(package private) int	xOffset
float	ydpi
(package private) int	yOffset

Fields inherited from class org.osmdroid.views.overlay.Overlay

SHADOW_X_SKEW, SHADOW_Y_SCALE

Fields inherited from interface org.osmdroid.util.constants.GeoConstants

EQUATORCIRCUMFENCE, FEET_PER_METER, METERS_PER_NAUTICAL_MILE, METERS_PER_STATUTE_MILE, RADIUS_EARTH_METERS

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants

DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors

Constructor and Description
ScaleBarOverlay(MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	disableScaleBar()
void	draw(Canvas c, MapView mapView, boolean shadow) Draw the overlay over the map.
void	drawLatitudeScale(boolean latitude) Latitudinal / horizontal scale bar flag
void	drawLongitudeScale(boolean longitude) Longitudinal / vertical scale bar flag
void	enableScaleBar()
Paint	getBarPaint() Return's the paint used to draw the bar
Paint	getTextPaint() Returns the paint used to draw the text
ScaleBarOverlay.UnitsOfMeasure	getUnitsOfMeasure() Gets the units of measure to be shown in the scale bar
void	onDetach(MapView mapView) Override to perform clean up of resources before shutdown.
protected void	rebuildBarPath(Projection projection)
protected String	scaleBarLengthText(int meters)
void	setAlignBottom(boolean alignBottom)
void	setAlignRight(boolean alignRight)
void	setBackgroundPaint(Paint pBgPaint) Sets the background paint.
void	setBarPaint(Paint pBarPaint) Sets the paint for drawing the bar
void	setCentred(boolean centred) Flag to draw the bar centered around the set offset coordinates or to the right/bottom of the coordinates (default)
void	setEnableAdjustLength(boolean adjustLength) If enabled, the bar will automatically adjust the length to reflect a round number (starting with 1, 2 or 5).
void	setLineWidth(float width) Sets the bar's line width.
void	setMaxLength(float pMaxLengthInCm) Sets the maximum bar length.
void	setMinZoom(int zoom) Sets the minimum zoom level for the scale bar to be drawn.
void	setScaleBarOffset(int x, int y) Sets the scale bar screen offset for the bar.
void	setTextPaint(Paint pTextPaint) Sets the paint for drawing the text
void	setTextSize(float size) Sets the text size.
void	setUnitsOfMeasure(ScaleBarOverlay.UnitsOfMeasure unitsOfMeasure) Sets the units of measure to be shown in the scale bar

Methods inherited from class org.osmdroid.views.overlay.Overlay

drawAt, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onLongPress, onScroll, onShowPress, onSingleTapConfirmed, onSingleTapUp, onTouchEvent, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

xOffset

int xOffset

yOffset

int yOffset

minZoom

int minZoom

unitsOfMeasure

ScaleBarOverlay.UnitsOfMeasure unitsOfMeasure

latitudeBar

boolean latitudeBar

longitudeBar

boolean longitudeBar

alignBottom

protected boolean alignBottom

alignRight

protected boolean alignRight

barPath

protected final Path barPath

latitudeBarRect

protected final Rect latitudeBarRect

longitudeBarRect

protected final Rect longitudeBarRect

xdpi

public float xdpi

ydpi

public float ydpi

screenWidth

public int screenWidth

screenHeight

public int screenHeight

Constructor Detail

ScaleBarOverlay

public ScaleBarOverlay(MapView mapView)

Method Detail

setMinZoom

public void setMinZoom(int zoom)

Sets the minimum zoom level for the scale bar to be drawn.

Parameters:

zoom - minimum zoom level

setScaleBarOffset

public void setScaleBarOffset(int x,
                              int y)

Sets the scale bar screen offset for the bar. Note: if the bar is set to be drawn centered, this will be the middle of the bar, otherwise the top left corner.

Parameters:

x - x screen offset

y - z screen offset

setLineWidth

public void setLineWidth(float width)

Sets the bar's line width. (the default is 2)

Parameters:

width - the new line width

setTextSize

public void setTextSize(float size)

Sets the text size. (the default is 12)

Parameters:

size - the new text size

setUnitsOfMeasure

public void setUnitsOfMeasure(ScaleBarOverlay.UnitsOfMeasure unitsOfMeasure)

Sets the units of measure to be shown in the scale bar

getUnitsOfMeasure

public ScaleBarOverlay.UnitsOfMeasure getUnitsOfMeasure()

Gets the units of measure to be shown in the scale bar

drawLatitudeScale

public void drawLatitudeScale(boolean latitude)

Latitudinal / horizontal scale bar flag

Parameters:

latitude -

drawLongitudeScale

public void drawLongitudeScale(boolean longitude)

Longitudinal / vertical scale bar flag

Parameters:

longitude -

setCentred

public void setCentred(boolean centred)

Flag to draw the bar centered around the set offset coordinates or to the right/bottom of the coordinates (default)

Parameters:

centred - set true to centre the bar around the given screen coordinates

setAlignBottom

public void setAlignBottom(boolean alignBottom)

setAlignRight

public void setAlignRight(boolean alignRight)

getBarPaint

public Paint getBarPaint()

Return's the paint used to draw the bar

Returns:

the paint used to draw the bar

setBarPaint

public void setBarPaint(Paint pBarPaint)

Sets the paint for drawing the bar

Parameters:

pBarPaint - bar drawing paint

getTextPaint

public Paint getTextPaint()

Returns the paint used to draw the text

Returns:

the paint used to draw the text

setTextPaint

public void setTextPaint(Paint pTextPaint)

Sets the paint for drawing the text

Parameters:

pTextPaint - text drawing paint

setBackgroundPaint

public void setBackgroundPaint(Paint pBgPaint)

Sets the background paint. Set to null to disable drawing of background (default)

Parameters:

pBgPaint - the paint for colouring the bar background

setEnableAdjustLength

public void setEnableAdjustLength(boolean adjustLength)

If enabled, the bar will automatically adjust the length to reflect a round number (starting with 1, 2 or 5). If disabled, the bar will always be drawn in full length representing a fractional distance.

setMaxLength

public void setMaxLength(float pMaxLengthInCm)

Sets the maximum bar length. If adjustLength is disabled this will match exactly the length of the bar. If adjustLength is enabled, the bar will be shortened to reflect a round number in length.

Parameters:

pMaxLengthInCm - maximum length of the bar in the screen in cm. Default is 2.54 (=1 inch)

draw

public void draw(Canvas c,
                 MapView mapView,
                 boolean shadow)

Description copied from class: Overlay

Draw the overlay over the map. This will be called on all active overlays with shadow=true, to lay down the shadow layer, and then again on all overlays with shadow=false. Callers should check isEnabled() before calling draw(). By default, draws nothing. changed for 5.6 to be public see https://github.com/osmdroid/osmdroid/issues/466

Specified by:

draw in class Overlay

disableScaleBar

public void disableScaleBar()

enableScaleBar

public void enableScaleBar()

rebuildBarPath

protected void rebuildBarPath(Projection projection)

scaleBarLengthText

protected String scaleBarLengthText(int meters)

onDetach

public void onDetach(MapView mapView)

Description copied from class: Overlay

Override to perform clean up of resources before shutdown. By default does nothing.

Overrides:

onDetach in class Overlay