IrradianceVolumeComponent class Lighting and environment
A Component that places the scene's irradiance volume on its node.
The volume is an axis-aligned box of half-size extents centered on the
node's world position, subdivided into resolution probes. Requires
Scene.globalIllumination.volumeMode to be
IrradianceVolumeMode.component.
One volume is active at a time. When several contain the camera the highest priority wins, and the switch resets the field to a fast- converge ramp rather than cross-fading two atlases. That pop is the price of a receiver that stays at eight probe taps instead of sixteen.
Constructors
- IrradianceVolumeComponent({Vector3? extents, Vector3? resolution, double priority = 0.0, double? intensity, double? hysteresis, double? visibility, IrradianceFieldBake? bake})
Properties
- bake ↔ IrradianceFieldBake?
-
An optional baked irradiance field providing the initial state.
getter/setter pair
- enabled ↔ bool
-
Whether this component's update hook runs each frame.
getter/setter pairinherited
- extents ↔ Vector3
-
Box half-size in world units, centered on the node's world position.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hysteresis ↔ double?
-
getter/setter pair
- intensity ↔ double?
-
Overrides that fall back to the scene settings when null.
getter/setter pair
- 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
- node → Node
-
The node this component is attached to.
no setterinherited
- priority ↔ double
-
Selection order among volumes containing the camera; highest wins.
getter/setter pair
- resolution ↔ Vector3
-
Probe count along each axis.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- visibility ↔ double?
-
getter/setter pair
- worldCenter → Vector3
-
The volume's world-space center.
no setter
Methods
-
cloneFor(
Node cloneOwner) → Component? -
Returns a copy of this component for
cloneOwner, the Node.clone counterpart of the owning node, or null to not carry the component to clones (the default).inherited -
consumeInvalidation(
) → bool - Whether this volume asked to be refilled from scratch, clearing the request.
-
contains(
Vector3 worldPosition) → bool -
Whether
worldPositionsits inside this volume. -
fixedUpdate(
double fixedDt) → void -
Called once per fixed physics step while the component is mounted,
enabled, and loaded.
fixedDtis the fixed timestep of the surrounding PhysicsWorld, not the frame interval.inherited -
invalidate(
) → void - Discards the accumulated field so it refills from scratch.
-
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.
deltaSecondsis 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