SceneTransitionOverlay class
Fades a full-screen barrier over child while a controller-driven
transition runs, showing progress while loading or RetryErrorState on
failure — see CLAUDE.md's "Dialog pattern" note for why this is an
in-tree overlay (works over a full-screen Flame GameWidget) rather than
a pushed route, same reasoning as NeonDialog.
The underlying child is excluded from the semantics tree and ignores
pointer events for the whole time controller.phase isn't idle — so a
stray tap/screen-reader focus can never reach the scene being replaced,
and the barrier is released the instant controller returns to idle
(via a successful reveal or SceneTransitionController.cancel) — it can
never get stuck blocking pointer input.
Respects reduced-motion: when reducedMotion is true (or, if left
null, when MediaQuery.of(context).disableAnimations is true), the
cover/reveal fade duration collapses to zero instead of animating.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SceneTransitionOverlay
Constructors
-
SceneTransitionOverlay({Key? key, required SceneTransitionController controller, required Widget child, Color? color, String? retryLabel, Future<
void> onRetry()?, bool? reducedMotion}) -
const
Properties
- child → Widget
-
final
- color → Color?
-
final
- controller → SceneTransitionController
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onRetry
→ Future<
void> Function()? -
Re-runs the failed load. Left
nullhides the retry button (see RetryErrorState.onRetry) — the barrier still lifts viacancelon the controller in that case, it just isn't offered here.final - reducedMotion → bool?
-
final
- retryLabel → String?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited