SkyLayerDsl

interface SkyLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

filter
Link copied to clipboard
abstract fun filter(filter: Expression): SkyLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

maxZoom
Link copied to clipboard
abstract fun maxZoom(maxZoom: Double): SkyLayer

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
abstract fun minZoom(minZoom: Double): SkyLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

skyAtmosphereColor
Link copied to clipboard
abstract fun skyAtmosphereColor(skyAtmosphereColor: Expression): SkyLayer
abstract fun skyAtmosphereColor(@ColorInt skyAtmosphereColor: Int): SkyLayer
abstract fun skyAtmosphereColor(skyAtmosphereColor: String = "white"): SkyLayer

A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.

skyAtmosphereHaloColor
Link copied to clipboard
abstract fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: Expression): SkyLayer
abstract fun skyAtmosphereHaloColor(@ColorInt skyAtmosphereHaloColor: Int): SkyLayer
abstract fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: String = "white"): SkyLayer

A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

skyAtmosphereSun
Link copied to clipboard
abstract fun skyAtmosphereSun(skyAtmosphereSun: Expression): SkyLayer
abstract fun skyAtmosphereSun(skyAtmosphereSun: List<Double>): SkyLayer

Position of the sun center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the sun relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0 degree is directly above, at zenith, and 90 degree at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.

skyAtmosphereSunIntensity
Link copied to clipboard
abstract fun skyAtmosphereSunIntensity(skyAtmosphereSunIntensity: Expression): SkyLayer
abstract fun skyAtmosphereSunIntensity(skyAtmosphereSunIntensity: Double = 10.0): SkyLayer

Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.

skyGradient
Link copied to clipboard
abstract fun skyGradient(skyGradient: Expression): SkyLayer

Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using sky-radial-progress. The range 0, 1 for the interpolant covers a radial distance (in degrees) of 0, `sky-gradient-radius` centered at the position specified by sky-gradient-center.

skyGradientCenter
Link copied to clipboard
abstract fun skyGradientCenter(skyGradientCenter: Expression): SkyLayer
abstract fun skyGradientCenter(skyGradientCenter: List<Double> = listOf(0.0, 0.0)): SkyLayer

Position of the gradient center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the gradient center relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0 degree is directly above, at zenith, and 90 degree at the horizon.

skyGradientRadius
Link copied to clipboard
abstract fun skyGradientRadius(skyGradientRadius: Expression): SkyLayer
abstract fun skyGradientRadius(skyGradientRadius: Double = 90.0): SkyLayer

The angular distance (measured in degrees) from sky-gradient-center up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from sky-gradient-center.

skyOpacity
Link copied to clipboard
abstract fun skyOpacity(skyOpacity: Expression): SkyLayer
abstract fun skyOpacity(skyOpacity: Double = 1.0): SkyLayer

The opacity of the entire sky layer.

skyOpacityTransition
Link copied to clipboard
abstract fun skyOpacityTransition(options: StyleTransition): SkyLayer
abstract fun skyOpacityTransition(block: StyleTransition.Builder.() -> Unit): SkyLayer

The opacity of the entire sky layer.

skyType
Link copied to clipboard
abstract fun skyType(skyType: Expression): SkyLayer
abstract fun skyType(skyType: SkyType = SkyType.ATMOSPHERE): SkyLayer

The type of the sky

visibility
Link copied to clipboard
abstract fun visibility(visibility: Visibility): SkyLayer

Whether this layer is displayed.

Inheritors

SkyLayer
Link copied to clipboard