FollowPathEffect class
An effect that moves the target following the specified path (via Transform). The path coordinates are relative to the target's nominal position.
The path can have multiple segments (ex. multiple curves). It can also have multiple contours (ie. disconnected segments), but only the first contour will be followed.
begin and end specify a position along the path (ie. 0 is the start of the path, 1 is the end).
For example, begin: 0.5, end: 1
will move the target from the middle of the path to the end.
If rotate is set to true
, the target will be rotated to match the path's direction.
You can use rotationOffset to adjust the rotation (in radians).
Note: Rotation may not be smooth on web when using the HTML renderer due to a
Flutter issue.
transformHitTests is simply passed on to Transform.
Constructors
Properties
- begin → double?
-
The begin value for the effect. If null, effects should use a reasonable
default value when appropriate.
finalinherited
- curve → Curve?
-
The specified easing curve for the effect. If null, will inherit the curve from the
previous effect, or use Animate.defaultCurve if this is the first effect.
finalinherited
- delay → Duration?
-
The specified delay for the effect. If null, will inherit the delay from the
previous effect, or use Duration.zero if this is the first effect.
finalinherited
- duration → Duration?
-
The specified duration for the effect. If null, will inherit the duration from the
previous effect, or use Animate.defaultDuration if this is the first effect.
finalinherited
- end → double?
-
The end value for the effect. If null, effects should use a reasonable
default value when appropriate.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- path → Path
-
final
- rotate → bool
-
final
- rotationOffset → double
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- transformHitTests → bool
-
final
Methods
-
build(
BuildContext context, Widget child, AnimationController controller, EffectEntry entry) → Widget -
Builds the widgets that implement the effect on the target
child
, based on the provided AnimationController and EffectEntry.override -
buildAnimation(
AnimationController controller, EffectEntry entry) → Animation< double> -
Returns an animation based on the controller, entry, and begin/end values.
inherited
-
getBeginRatio(
AnimationController controller, EffectEntry entry) → double -
Returns a ratio corresponding to the beginning of the specified entry.
inherited
-
getEndRatio(
AnimationController controller, EffectEntry entry) → double -
Returns a ratio corresponding to the end of the specified entry.
inherited
-
getOptimizedBuilder<
U> ({required ValueListenable< U> animation, Widget? child, required TransitionBuilder builder}) → AnimatedBuilder -
Returns an optimized AnimatedBuilder that doesn't
rebuild if the value hasn't changed.
inherited
-
getToggleBuilder(
{required ValueListenable< double> animation, required Widget child, required bool toggle(), required ToggleEffectBuilder builder}) → AnimatedBuilder -
Returns an AnimatedBuilder that rebuilds when the
boolean value returned by the
toggle
function changes.inherited -
isAnimationActive(
Animation animation) → bool -
Check if the animation is currently running / active.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- defaultRotate → const bool
- defaultRotationOffset → const double
- defaultTransformHitTests → const bool
- defaultValue → const double
- neutralValue → const double