org.osmdroid.views.overlay.simplefastpoint

Class SimpleFastPointOverlayOptions

java.lang.Object

org.osmdroid.views.overlay.simplefastpoint.SimpleFastPointOverlayOptions

public class SimpleFastPointOverlayOptions
extends Object

Options for SimpleFastPointOverlay. Created by Miguel Porto on 25-10-2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleFastPointOverlayOptions.LabelPolicy
static class	SimpleFastPointOverlayOptions.RenderingAlgorithm
static class	SimpleFastPointOverlayOptions.Shape

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleFastPointOverlayOptions.RenderingAlgorithm	mAlgorithm
protected int	mCellSize
protected float	mCircleRadius
protected boolean	mClickable
protected SimpleFastPointOverlayOptions.LabelPolicy	mLabelPolicy
protected int	mMaxNShownLabels
protected int	mMinZoomShowLabels
protected Paint	mPointStyle
protected float	mSelectedCircleRadius
protected Paint	mSelectedPointStyle
protected SimpleFastPointOverlayOptions.Shape	mSymbol
protected Paint	mTextStyle

Constructor Summary

Constructors

Constructor and Description
SimpleFastPointOverlayOptions()

Method Summary

Modifier and Type	Method and Description
static SimpleFastPointOverlayOptions	getDefaultStyle() Creates a new SimpleFastPointOverlayOptions object with default options.
SimpleFastPointOverlayOptions	setAlgorithm(SimpleFastPointOverlayOptions.RenderingAlgorithm algorithm) Sets the rendering algorithm.
SimpleFastPointOverlayOptions	setCellSize(int cellSize) Sets the grid cell size used for indexing, in pixels.
SimpleFastPointOverlayOptions	setIsClickable(boolean clickable) Sets whether this overlay is clickable or not.
SimpleFastPointOverlayOptions	setLabelPolicy(SimpleFastPointOverlayOptions.LabelPolicy labelPolicy) Sets the policy for displaying point labels.
SimpleFastPointOverlayOptions	setMaxNShownLabels(int maxNShownLabels) Sets the threshold (nr.
SimpleFastPointOverlayOptions	setMinZoomShowLabels(int minZoomShowLabels) Sets the minimum zoom level at which the labels should be drawn.
SimpleFastPointOverlayOptions	setPointStyle(Paint style) Sets the style for the point overlay, which is applied to all circles.
SimpleFastPointOverlayOptions	setRadius(float radius) Sets the radius of the circles to be drawn.
SimpleFastPointOverlayOptions	setSelectedPointStyle(Paint style) Sets the style for the selected point.
SimpleFastPointOverlayOptions	setSelectedRadius(float radius) Sets the radius of the selected point's circle.
SimpleFastPointOverlayOptions	setSymbol(SimpleFastPointOverlayOptions.Shape symbol) Sets the symbol shape for this layer.
SimpleFastPointOverlayOptions	setTextStyle(Paint textStyle) Sets the style for the labels.

Methods inherited from class java.lang.Object

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

Field Detail

mPointStyle

protected Paint mPointStyle

mSelectedPointStyle

protected Paint mSelectedPointStyle

mTextStyle

protected Paint mTextStyle

mCircleRadius

protected float mCircleRadius

mSelectedCircleRadius

protected float mSelectedCircleRadius

mClickable

protected boolean mClickable

mCellSize

protected int mCellSize

mAlgorithm

protected SimpleFastPointOverlayOptions.RenderingAlgorithm mAlgorithm

mSymbol

protected SimpleFastPointOverlayOptions.Shape mSymbol

mLabelPolicy

protected SimpleFastPointOverlayOptions.LabelPolicy mLabelPolicy

mMaxNShownLabels

protected int mMaxNShownLabels

mMinZoomShowLabels

protected int mMinZoomShowLabels

Constructor Detail

SimpleFastPointOverlayOptions

public SimpleFastPointOverlayOptions()

Method Detail

getDefaultStyle

public static SimpleFastPointOverlayOptions getDefaultStyle()

Creates a new SimpleFastPointOverlayOptions object with default options.

Returns:

SimpleFastPointOverlayOptions

setPointStyle

public SimpleFastPointOverlayOptions setPointStyle(Paint style)

Sets the style for the point overlay, which is applied to all circles. If the layer is individually styled, the individual style overrides this.

Parameters:

style - A Paint object.

Returns:

The updated SimpleFastPointOverlayOptions

setSelectedPointStyle

public SimpleFastPointOverlayOptions setSelectedPointStyle(Paint style)

Sets the style for the selected point.

Parameters:

style - A Paint object.

Returns:

The updated SimpleFastPointOverlayOptions

setRadius

public SimpleFastPointOverlayOptions setRadius(float radius)

Sets the radius of the circles to be drawn.

Parameters:

radius - Radius.

Returns:

The updated SimpleFastPointOverlayOptions

setSelectedRadius

public SimpleFastPointOverlayOptions setSelectedRadius(float radius)

Sets the radius of the selected point's circle.

Parameters:

radius - Radius.

Returns:

The updated SimpleFastPointOverlayOptions

setIsClickable

public SimpleFastPointOverlayOptions setIsClickable(boolean clickable)

Sets whether this overlay is clickable or not. A clickable overlay will automatically select the nearest point.

Parameters:

clickable - True or false.

Returns:

The updated SimpleFastPointOverlayOptions

setCellSize

public SimpleFastPointOverlayOptions setCellSize(int cellSize)

Sets the grid cell size used for indexing, in pixels. Larger cells result in faster rendering speed, but worse fidelity. Default is 10 pixels, for large datasets (>10k points), use 15.

Parameters:

cellSize - The cell size in pixels.

Returns:

The updated SimpleFastPointOverlayOptions

setAlgorithm

public SimpleFastPointOverlayOptions setAlgorithm(SimpleFastPointOverlayOptions.RenderingAlgorithm algorithm)

Sets the rendering algorithm. There are three options: NO_OPTIMIZATION: Slowest option. Draw all points on each draw event. MEDIUM_OPTIMIZATION: Faster. Recalculates the grid index on each draw event. Not recommended for >10k points. Better UX, but may be choppier. MAXIMUM_OPTIMIZATION: Fastest. Only recalculates the grid on touch up and animation end , hence much faster display on move. Recommended for >10k points.

Parameters:

algorithm - A SimpleFastPointOverlayOptions.RenderingAlgorithm.

Returns:

The updated SimpleFastPointOverlayOptions

setSymbol

public SimpleFastPointOverlayOptions setSymbol(SimpleFastPointOverlayOptions.Shape symbol)

Sets the symbol shape for this layer. Hint: circle shape is less performant, avoid for large N.

Parameters:

symbol - The symbol, currently CIRCLE or SQUARE.

Returns:

The updated SimpleFastPointOverlayOptions

setTextStyle

public SimpleFastPointOverlayOptions setTextStyle(Paint textStyle)

Sets the style for the labels. If the layer is individually styled, the individual style overrides this.

Parameters:

textStyle - The style.

Returns:

The updated SimpleFastPointOverlayOptions

setMinZoomShowLabels

public SimpleFastPointOverlayOptions setMinZoomShowLabels(int minZoomShowLabels)

Sets the minimum zoom level at which the labels should be drawn. This option is ignored if LabelPolicy is DENSITY_THRESHOLD.

Parameters:

minZoomShowLabels - The zoom level.

Returns:

setMaxNShownLabels

public SimpleFastPointOverlayOptions setMaxNShownLabels(int maxNShownLabels)

Sets the threshold (nr. of visible points) after which labels will not be drawn. This option only works when LabelPolicy is DENSITY_THRESHOLD and the algorithm is MAXIMUM_OPTIMIZATION.

Parameters:

maxNShownLabels - The maximum number of visible points

Returns:

setLabelPolicy

public SimpleFastPointOverlayOptions setLabelPolicy(SimpleFastPointOverlayOptions.LabelPolicy labelPolicy)

Sets the policy for displaying point labels. Can be:
ZOOM_THRESHOLD: Labels are not displayed is current map zoom level is lower than MinZoomShowLabels DENSITY_THRESHOLD: Labels are not displayed when the number of visible points is larger than MaxNShownLabels. This only works for MAXIMUM_OPTIMIZATION

Parameters:

labelPolicy - One of ZOOM_THRESHOLD or DENSITY_THRESHOLD

Returns: