LayoutAnimation Class - Fuse Documentation

Jump to:
Table of Contents

Triggers when the layout of an element changes

When an Element has certain properties like Width, Height or Margin (collectively reffered to as "layout properties") changed or when its location in the visual tree changes, we can trigger a LayoutAnimation.

Calculating layout for a large UX-document can be quite costly. When animating layout properties with Change animators, we run the risk of forcing a new layout to be calculated each frame. This can very easily lead to frame drops.

The LayoutAnimation trigger can be used to make this more pleasant. For example, instead of animating the Width of an Element using Change, we can use Set and react to this change using a LayoutAnimation. Inside LayoutAnimation we specify how our element should move/resize from its previous position to its new position.

Example

This example shows three rectangles, a teal, a red and a blue one. If the red or blue rectangle is clucked, the Width and Alignment properties of the teal rectangle gets smoothly animated.

<StackPanel>
    <Rectangle ux:Name="panel" Width="100" Height="100" CornerRadius="5" Color="Teal" Alignment="Center">
        <LayoutAnimation>
            <Resize X="1" Y="1" RelativeTo="SizeChange" Duration="0.25"/>
            <Move X="1" Y="1" RelativeTo="PositionChange" Duration="0.25"/>
        </LayoutAnimation>
    </Rectangle>
    <Rectangle Color="Red" CornerRadius="5" Width="100" Height="50">
        <Clicked>
            <Set panel.Alignment="Left"/>
            <Set panel.Width="200"/>
        </Clicked>
    </Rectangle>
    <Rectangle Color="Blue" CornerRadius="5" Width="100" Height="50">
        <Clicked>
            <Set panel.Alignment="Right"/>
            <Set panel.Width="50"/>
        </Clicked>
    </Rectangle>
</StackPanel>

Location

Namespace: Fuse.Triggers
Package: Fuse.Elements 2.9.1

Show Uno properties and methods

Interface of LayoutAnimation

LayoutAnimation Constructor uno

Creates a new LayoutAnimation

Type : LayoutAnimationType ux

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.

BypassActivate uno

BypassDeactivate uno

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).

DirectActivate(Action) uno

DirectDeactivate uno

DirectSeek(double, AnimationVariant) uno

HasActions : bool uno

HasAnimators : bool uno

HasBackwardAnimation : bool uno

true if there is an explicit backward animation.

InversePulse uno

OnPlayStateChanged(TriggerPlayState) uno

OnProgressChanged 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.

Progress : double uno

The current progress of the trigger.

Pulse uno

Plays the trigger to progress 1 then back to 0.

PulseBackward uno

Plays the trigger starting at progress=1 down to 0.

RecreateAnimationState uno

RequireLayout(Visual) uno

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.

Name : Selector ux

Run-time name of the node. This property is automatically set using the ux:Name attribute.

NextSibling<T> : T uno

Returns the next sibling node of the given type.

OnDataChanged(string, object) uno

OnRooted uno

If you override OnRooted you must call base.OnRooted() first in your derived class. No other processing should happen first, otherwise you might end up in an undefined state.

OnUnrooted uno

Parent : Visual uno

The parent Visual of this node. Will return null if the node is not rooted.

PreviousSibling<T> : T uno