sceneview/io.github.sceneview.components/LightComponent

LightComponent

interface LightComponent : Component

Inheritors

Properties

Link copied to clipboard
open var color: Color

Dynamically updates the light's hue as linear sRGB

Link copied to clipboard
abstract val engine: Engine
Link copied to clipboard
abstract val entity: Entity
Link copied to clipboard
open var falloff: Float

The falloff distance for point lights and spot lights.

Link copied to clipboard
open val innerConeAngle: Float
Link copied to clipboard
open var intensity: Float

Dynamically updates the light's intensity

Link copied to clipboard
open var isShadowCaster: Boolean

Whether this Light casts shadows (disabled by default)

Link copied to clipboard
open var lightDirection: Direction

The light's direction in world space

Link copied to clipboard
Link copied to clipboard
open val lightManager: LightManager
Link copied to clipboard
open var lightPosition: Position

The light's position in world space

Link copied to clipboard
open var lightQuaternion: Quaternion

The light's rotation in world space

Link copied to clipboard
open val outerConeAngle: Float
Link copied to clipboard
open var sunAngularRadius: Float

Dynamically updates the angular radius of a Type.SUN light.

Link copied to clipboard
open var sunHaloFalloff: Float

Dynamically updates the halo falloff of a Type.SUN light.

Link copied to clipboard
open var sunHaloSize: Float

Dynamically updates the halo radius of a Type.SUN light

Link copied to clipboard
open val type: LightManager.Type

Functions

Link copied to clipboard
open fun getLightChannel(@IntRange(from = 0, to = 7) channel: Int): Boolean

Returns whether a light channel is enabled on a specified renderable.

Link copied to clipboard
open fun setIntensity(watts: Float, efficiency: Float)

Dynamically updates the light's intensity. The intensity can be negative.

Link copied to clipboard
open fun setIntensityCandela(intensity: Float)

Dynamically updates the light's intensity in candela. The intensity can be negative.

Link copied to clipboard
open fun setLightChannel(@IntRange(from = 0, to = 7) channel: Int, enable: Boolean)

Enables or disables a light channel. Light channel 0 is enabled by default.

Link copied to clipboard
open fun setSpotLightCone(inner: Float, outer: Float)

Dynamically updates a spot light's cone as angles