Builder type for scale animations.

Type alias for the animation group name.

Set the initial scale.

Use this to initialize the scale in your Engine's init function.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.init "animGroupName" 1.5 ] }
    , Cmd.none
    )

This is equivalent to calling initXYZ 1.5 1.5 1.5.

Set the initial X, Y, and Z scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initXYZ "animGroupName" 1.5 1.2 1.0 ] }
    , Cmd.none
    )

Set the initial X and Y scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initXY "animGroupName" 1.5 1.2 ] }
    , Cmd.none
    )

Set the initial X and Z scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initXZ "animGroupName" 1.5 1.0 ] }
    , Cmd.none
    )

Set the initial X scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initX "animGroupName" 1.5 ] }
    , Cmd.none
    )

Set the initial Y and Z scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initYZ "animGroupName" 1.2 1.0 ] }
    , Cmd.none
    )

Set the initial Y scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initY "animGroupName" 1.2 ] }
    , Cmd.none
    )

Set the initial Z scale.

import Anim.Engine.* as Engine
import Anim.Property.Scale as Scale


init : ( Model, Cmd Msg )
init =
    ( { animState = Engine.init [ Scale.initZ "animGroupName" 1.0 ] }
    , Cmd.none
    )

Turn the AnimBuilder into a scale animation Builder for the specified animation group.

Use this to start configuring a scale animation.

myAnimation : AnimBuilder eng -> AnimBuilder eng
myAnimation =
    Scale.begin
        >> ... -- Configure and build the animation

Complete the Builder animation configuration and return an AnimBuilder so you can continue configuring other property animations or execute the animation with an Engine.

myAnimation : AnimBuilder eng -> AnimBuilder eng
myAnimation =
    Scale.begin
        >> ... -- configure the animation with from, to, duration, easing, etc.
        >> Scale.end
        >> ... -- continue with animation

Set the starting scale (uniform across all axes).

myAnimation : AnimBuilder eng -> AnimBuilder eng
myAnimation =
    Scale.begin
        >> Scale.from 0.8
        >> ... -- continue with animation

This is equivalent to Scale.fromXYZ 0.8 0.8 0.8.

Set the starting X, Y, and Z scale.

myAnimation : AnimBuilder eng -> AnimBuilder eng
myAnimation =
    Scale.begin
        >> Scale.fromXYZ 0.8 1.2 0.9
        >> ... -- continue with animation

Set the starting X and Y scale. Z is left unchanged (or 1.0 if not set).

Set the starting X and Z scale. Y is left unchanged (or 1.0 if not set).

Set the starting X scale. Y and Z are left unchanged (or 1.0 if not set).

Set the starting Y and Z scale. X is left unchanged (or 1.0 if not set).

Set the starting Y scale. X and Z are left unchanged (or 1.0 if not set).

Set the starting Z scale. X and Y are left unchanged (or 1.0 if not set).

Set the target scale (uniform across all axes).

myAnimation : AnimBuilder eng -> AnimBuilder eng
myAnimation =
    Scale.begin
        >> Scale.to 1.5
        >> ... -- continue with animation

This is equivalent to toXYZ 1.5 1.5 1.5.

Set the target X, Y, and Z scale.

myAnimation : AnimBuilder eng -> AnimBuilder eng
myAnimation =
    Scale.begin
        >> Scale.toXYZ 1.5 2.0 0.8
        >> ... -- continue with animation

Set the target X and Y scale. Z is left unchanged (or 1.0 if not set).

Set the target X and Z scale. Y is left unchanged (or 1.0 if not set).

Set the target X scale. Y and Z are left unchanged (or 1.0 if not set).

Set the target Y and Z scale. X is left unchanged (or 1.0 if not set).

Set the target Y scale. X and Z are left unchanged (or 1.0 if not set).

Set the target Z scale. X and Y are left unchanged (or 1.0 if not set).

Move by a delta on the X, Y, and Z axes.

Move by a delta on the X and Y axes. Z is unaffected.

Move by a delta on the X and Z axes. Y is unaffected.

Move by a delta on the X axis. Y and Z are unaffected.

Move by a delta on the Y and Z axes. X is unaffected.

Move by a delta on the Y axis. X and Z are unaffected.

Move by a delta on the Z axis. X and Y are unaffected.

Set the delay (milliseconds) before the animation starts.

Set the animation duration (milliseconds).

The speed represents how much the scale factor changes per second.

For example, a scale animation from 1.0 to 5.0 with a speed of 2.0 will take 2 seconds to complete.

Set the easing function for the animation.

import Motion.Easing exposing (Easing(..))


Scale.easing EaseInOut

Drive this property with a spring.

import Motion.Spring as Spring


Scale.spring Spring.wobbly

A numeric range with min and max boundaries.

Per-axis resize ranges. Nothing leaves an axis untouched.

{ x = Just { min = 1, max = 2 }
, y = Nothing
, z = Nothing
}

Apply new scale bounds for an anim group during resize.

Pass this inside an engine's onResize builder:

Sub.onResize model.animState <|
    Scale.bounds "cube"
        { x = Just { min = 1, max = newWidth / cubeSize }
        , y = Just { min = 1, max = newHeight / cubeSize }
        , z = Nothing
        }

You can set the bounds for multiple anim groups in one call:

Sub.onResize model.animState <|
    Scale.bounds "box" boxBounds
        >> Scale.bounds "card" cardBounds

The engine proportionally remaps the in-flight animation onto the new range and pins its endpoints to it.

Only callable from inside an engine's onResize builder - calling it from anywhere else results in a type error.

Keep the X axis scale within min and max values. If min > max the values are flipped.

Keep the Y axis scale within min and max values. If min > max the values are flipped.

Keep the Z axis scale within min and max values. If min > max the values are flipped.

Remove the X axis range for this animation group. Does nothing if no range is set.

Remove the Y axis range for this animation group. Does nothing if no range is set.

Remove the Z axis range for this animation group. Does nothing if no range is set.

Snap to a uniform scale on all three axes silently, cancelling any in-flight animation on this property.

Snap target X, Y and Z scales.

Snap target X and Y scales, preserving the current Z scale.

Snap target X and Z scales, preserving the current Y scale.

Snap target X scale, preserving the current Y and Z scales.

Snap target Y and Z scales, preserving the current X scale.

Snap target Y scale, preserving the current X and Z scales.

Snap target Z scale, preserving the current X and Y scales.