com.mapbox.mapboxsdk.style.layers

Class HillshadeLayer

java.lang.Object

com.mapbox.mapboxsdk.style.layers.Layer

com.mapbox.mapboxsdk.style.layers.HillshadeLayer

@UiThread
public class HillshadeLayer
extends Layer

Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.

See Also:

The online documentation

Constructor Summary

Constructors

Constructor and Description
HillshadeLayer(java.lang.String layerId, java.lang.String sourceId) Creates a HillshadeLayer.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
PropertyValue<java.lang.String>	getHillshadeAccentColor() Get the HillshadeAccentColor property
int	getHillshadeAccentColorAsInt() The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
TransitionOptions	getHillshadeAccentColorTransition() Get the HillshadeAccentColor property transition options
PropertyValue<java.lang.Float>	getHillshadeExaggeration() Get the HillshadeExaggeration property
TransitionOptions	getHillshadeExaggerationTransition() Get the HillshadeExaggeration property transition options
PropertyValue<java.lang.String>	getHillshadeHighlightColor() Get the HillshadeHighlightColor property
int	getHillshadeHighlightColorAsInt() The shading color of areas that faces towards the light source.
TransitionOptions	getHillshadeHighlightColorTransition() Get the HillshadeHighlightColor property transition options
PropertyValue<java.lang.String>	getHillshadeIlluminationAnchor() Get the HillshadeIlluminationAnchor property
PropertyValue<java.lang.Float>	getHillshadeIlluminationDirection() Get the HillshadeIlluminationDirection property
PropertyValue<java.lang.String>	getHillshadeShadowColor() Get the HillshadeShadowColor property
int	getHillshadeShadowColorAsInt() The shading color of areas that face away from the light source.
TransitionOptions	getHillshadeShadowColorTransition() Get the HillshadeShadowColor property transition options
java.lang.String	getSourceId() Get the source id.
protected void	initialize(java.lang.String layerId, java.lang.String sourceId)
void	setHillshadeAccentColorTransition(TransitionOptions options) Set the HillshadeAccentColor property transition options
void	setHillshadeExaggerationTransition(TransitionOptions options) Set the HillshadeExaggeration property transition options
void	setHillshadeHighlightColorTransition(TransitionOptions options) Set the HillshadeHighlightColor property transition options
void	setHillshadeShadowColorTransition(TransitionOptions options) Set the HillshadeShadowColor property transition options
void	setSourceLayer(java.lang.String sourceLayer) Set the source layer.
HillshadeLayer	withProperties(PropertyValue<?>... properties) Set a property or properties.
HillshadeLayer	withSourceLayer(java.lang.String sourceLayer) Set the source Layer.

Methods inherited from class com.mapbox.mapboxsdk.style.layers.Layer

checkThread, getId, getMaxZoom, getMinZoom, getNativePtr, getVisibility, isDetached, nativeGetFilter, nativeGetId, nativeGetMaxZoom, nativeGetMinZoom, nativeGetSourceId, nativeGetSourceLayer, nativeGetVisibility, nativeSetFilter, nativeSetLayoutProperty, nativeSetMaxZoom, nativeSetMinZoom, nativeSetPaintProperty, nativeSetSourceLayer, setDetached, setMaxZoom, setMinZoom, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

HillshadeLayer

public HillshadeLayer(java.lang.String layerId,
                      java.lang.String sourceId)

Creates a HillshadeLayer.

Parameters:

layerId - the id of the layer

sourceId - the id of the source

Method Detail

initialize

protected void initialize(java.lang.String layerId,
                          java.lang.String sourceId)

setSourceLayer

public void setSourceLayer(java.lang.String sourceLayer)

Set the source layer.

Parameters:

sourceLayer - the source layer to set

withSourceLayer

@NonNull
public HillshadeLayer withSourceLayer(java.lang.String sourceLayer)

Set the source Layer.

Parameters:

sourceLayer - the source layer to set

Returns:

This

getSourceId

@NonNull
public java.lang.String getSourceId()

Get the source id.

Returns:

id of the source

withProperties

@NonNull
public HillshadeLayer withProperties(@NonNull
                                              PropertyValue<?>... properties)

Set a property or properties.

Parameters:

properties - the var-args properties

Returns:

This

getHillshadeIlluminationDirection

@NonNull
public PropertyValue<java.lang.Float> getHillshadeIlluminationDirection()

Get the HillshadeIlluminationDirection property

Returns:

property wrapper value around Float

getHillshadeIlluminationAnchor

@NonNull
public PropertyValue<java.lang.String> getHillshadeIlluminationAnchor()

Get the HillshadeIlluminationAnchor property

Returns:

property wrapper value around String

getHillshadeExaggeration

@NonNull
public PropertyValue<java.lang.Float> getHillshadeExaggeration()

Get the HillshadeExaggeration property

Returns:

property wrapper value around Float

getHillshadeExaggerationTransition

@NonNull
public TransitionOptions getHillshadeExaggerationTransition()

Get the HillshadeExaggeration property transition options

Returns:

transition options for Float

setHillshadeExaggerationTransition

public void setHillshadeExaggerationTransition(@NonNull
                                               TransitionOptions options)

Set the HillshadeExaggeration property transition options

Parameters:

options - transition options for Float

getHillshadeShadowColor

@NonNull
public PropertyValue<java.lang.String> getHillshadeShadowColor()

Get the HillshadeShadowColor property

Returns:

property wrapper value around String

getHillshadeShadowColorAsInt

@ColorInt
public int getHillshadeShadowColorAsInt()

The shading color of areas that face away from the light source.

Returns:

int representation of a rgba string color

Throws:

java.lang.RuntimeException - thrown if property isn't a value

getHillshadeShadowColorTransition

@NonNull
public TransitionOptions getHillshadeShadowColorTransition()

Get the HillshadeShadowColor property transition options

Returns:

transition options for String

setHillshadeShadowColorTransition

public void setHillshadeShadowColorTransition(@NonNull
                                              TransitionOptions options)

Set the HillshadeShadowColor property transition options

Parameters:

options - transition options for String

getHillshadeHighlightColor

@NonNull
public PropertyValue<java.lang.String> getHillshadeHighlightColor()

Get the HillshadeHighlightColor property

Returns:

property wrapper value around String

getHillshadeHighlightColorAsInt

@ColorInt
public int getHillshadeHighlightColorAsInt()

The shading color of areas that faces towards the light source.

Returns:

int representation of a rgba string color

Throws:

java.lang.RuntimeException - thrown if property isn't a value

getHillshadeHighlightColorTransition

@NonNull
public TransitionOptions getHillshadeHighlightColorTransition()

Get the HillshadeHighlightColor property transition options

Returns:

transition options for String

setHillshadeHighlightColorTransition

public void setHillshadeHighlightColorTransition(@NonNull
                                                 TransitionOptions options)

Set the HillshadeHighlightColor property transition options

Parameters:

options - transition options for String

getHillshadeAccentColor

@NonNull
public PropertyValue<java.lang.String> getHillshadeAccentColor()

Get the HillshadeAccentColor property

Returns:

property wrapper value around String

getHillshadeAccentColorAsInt

@ColorInt
public int getHillshadeAccentColorAsInt()

The shading color used to accentuate rugged terrain like sharp cliffs and gorges.

Returns:

int representation of a rgba string color

Throws:

java.lang.RuntimeException - thrown if property isn't a value

getHillshadeAccentColorTransition

@NonNull
public TransitionOptions getHillshadeAccentColorTransition()

Get the HillshadeAccentColor property transition options

Returns:

transition options for String

setHillshadeAccentColorTransition

public void setHillshadeAccentColorTransition(@NonNull
                                              TransitionOptions options)

Set the HillshadeAccentColor property transition options

Parameters:

options - transition options for String

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class Layer

Throws:

java.lang.Throwable