ScaleBarOverlay (osmdroid-android 6.1.2 API)

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
```
ScaleBarOverlay.java Puts a scale bar in the top-left corner of the screen, offset by a configurable number of pixels. The bar is scaled to 1-inch length by querying for the physical DPI of the screen. The size of the bar is printed between the tick marks. A vertical (longitude) scale can be enabled. Scale is printed in metric (kilometers, meters), imperial (miles, feet) and nautical (nautical miles, feet). Author: Erik Burrows, Griffin Systems LLC erik@griffinsystems.org Change Log: 2010-10-08: Inclusion to osmdroid trunk 2015-12-17: Allow for top, bottom, left or right placement by W. Strickling Usage: MapView map = new MapView(...); ScaleBarOverlay scaleBar = new ScaleBarOverlay(map); // Thiw is an important change of calling! map.getOverlays().add(scaleBar); To Do List: 1. Allow for top, bottom, left or right placement. // done in this changement 2. Scale bar to precise displayed scale text after rounding.

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
- Nested classes/interfaces inherited from interface org.osmdroid.util.constants.GeoConstants
  GeoConstants.UnitOfMeasure

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScaleBarOverlay.UnitsOfMeasure`

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) double`	`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
mBounds, 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(Context pContext, int pMapWidth, int pMapHeight)

ScaleBarOverlay(MapView mapView)

Constructors
Constructor and Description
`ScaleBarOverlay(Context pContext, int pMapWidth, int pMapHeight)`
`ScaleBarOverlay(MapView mapView)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disableScaleBar()`
`void`	`draw(Canvas c, Projection projection)`
`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
`static String`	`getScaleString(Context pContext, String pValue, GeoConstants.UnitOfMeasure pUnitOfMeasure)`
`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(double 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(double 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
draw, drawAt, getBounds, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onLongPress, onPause, onResume, 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
```
double 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)
```
  - ScaleBarOverlay
```
public ScaleBarOverlay(Context pContext,
                       int pMapWidth,
                       int pMapHeight)
```
    Since:
    
    6.1.0
- Method Detail
  - setMinZoom
```
public void setMinZoom(double 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,
                 Projection projection)
```
    Overrides:
    
    draw in class Overlay
  - disableScaleBar
```
public void disableScaleBar()
```
  - enableScaleBar
```
public void enableScaleBar()
```
  - rebuildBarPath
```
protected void rebuildBarPath(Projection projection)
```
  - scaleBarLengthText
```
protected String scaleBarLengthText(double 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
  - getScaleString
```
public static String getScaleString(Context pContext,
                                    String pValue,
                                    GeoConstants.UnitOfMeasure pUnitOfMeasure)
```
    Since:
    
    6.1.1

Class ScaleBarOverlay

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.osmdroid.util.constants.GeoConstants

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

xOffset

yOffset

minZoom

unitsOfMeasure

latitudeBar

longitudeBar

alignBottom

alignRight

barPath

latitudeBarRect

longitudeBarRect

xdpi

ydpi

screenWidth

screenHeight

Constructor Detail

ScaleBarOverlay

ScaleBarOverlay

Method Detail

setMinZoom

setScaleBarOffset

setLineWidth

setTextSize

setUnitsOfMeasure

getUnitsOfMeasure

drawLatitudeScale

drawLongitudeScale

setCentred

setAlignBottom

setAlignRight

getBarPaint

setBarPaint

getTextPaint

setTextPaint

setBackgroundPaint

setEnableAdjustLength

setMaxLength

draw

disableScaleBar

enableScaleBar

rebuildBarPath

scaleBarLengthText

onDetach

getScaleString