StageData class
The stage as its subtree reads it. Every getter reads the stage's ledger now, so a StageData held from an earlier build never goes stale; the snapshot it was built with only decides which dependents rebuild.
- Inheritance
- Available extensions
Properties
- aspectRatio → double
-
no setter
- backgroundColor → Color?
-
no setter
- busy → bool
-
Available on StageData, provided by the StageDoor extension
no setter - changingMode → bool
-
True while setMode is animating its rect/crop transition. Use to
gate mode-transition fades without firing on user interaction.
no setter
- child → Widget
-
The widget below this widget in the tree.
finalinherited
-
container
→ ValueListenable<
OriginRect?> -
no setter
-
crop
→ ValueNotifier<
Rect> -
Live crop rect, seeded from CropConfig.initialRect when a crop mode
activates and mutated by Stage's recognizer (1-pointer drag inside the
rect) or the Cropper widget's handles. Consumers read it (e.g. on
apply) via
Stage.of(context).crop.value. Reset to Rect.zero when no crop mode is active.no setter - dismissing → bool
-
no setter
- display → OriginRect
-
no setter
- displayConfig → DisplayConfig?
-
The currently-active DisplayConfig (the displayed origin's, merged
with any active mode override). Null when no origin is displayed.
Tools (e.g., Cropper) read this to check whether they should be
active in the current state.
no setter
- displayContainer → OriginRect?
-
no setter
- dragHybridFromStage → DragHybrid?
-
Stage-level cascade fallback for hybrid pointer routing. Resolved last
before DragHybrid.lock / ScaleHybrid.lock.
no setter
- gestureBuilder → StageBuilder?
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hybridReleaseVelocity → ({double scaleVelocity, Velocity velocity})?
-
The hybrid merger's release velocity, or null when the merger didn't
run recently — callers fall back to the firing recognizer's own.
no setter
- interacting → bool
-
True while a gesture on the Stage moves the shown Origin. Read via
Stage.isInteractingOf for tag-aware access (which folds in a check
that the queried tag is the active stage tag).
no setter
- isHybridDriving → bool
-
True while Stage's hybrid merger is driving the rect. Origin reads
this to silence its own rect manipulation while Stage is in control.
no setter
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onRelease → OnRelease?
-
no setter
- open → bool
-
The shown Origin finished opening; the Stage's gestures drive it.
no setter
- openingOrDismissing → bool
-
True during an open (animateToBase) or dismiss (dismiss)
animation. Release rubber-back / settle paths don't touch this. Used
by crop-mode chrome to fade only during real open/dismiss and stay
solid through interaction + settle.
no setter
- origin → OriginRect
-
no setter
- originContainer → OriginRect?
-
no setter
- originGesture → OriginGesture?
-
The Origin gesture in flight (drag or scale on an un-displayed item),
with its hybrid mode resolved up to Origin's level. Null when no
Origin is gesturing.
no setter
-
originToBaseProgress
→ ValueListenable<
double> -
no setter
- overrides → Overrides?
-
no setter
- perspective → double?
-
no setter
-
rect
→ ValueNotifier<
Rect> -
no setter
-
rotation
→ ValueNotifier<
Rotation?> -
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scaleHybridFromStage → ScaleHybrid?
-
no setter
- scaleVelocityCancel → double?
-
Stage-level
scaleVelocityCancel(raw nullable), the bottom of the cascade before the package default of0.8.no setter - stagePointerCount → int
-
Count of the Stage recognizer's pointers. Origin reads this to decide
whether to defer release until stage's pointers also leave.
no setter
- tag → Object?
-
no setter
-
tagStates
→ Map<
Object, TagState> -
no setter
-
transitionProgressMax
→ ValueListenable<
double> -
no setter
-
transitionProgressMean
→ ValueListenable<
double> -
no setter
-
transitionProgressMin
→ ValueListenable<
double> -
Progress 0..1 derived from the four rect/crop animation
controllers, gated by
openingOrDismissing || changingModeso release/settle don't move it. Three aggregations exposed — consumer picks based on desired fade timing:no setter - widget → Widget?
-
no setter
Methods
-
abandon(
Object tag) → void -
animateCrop(
{required Rect to, Duration? duration, Curve curve = Curves.easeOut}) → Future< void> -
Animates crop from its current value to the given rect. Used for
reset transitions and other places that want a smooth crop-rect change
instead of an instant
stage.crop.value = newRectassignment. -
animateRect(
{required Rect to, Duration? duration, Curve curve = Curves.easeIn}) → Future< void> -
animateToBase(
) → Future< void> -
backToBase(
) → Future< void> -
backToOrigin(
ReleaseContext data, {Object? except}) → Future< void> -
captureEntry(
Object tag) → Widget? -
createElement(
) → InheritedModelElement< Object> -
Inflates this configuration to a concrete instance.
inherited
-
cropSourceRect(
Size sourceSize) → Rect -
The crop rect in
sourceSize's pixels, for the image the stage shows. -
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
-
dismiss(
{Object? tag, Object? except, Settle? settle}) → Future< void> -
Flies the shown Origin home and ends the session. With
tag, only that send flies home. -
displace(
Object tag, {required Object target, bool park = true}) → void -
isSupportedAspect(
Object aspect) → bool -
Returns true if this model supports the given
aspect.inherited -
landCrop(
Widget widget, {double? aspectRatio}) → Future< void> -
Shows
widgetwhere the crop rect stands and flies it home. WithaspectRatio, home keeps the slot's width at that ratio — the slot relays out to the cropped photo while it's away — and the crop rect rides home beside it. -
measureEntry(
Object tag) → OriginRect? -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openEntry(
Object tag) → Future< void> -
Opens the Origin
tag. Refused while another session holds the stage. -
register(
Object tag, OriginEntry entry) → void -
release(
Release plan) → Future< void> -
releaseSend(
Object tag) → void -
resetCrop(
) → Future< void> - Animates the image rect back to base and the crop rect back to the mode's initial crop.
-
run(
{List< AxisFling> ? x, List<AxisFling> ? y, List<AxisFling> ? scale}) → Future<void> -
runEffect(
{double? rotateX, double? rotateY, double? rotateZ, double? perspective, Duration duration = const Duration(milliseconds: 100), Curve curve = Curves.easeOut}) → Future< void> -
sendEntry(
Object tag, Rect send(Rect), {VoidCallback? onEnd}) → Future< void> -
Flies the Origin
tagtosend(its rect). Refused while another session holds the stage. -
setAspectRatio(
double aspectRatio) → void -
setBackgroundColor(
Color? color) → void -
setGestureBuilder(
StageBuilder? builder) → void -
setMode(
Object? mode) → void -
Switches the active mode for the currently-displayed origin. Looks
the key up in the origin's modes map, merges with the origin's
default config, and swaps displayConfig. Passing
nullreturns to the default config. -
setOnEnd(
FutureOr< void> onEnd()?) → void -
setOrigin(
OriginRect origin) → void -
Points the flight home at
origin; a pointed home is not measured again. -
setOriginGesture(
OriginGesture? gesture) → void -
setOriginPointers(
Map< int, Offset> pointers, Duration? time) → void -
setRect(
Rect rect) → void -
setWidget(
Widget? widget) → void -
take(
StageTaken taken) → void -
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
-
unregister(
Object tag, OriginEntry entry) → void -
updateShouldNotify(
covariant StageData oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
-
updateShouldNotifyDependent(
covariant StageData oldWidget, Set< Object> dependencies) → bool -
Return true if the changes between this model and
oldWidgetmatch any of thedependencies.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited