RectAreaLightComponent class Scene graph

An engine Component that places a RectAreaLight in the scene.

The rectangle lies in the owning node's local XY plane and emits along local +Z; the node's world transform positions and aims it.

Inheritance

Constructors

RectAreaLightComponent(RectAreaLight 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 RectAreaLight
The light this component contributes.
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
worldPosition → Vector3
The panel center: the owning node's world-space translation.
no setter
worldRight → Vector3
The panel's world-space width axis (the node's rotated local +X), unit length.
no setter
worldUp → Vector3
The panel's world-space height axis (the node's rotated local +Y), unit length.
no setter

Methods

cloneFor(Node cloneOwner) Component?
Clones carry the light, sharing the light object like other clone payloads (geometry, materials).
override
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. A traversal visits each component at most once. Removing this component or an earlier sibling is safe. A component inserted before the current traversal position starts on the next frame. Reordering component or child lists during traversal is unsupported.
inherited

Operators

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