ImplicitAnimationCollection ImplicitAnimationCollection ImplicitAnimationCollection ImplicitAnimationCollection Class

Definition

A collection of animations triggered when a condition is met.

public : sealed class ImplicitAnimationCollection : CompositionObject, IIterable<IKeyValuePair<Platform::String, ICompositionAnimationBase>>, IMap<Platform::String, ICompositionAnimationBase>, IImplicitAnimationCollection
struct winrt::Windows::UI::Composition::ImplicitAnimationCollection : CompositionObject, IIterable<IKeyValuePair<Platform::String, ICompositionAnimationBase>>, IMap<Platform::String, ICompositionAnimationBase>, IImplicitAnimationCollection
public sealed class ImplicitAnimationCollection : CompositionObject, IEnumerable<KeyValuePair<String, ICompositionAnimationBase>>, IDictionary<String, ICompositionAnimationBase>, IImplicitAnimationCollection
Public NotInheritable Class ImplicitAnimationCollection Inherits CompositionObject Implements IEnumerable<KeyValuePair<String, ICompositionAnimationBase>>, IDictionary<String, ICompositionAnimationBase>, IImplicitAnimationCollection
Inheritance
ImplicitAnimationCollectionImplicitAnimationCollectionImplicitAnimationCollectionImplicitAnimationCollection
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Examples


class PropertyAnimation 
{ 
  PropertyAnimation(Compositor compositor, SpriteVisual heroVisual, SpriteVisual listVisual) 
  { 
    // Define ImplicitAnimationCollection 
    ImplicitAnimationCollection implicitAnimations = compositor.CreateImplicitAnimationCollection(); 

    // Trigger animation when the “Offset” property changes. 
    implicitAnimations["Offset"] = CreateAnimation(compositor); 

    // Assign ImplicitAnimations to a visual. Unlike Visual.Children,     
    // ImplicitAnimations can be shared by multiple visuals so that they  
    // share the same implicit animation behavior (same as Visual.Clip). 
    heroVisual.ImplicitAnimations = implicitAnimations; 

    // ImplicitAnimations can be shared among visuals  
    listVisual.ImplicitAnimations = implicitAnimations; 

    listVisual.Offset = new Vector3(20f, 20f, 20f); 
  } 

  Vector3KeyFrameAnimation CreateAnimation(Compositor compositor) 
  { 
    Vector3KeyFrameAnimation animation = compositor.CreateVector3KeyFrameAnimation(); 
    animation.InsertExpressionKeyFrame(0f, "this.StartingValue"); 
    animation.InsertExpressionKeyFrame(1f, "this.FinalValue"); 
    animation.Target = “Offset”; 
    animation.Duration = TimeSpan.FromSeconds(0.25); 
    return animation; 
  } 
} 

Remarks

Implicit animations let you drive animations by specifying trigger conditions rather than requiring the manual definition of animation behavior. They help decouple animation start logic from core app logic. You define animations and the events that should trigger these animations. The compositor then executes the set animations when the appropriate trigger conditions are met.

Triggers

Condition act as triggers for ImplicitAnimationCollection. These triggers are CompositionObject animatable properties. For Windows 10 Anniversary Update only Visual animatable properties are supported as triggers.

this.FinalValue

This is a special keyword within “Composition Expressions system” that developers can use to template their animations and let the platform bind it to the target property’s API value.

Animations will support this.FinalValue keyword as a valid keyword to signify the final value of a target property for an animation.

  • Implicit Animations – The this.FinalValue will be set to the last value that the corresponding target property was directly assigned to. For instance, when the visual’s Offset property is directly assigned to, implicit animations that target the Offset property will have this.FinalValue set to the new Offset value, of type Vector3. Other implicit animations that target different properties, say Size , will still be able to use the this.FinalValue in the template, and in that case this.FinalValue will be set to the current value of the Size property, of type Vector2. Note that in the latter case this.FinalValue will be the same as this.StartingValue . This provides a well-defined behavior and makes it easy for the developers to author the animation templates as this.FinalValue will always be resolved to a valid value, regardless of which property has triggered the change.
  • Explicit Animations: By default it will have the same behavior as the implicit animation’s case, where this.FinalValue will be set to the last value that the property was directly set to. For example, animations that target the Size property will have this.FinalValue resolved to the last known Size value on the API layer. In other words, this.FinalValue will be the same as this.StartingValue . The developer will be able to override that behavior and set this.FinalValue to a different value by setting it as an animation parameter explicitly.

Events and target properties for ImplicitAnimationCollection and CompositionAnimationGroup

ImplicitAnimationCollection lets you add triggers which implicit animation will monitor for changes and kick off related animations as provided by the developer. ImplicitAnimationCollection supports all Visual animatable properties which are also used as target properties for animations. Target has to be defined on the animation or it will throw an exception.


implicitAnimationCollection[“Offset”] = offsetAnimationGroup;            

CompositionAnimationGroup contains a list of CompositionAnimation where they can be triggered as a single logical unit. Each CompositionAnimation in the group should have the target property set.


CompositionAnimationGroup.Add(opacityKeyFrameAnimation);
CompositionAnimationGroup.Insert(sizeKeyFrameAnimation);

ImplicitAnimationCollection supports the following properties on Visual:

Properties

Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
Item[TKey] Item[TKey] Item[TKey] Item[TKey]

Gets or sets the element with the specified key.

Keys Keys Keys Keys

Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2.

Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
Size Size Size Size

The size of the collection.

Values Values Values Values

Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2.

Methods

Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.

Clear() Clear() Clear() Clear()

Removes all animations from the collection.

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey)

Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.

First() First() First() First()

Retrieves the first animation in the collection.

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

GetView() GetView() GetView() GetView()

Returns a map view of the collection.

HasKey(String) HasKey(String) HasKey(String) HasKey(String)

Returns a boolean indicating whether the collection contains the specified key.

Insert(String, ICompositionAnimationBase) Insert(String, ICompositionAnimationBase) Insert(String, ICompositionAnimationBase) Insert(String, ICompositionAnimationBase)

Inserts an animation into the collection.

Lookup(String) Lookup(String) Lookup(String) Lookup(String)

Retrieves the animation associated with the specified property.

Remove(String) Remove(String) Remove(String) Remove(String)

Removes the specified animation from the collection.

Remove(T) Remove(T) Remove(T) Remove(T)

Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.

StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

(Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Starts an animation group.

The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

(Inherited from CompositionObject)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

Prerelease. Returns an AnimationController for the animation running on the specified property.

(Inherited from CompositionObject)
TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue)

Gets the value associated with the specified key.

See Also