SnapControllerState class

Inheritance
Mixed-in types

Constructors

SnapControllerState(bool useCache, GlobalKey<State<StatefulWidget>> viewKey, GlobalKey<State<StatefulWidget>> boundKey, Offset constraintsMin, Offset constraintsMax, Offset flexibilityMin, Offset flexibilityMax, List<SnapTarget>? snapTargets, double minSnapDistance, bool animateSnap, bool useFlick, double flickSensitivity, MoveCallback? onMove, DragCallback? onDragStart, DragCallback? onDragUpdate, DragCallback? onDragEnd, SnapCallback? onSnap)

Properties

animateSnap bool
final
animation Animation<Offset>
getter/setter pair
animationController AnimationController
The AnimationController used to move the view during snapping if SnapController.animateSnap is set to true.
getter/setter pair
beginDragPosition Offset?
getter/setter pair
boundHeight double
getter/setter pair
boundIsSet bool
no setter
boundKey GlobalKey<State<StatefulWidget>>
final
boundOrigin Offset?
getter/setter pair
boundRenderBox RenderBox?
getter/setter pair
boundWidth double
getter/setter pair
canMove bool
getter/setter pair
constraintsMax Offset
getter/setter pair
constraintsMin Offset
getter/setter pair
context BuildContext
The location in the tree where this widget builds.
no setterinherited
delta Offset
getter/setter pair
deltaNotifier ValueNotifier<Offset>
final
flexibilityMax Offset
final
flexibilityMin Offset
final
flickController GlobalKey<FlickControllerState>
final
flickSensitivity double
final
hashCode int
The hash code for this object.
no setterinherited
maxBottom double
no setter
maxLeft double
no setter
maxRight double
no setter
maxTop double
no setter
minSnapDistance double
final
mounted bool
Whether this State object is currently in a tree.
no setterinherited
normalisedConstraintsMax Offset
getter/setter pair
normalisedConstraintsMin Offset
getter/setter pair
onDragEnd DragCallback?
final
onDragStart DragCallback?
final
onDragUpdate DragCallback?
final
onMove MoveCallback?
final
onSnap SnapCallback?
final
overrideDelta Offset
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
snapTargets List<SnapTarget>?
final
uiChild Widget?
getter/setter pair
updateDragPosition Offset?
getter/setter pair
useCache bool
final
useFlick bool
getter/setter pair
viewHeight double
getter/setter pair
viewIsSet bool
no setter
viewKey GlobalKey<State<StatefulWidget>>
final
viewOrigin Offset?
getter/setter pair
viewRenderBox RenderBox?
getter/setter pair
viewWidth double
getter/setter pair
widget SnapController
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
animationListener() → void
beginDrag(dynamic dragStartDetails) → void
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
checkBoundOrigin() → void
checkViewAndBound() → void
checkViewOrigin() → void
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback.
inherited
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant SnapController oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
override
endDrag(dynamic dragEndDetails) → void
getSnapTarget() Offset
initState() → void
Called when this object is inserted into the tree.
override
isMoved(double treshold) bool
Use this function to determine if the view is moved or not.
move(Offset snapTarget) Future
normaliseConstraints() → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onFlick(Offset offset) → void
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
reset() → void
setBound() → void
setDelta() → void
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
setView() → void
snap() Future
softReset(Offset _constraintsMin, Offset _constraintsMax) → 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
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
updateDrag(dynamic dragUpdateDetails) → void
wrapper() Widget

Operators

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