com.mousebird.maply

Interface VectorStyleInterface

All Known Implementing Classes:

MapboxVectorStyleSet, SLDStyleSet, VectorStyleSimpleGenerator

public interface VectorStyleInterface

The Vector Style Interface returns Vector Style objects for a given list of attributes. It also can be used to control which layers are displayed, possibly circumventing a large amount of processing.
This class is a generator for the styles, which do the actual work. We use UUIDs for the styles so that we can collect all the vectors together for a particular style and then call that style with a single list of data. This makes data display far more efficient.

Method Summary

Modifier and Type	Method and Description
VectorStyle[]	allStyles() Return the full list of styles.
int	backgroundColorForZoom(double zoom) Return a color for the background (clear color).
boolean	layerShouldDisplay(java.lang.String layerName, TileID tileID) Returns true if the given layer (by name) should be displayed at all.
VectorStyle	styleForUUID(long uuid, RenderControllerInterface controller) Returns a vector style corresponding to the given unique ID.
VectorStyle[]	stylesForFeature(AttrDictionary attrs, TileID tileID, java.lang.String layerName, RenderControllerInterface controller) Return the styles that match to the given list of attributes.

Method Detail

stylesForFeature

VectorStyle[] stylesForFeature(AttrDictionary attrs,
                               TileID tileID,
                               java.lang.String layerName,
                               RenderControllerInterface controller)

Return the styles that match to the given list of attributes. Each of these styles will be called to generate visible geometry. Order is not important.

Parameters:

attrs - The attribute dictionary from the vector feature.

tileID - The tileID if we're building from a tile source. null if not.

layerName - The layer name if the data is coming from vector tiles.

controller - Maply base controller where the

Returns:

A list of vector styles that apply to the vector data with the given attributes.

allStyles

VectorStyle[] allStyles()

Return the full list of styles.

layerShouldDisplay

boolean layerShouldDisplay(java.lang.String layerName,
                           TileID tileID)

Returns true if the given layer (by name) should be displayed at all. If you return false, then those vector objects will not be displayed and potentially not even parsed.

Parameters:

layerName - Name of the layer to be displayed (or not)

tileID - If we're using a tile source, this is the tile ID. If not, it will be null.

styleForUUID

VectorStyle styleForUUID(long uuid,
                         RenderControllerInterface controller)

Returns a vector style corresponding to the given unique ID. Each vector style has to have a unique ID which we'll use for sorting things.

Parameters:

uuid - Unique ID

controller - Base controller used for the geometry.

Returns:

Vector Style to be used in displaying geometry.

backgroundColorForZoom

int backgroundColorForZoom(double zoom)

Return a color for the background (clear color).