Class AnimationController | UIWidgets | 1.5.4-preview.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class AnimationController

    Inheritance
    Object
    Animation<Single>
    AnimationEagerListenerMixinAnimation<Single>
    AnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>
    AnimationLocalStatusListenersMixinAnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>
    AnimationController
    Inherited Members
    AnimationLocalStatusListenersMixinAnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>.addStatusListener(AnimationStatusListener)
    AnimationLocalStatusListenersMixinAnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>.removeStatusListener(AnimationStatusListener)
    AnimationLocalStatusListenersMixinAnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>.notifyStatusListeners(AnimationStatus)
    AnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>.addListener(VoidCallback)
    AnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>.removeListener(VoidCallback)
    AnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<Single>.notifyListeners()
    AnimationEagerListenerMixinAnimation<Single>.didRegisterListener()
    AnimationEagerListenerMixinAnimation<Single>.didUnregisterListener()
    Animation<Single>.isDismissed
    Animation<Single>.isCompleted
    Animation<Single>.ToString()
    Animation<Single>.drive<U>(Animatable<U>)
    Namespace: Unity.UIWidgets.animation
    Syntax
    public class AnimationController : AnimationLocalStatusListenersMixinAnimationLocalListenersMixinAnimationEagerListenerMixinAnimation<float>, ValueListenable<float>, Listenable

    Constructors

    AnimationController(Nullable<Single>, Nullable<TimeSpan>, String, Single, Single, TickerProvider)

    Declaration
    public AnimationController(float? value = default(float? ), TimeSpan? duration = default(TimeSpan? ), string debugLabel = null, float lowerBound = 0F, float upperBound = 1F, TickerProvider vsync = null)
    Parameters
    Type Name Description
    Nullable<Single> value
    Nullable<TimeSpan> duration
    String debugLabel
    Single lowerBound
    Single upperBound
    TickerProvider vsync

    Fields

    debugLabel

    Declaration
    public readonly string debugLabel
    Field Value
    Type Description
    String

    duration

    Declaration
    public TimeSpan? duration
    Field Value
    Type Description
    Nullable<TimeSpan>

    lowerBound

    Declaration
    public readonly float lowerBound
    Field Value
    Type Description
    Single

    upperBound

    Declaration
    public readonly float upperBound
    Field Value
    Type Description
    Single

    Properties

    isAnimating

    Declaration
    public bool isAnimating { get; }
    Property Value
    Type Description
    Boolean

    status

    Declaration
    public override AnimationStatus status { get; }
    Property Value
    Type Description
    AnimationStatus
    Overrides
    Unity.UIWidgets.animation.Animation<System.Single>.status

    value

    Declaration
    public override float value { get; }
    Property Value
    Type Description
    Single
    Overrides
    Unity.UIWidgets.animation.Animation<System.Single>.value

    velocity

    Declaration
    public float velocity { get; }
    Property Value
    Type Description
    Single

    view

    Declaration
    public Animation<float> view { get; }
    Property Value
    Type Description
    Animation<Single>

    Methods

    animateBack(Single, Nullable<TimeSpan>, Curve)

    Declaration
    public TickerFuture animateBack(float target, TimeSpan? duration, Curve curve = null)
    Parameters
    Type Name Description
    Single target
    Nullable<TimeSpan> duration
    Curve curve
    Returns
    Type Description
    TickerFuture

    animateTo(Single, Nullable<TimeSpan>, Curve)

    Declaration
    public TickerFuture animateTo(float target, TimeSpan? duration = default(TimeSpan? ), Curve curve = null)
    Parameters
    Type Name Description
    Single target
    Nullable<TimeSpan> duration
    Curve curve
    Returns
    Type Description
    TickerFuture

    animateWith(Simulation)

    Declaration
    public TickerFuture animateWith(Simulation simulation)
    Parameters
    Type Name Description
    Simulation simulation
    Returns
    Type Description
    TickerFuture

    dispose()

    Declaration
    public override void dispose()
    Overrides
    Unity.UIWidgets.animation.AnimationEagerListenerMixinAnimation<System.Single>.dispose()

    fling(Single)

    Declaration
    public TickerFuture fling(float velocity = 1F)
    Parameters
    Type Name Description
    Single velocity
    Returns
    Type Description
    TickerFuture

    forward(Nullable<Single>)

    Declaration
    public TickerFuture forward(float? from = default(float? ))
    Parameters
    Type Name Description
    Nullable<Single> from
    Returns
    Type Description
    TickerFuture

    repeat(Nullable<Single>, Nullable<Single>, Boolean, Nullable<TimeSpan>)

    Declaration
    public TickerFuture repeat(float? min = default(float? ), float? max = default(float? ), bool reverse = false, TimeSpan? period = default(TimeSpan? ))
    Parameters
    Type Name Description
    Nullable<Single> min
    Nullable<Single> max
    Boolean reverse
    Nullable<TimeSpan> period
    Returns
    Type Description
    TickerFuture

    reset()

    Declaration
    public void reset()

    resync(TickerProvider)

    Declaration
    public void resync(TickerProvider vsync)
    Parameters
    Type Name Description
    TickerProvider vsync

    reverse(Nullable<Single>)

    Declaration
    public TickerFuture reverse(float? from = default(float? ))
    Parameters
    Type Name Description
    Nullable<Single> from
    Returns
    Type Description
    TickerFuture

    setValue(Single)

    Declaration
    public void setValue(float newValue)
    Parameters
    Type Name Description
    Single newValue

    stop(Boolean)

    Declaration
    public void stop(bool canceled = true)
    Parameters
    Type Name Description
    Boolean canceled

    toStringDetails()

    Declaration
    public override string toStringDetails()
    Returns
    Type Description
    String
    Overrides
    Unity.UIWidgets.animation.Animation<System.Single>.toStringDetails()

    unbounded(Single, Nullable<TimeSpan>, String, TickerProvider)

    Declaration
    public static AnimationController unbounded(float value = 0F, TimeSpan? duration = default(TimeSpan? ), string debugLabel = null, TickerProvider vsync = null)
    Parameters
    Type Name Description
    Single value
    Nullable<TimeSpan> duration
    String debugLabel
    TickerProvider vsync
    Returns
    Type Description
    AnimationController
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023