TiltAnimatedBuilder widget

Learn about TiltAnimatedBuilder widget parameters. It allows you to customize the tilt animation.

TiltAnimatedBuilder widget can only be used in the Tilt widget.

It provides a customizable animation builder callback for rendering logic.
(for example, Transform).

Simple usage

...

Tilt(
  child: TiltAnimatedBuilder(
    builder: (context, tiltAnimatedState, child) {
      final animatedTiltData = tiltAnimatedState.animatedTiltData;
      final tiltTransform = animatedTiltData.transform;
      final areaProgress = animatedTiltData.areaProgress;

      return Transform(
        alignment: AlignmentDirectional.center,
        transform: tiltTransform,
        child: MyCustomWidget(
          progress: areaProgress,
          child: child, // SomeWidget()
        ),
      );
    },
    child: SomeWidget(),
  ),
),

...

TiltAnimatedBuilder widget parameters

ParameterTypeDefaultDescription
builder requiredWidget Function(
  BuildContext context,
  TiltAnimatedState tiltAnimatedState,
  Widget? child,
);		-Called every time the Tilt animation changes.
The child passed to this builder should typically be included in the returned widget tree.
childWidget?nullThe child widget passed to the builder.
If part of the builder subtree does not depend on Tilt animation changes, prebuild it as child to avoid rebuilding it on every animation update.
Using child is optional, but it can significantly improve performance in suitable cases and is a recommended practice.

TiltAnimatedState

ParameterTypeDescription
tiltConfigTiltConfigThe current tilt configuration.
animatedTiltDataTiltDataModelThe current animated tilt data,
which represents the interpolated result from the initial state to targetTiltData and is used for rendering the current animation progress.
During the animation, animatedTiltData will gradually change from the initial state and approach targetTiltData.
targetTiltDataTiltDataModelThe current target tilt data,
which is the final target data of the animation.
During the animation, animatedTiltData will gradually change from the initial state and approach targetTiltData.
currentGesturesTypeGesturesTypeThe current gestures type.
isCurrentGesturesTypeActiveboolWhether the gesture is currently active.
Indicates whether the gesture is currently active, and is used to determine processing based on gesture priority of GesturesType.