DirectionalLightComponent class Scene graph

An engine Component that places a DirectionalLight in the scene.

While the owning node is part of a live scene, the component registers its light with the scene's render layer so the renderer can find it, and unregisters it when the node leaves the scene.

The light's travel direction is the owning node's world-space orientation applied to the light's DirectionalLight.direction (read as a node-local direction), so re-orienting the node aims the light. With an unrotated node the world direction equals the light's own DirectionalLight.direction.

The renderer currently shades a single directional light (the first one registered); additional directional lights are collected but not yet shaded.

Inheritance

Constructors

DirectionalLightComponent(DirectionalLight light)
Creates a component that lights the scene with light.

Properties

enabled ↔ bool
Whether this component's update hook runs each frame.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
isAttached → bool
Whether this component is currently attached to a node.
no setterinherited
isLoaded → bool
Whether onLoad has completed.
no setterinherited
isMounted → bool
Whether the owning node is part of a live scene graph.
no setterinherited
light ↔ DirectionalLight
The light this component contributes. Its DirectionalLight.direction is read in the owning node's local space; worldDirection is the world-space result.
getter/setter pair
node → Node
The node this component is attached to.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
worldDirection → Vector3
The light's world-space travel direction: the owning node's world-space rotation applied to the light's local DirectionalLight.direction. Need not be unit length (the shader and the shadow-cascade fit both normalize it).
no setter

Methods

fixedUpdate(double fixedDt) → void
Called once per fixed physics step while the component is mounted, enabled, and loaded. fixedDt is the fixed timestep of the surrounding PhysicsWorld, not the frame interval.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onAttach() → void
Called when this component is added to a node.
inherited
onDetach() → void
Called when this component is removed from a node.
inherited
onLoad() → Future<void>
Optional asynchronous setup, such as loading an asset.
inherited
onMount() → void
Called when the owning node enters a live scene graph.
override
onUnmount() → void
Called when the owning node leaves a live scene graph.
override
toString() → String
A string representation of this object.
inherited
update(double deltaSeconds) → void
Called once per frame while the component is mounted, enabled, and loaded. deltaSeconds is the elapsed time since the previous tick.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited