Timeline Class - Fuse Documentation

Jump to:
Table of Contents

Groups several animations together

This allows for a nice way of grouping several animations together and separating them from the interaction logic.

A Timeline can be played by animating its TargetProgress property between 0 and 1.

Note: Timeline itself is not intended for grouping multiple animators to create keyframe animations. To achieve this, you can add Keyframes to the animators themselves.

Incorrect:
<Timeline>
    <Change rect.Opacity="1" Delay="0.0" Duration="0.5" />
    <Change rect.Opacity="0" Delay="0.5" Duration="0.5" />
</Timeline>
Correct:
<Timeline>
    <Change Target="rect.Opacity">
        <Keyframe Value="1" Time="0.5" />
        <Keyframe Value="0" Time="1.0" />
    </Change>
</Timeline>

Example

Here is an example of how we can use a timeline to animate several properties on a rectangle (its width and color), and then play between the start and end of this Timeline by clicking two buttons.

<StackPanel>
    <Rectangle ux:Name="rect" Height="40" Width="100%">
        <SolidColor ux:Name="color" Color="#f00" />
    </Rectangle>
    <Grid ColumnCount="2">
        <Button Text="Red">
            <Clicked>
                <Set timeline.TargetProgress="0" />
            </Clicked>
        </Button>
        <Button Text="Green">
            <Clicked>
                <Set timeline.TargetProgress="1" />
            </Clicked>
        </Button>
    </Grid>

    <Timeline ux:Name="timeline">
        <Change Target="rect.Width">
            <Keyframe Value="10" Time="0.3"/>
            <Keyframe Value="100" Time="0.6"/>
        </Change>
        <Change color.Color="#0f0" Duration="0.3" Delay="0.3"/>
    </Timeline>
</StackPanel>

Location

Namespace: Fuse.Triggers
Package: Fuse.Triggers 2.9.1

Show Uno properties and methods

Interface of Timeline

InitialProgress : double ux

Progress which the Timeline should start playing from

OnAtZero : bool ux

Makes triggers active when progress is 0 if true

Pause uno

Stops the playback at the current progress. Unlike Stop this does not adjust the TargetProgress, a Resume can continue playing to the previous target.

pause() js

Pauses playback at the current progress. Call resume to continue playing.

PlayMode : PlayMode ux

Sets the behavior of the Timeline once the end has been reached.

playTo(progress) js

Plays to a particular progress in the Timeline. This plays from the current progress to the new target progress.

ProgressChanged : ValueChangedHandler<double> (object, ValueChangedArgs<double>) ux

pulse() js

Pulses the Timeline (plays to end and back to start).

pulseBackward() js

Pulses the Timeline backward (seeks to end then plays backward to start)

pulseForward() js

Pulses the Timeline forward (plays to the end and deactivates).

resume() js

Resumes playback from the current progress to the target progress. Call this after a pause to resume playback.

seek(progress) js

Seeks to a given location (jumps there without playing the intervening animation).

SetProgress(double, IPropertyListener) uno

Stop uno

Stops the playback at the current progress. Sets the TargetProgress to this new progress.

stop() js

Stops playback. This sets the target progress to the current location such that resume will not keep playing.

Inherited from Trigger

Actions : IList of TriggerAction ux

A list of actions that execute with the trigger. These may react on simple direction changes, or at specific time offsets.

Activate(Action) uno

Activates the trigger (target progress of 1).

Animators : IList of Animator ux

BackwardAnimation : TriggerAnimation ux

Specifies an explicit backward animation instead of using the implied backward animation of the animators involved. Be aware that actions are not part of the animation.

Bypass : TriggerBypassMode ux

Specifies how changes in state are handled while initializing and rooting the trigger.

BypassSeek(double, AnimationVariant) uno

CrossFadeDuration : double ux

If there is a transition between forward/backward playback and two timeilnes are being used (implicit or explicit) this specifies the cross-fade time.

Deactivate uno

Deactivates the trigger (target progress of 0).

DirectSeek(double, AnimationVariant) uno

HasBackwardAnimation : bool uno

true if there is an explicit backward animation.

OnPlayStateChanged(TriggerPlayState) uno

PlayEnd(bool, Action) uno

Play the trigger from where it currently is to the end.

PlayTo(double, AnimationVariant) uno

Plays to a specific progress with the given animation variant.

Indicates the trigger is bound to the layout of a visual. This will keep the trigger in Bypass mode until after the first layout of the element is obtained. This is required since layout does not happen in the same root grouping/update phase as the creation of the element, yet not having a layout should qualify as part of the rooting period.

Seek(double, AnimationVariant) uno

Seeks to a specific progress with the given animation variant.

Start uno

Stop(bool) uno

StretchDuration : double ux

Stretches the duration of the animation to fill up this period of time.

TimeMultiplier : double ux

Specifies a multiplier to the elapsed time for animation playback.

Inherited from NodeGroupBase

FindTemplate(string) : Template uno

Nodes : IList of Node ux

Nodes to add to the Parent when this trigger is any non-deactivated state (Progress > 0)

OnNodeAdded(Node) uno

OnNodeRemoved(Node) uno

Resources : IList of Resource ux

Templates : IList of Template ux

Inherited from Node

Add(Binding) uno

Bindings : IList of Binding ux

The list of bindings belonging to this node.

ContextParent : Node uno

The context parent is the semantic parent of this node. It is where non-UI structure should be resolved, like looking for the DataContext, a Navigation, or other semantic item.

FindByType<T> : T uno

FindNodeByName(Selector, Predicate<Node> (Node)) : Node uno

Finds the first node with a given name that satisfies the given acceptor. The serach algorithm works as follows: Nodes in the subtree are matched first, then it matches the nodes in the subtrees ofthe ancestor nodes by turn all the way to the root. If no matching node is found, the function returns null.

GetNearestAncestorOfType<T> : T uno

Insert(int, Binding) uno

IsRootingCompleted : bool uno

Whether rooting for this node is completed. Returns false if unrooting has started.

IsRootingStarted : bool uno

Whether rooting of this node has started. Note that even if this property returns true, rooting may not yet be completed for the node. See also IsRootingCompleted.