DirectionalLight

A light that has a direction and is located at infinite distance, so its rays are parallel. It simulates the sun light and can cast shadows.

Check the online documentation.

Functions

Link copied to clipboard
open override fun castShadows(castShadows: Expression): DirectionalLight
open override fun castShadows(castShadows: Boolean): DirectionalLight

Enable/Disable shadow casting for this light Default value: false.

Link copied to clipboard
open override fun color(color: Expression): DirectionalLight
open override fun color(@ColorInt color: Int): DirectionalLight
open override fun color(color: String): DirectionalLight

Color of the directional light. Default value: "#ffffff".

Link copied to clipboard
open override fun colorTransition(options: StyleTransition): DirectionalLight

Set the Color property transition options.

Link copied to clipboard
open override fun direction(direction: Expression): DirectionalLight
open override fun direction(direction: List<Double>): DirectionalLight

Direction of the light source specified as a azimuthal angle, p polar angle where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 210,30. Minimum value: 0,0. Maximum value: 360,90.

Link copied to clipboard

Set the Direction property transition options.

Link copied to clipboard
open override fun intensity(intensity: Expression): DirectionalLight
open override fun intensity(intensity: Double): DirectionalLight

A multiplier for the color of the directional light. Default value: 0.5. Value range: 0, 1

Link copied to clipboard

Set the Intensity property transition options.

Link copied to clipboard
open override fun shadowIntensity(shadowIntensity: Expression): DirectionalLight
open override fun shadowIntensity(shadowIntensity: Double): DirectionalLight

Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1. Default value: 1. Value range: 0, 1

Link copied to clipboard

Set the ShadowIntensity property transition options.

Properties

Link copied to clipboard

Enable/Disable shadow casting for this light Default value: false.

Link copied to clipboard

Enable/Disable shadow casting for this light Default value: false.

Link copied to clipboard

Color of the directional light. Default value: "#ffffff".

Link copied to clipboard

Color of the directional light. Default value: "#ffffff".

Link copied to clipboard

Color of the directional light. Default value: "#ffffff".

Link copied to clipboard

Color property transition options.

Link copied to clipboard

Direction of the light source specified as a azimuthal angle, p polar angle where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 210,30. Minimum value: 0,0. Maximum value: 360,90.

Link copied to clipboard

Direction of the light source specified as a azimuthal angle, p polar angle where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 210,30. Minimum value: 0,0. Maximum value: 360,90.

Link copied to clipboard

Direction property transition options.

Link copied to clipboard

A multiplier for the color of the directional light. Default value: 0.5. Value range: 0, 1

Link copied to clipboard

A multiplier for the color of the directional light. Default value: 0.5. Value range: 0, 1

Link copied to clipboard

Intensity property transition options.

Link copied to clipboard
open override val lightId: String

The ID of the Light.

Link copied to clipboard

Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1. Default value: 1. Value range: 0, 1

Link copied to clipboard

Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1. Default value: 1. Value range: 0, 1

Link copied to clipboard

ShadowIntensity property transition options.