MapLibre Native Android/org.maplibre.android.style.layers/HillshadeLayer

HillshadeLayer

@UiThread
open class HillshadeLayer : Layer

Client-side hillshading visualization based on DEM data. The implementation supports Mapbox Terrain RGB, Mapzen Terrarium tiles and custom encodings.

See also

<a href="https://maplibre.org/maplibre-style-spec/#layers-hillshade">The online documentation</a>

Constructors

Link copied to clipboard
constructor(layerId: String, sourceId: String)
Creates a HillshadeLayer.

Properties

Link copied to clipboard
open val nativePtr: Long

Functions

Link copied to clipboard
@NonNull
open fun getHillshadeAccentColor(): PropertyValue<String>
Get the HillshadeAccentColor property
Link copied to clipboard
@ColorInt
open fun getHillshadeAccentColorAsInt(): Int
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Link copied to clipboard
@NonNull
open fun getHillshadeAccentColorTransition(): TransitionOptions
Get the HillshadeAccentColor property transition options
Link copied to clipboard
@NonNull
open fun getHillshadeExaggeration(): PropertyValue<Float>
Get the HillshadeExaggeration property
Link copied to clipboard
@NonNull
open fun getHillshadeExaggerationTransition(): TransitionOptions
Get the HillshadeExaggeration property transition options
Link copied to clipboard
@NonNull
open fun getHillshadeHighlightColor(): PropertyValue<String>
Get the HillshadeHighlightColor property
Link copied to clipboard
@ColorInt
open fun getHillshadeHighlightColorAsInt(): Int
The shading color of areas that faces towards the light source.
Link copied to clipboard
@NonNull
open fun getHillshadeHighlightColorTransition(): TransitionOptions
Get the HillshadeHighlightColor property transition options
Link copied to clipboard
@NonNull
open fun getHillshadeIlluminationAnchor(): PropertyValue<String>
Get the HillshadeIlluminationAnchor property
Link copied to clipboard
@NonNull
open fun getHillshadeIlluminationDirection(): PropertyValue<Float>
Get the HillshadeIlluminationDirection property
Link copied to clipboard
@NonNull
open fun getHillshadeShadowColor(): PropertyValue<String>
Get the HillshadeShadowColor property
Link copied to clipboard
@ColorInt
open fun getHillshadeShadowColorAsInt(): Int
The shading color of areas that face away from the light source.
Link copied to clipboard
@NonNull
open fun getHillshadeShadowColorTransition(): TransitionOptions
Get the HillshadeShadowColor property transition options
Link copied to clipboard
@NonNull
open fun getId(): String
Link copied to clipboard
open fun getMaxZoom(): Float
Link copied to clipboard
open fun getMinZoom(): Float
Link copied to clipboard
@NonNull
open fun getSourceId(): String
Get the source id.
Link copied to clipboard
Link copied to clipboard
open fun isDetached(): Boolean
Link copied to clipboard
open fun setDetached()
Link copied to clipboard
open fun setHillshadeAccentColorTransition(@NonNull options: TransitionOptions)
Set the HillshadeAccentColor property transition options
Link copied to clipboard
open fun setHillshadeExaggerationTransition(@NonNull options: TransitionOptions)
Set the HillshadeExaggeration property transition options
Link copied to clipboard
open fun setHillshadeHighlightColorTransition(@NonNull options: TransitionOptions)
Set the HillshadeHighlightColor property transition options
Link copied to clipboard
open fun setHillshadeShadowColorTransition(@NonNull options: TransitionOptions)
Set the HillshadeShadowColor property transition options
Link copied to clipboard
open fun setMaxZoom(zoom: Float)
Link copied to clipboard
open fun setMinZoom(zoom: Float)
Link copied to clipboard
open fun setProperties(@NonNull properties: Array<PropertyValue<out Any>>)
Link copied to clipboard
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Link copied to clipboard
@NonNull
open fun withProperties(@NonNull properties: Array<PropertyValue<out Any>>): HillshadeLayer
Set a property or properties.
Link copied to clipboard
@NonNull
open fun withSourceLayer(sourceLayer: String): HillshadeLayer
Set the source Layer.