| IAnimationServiceStartAnimation Method (ITimeline, IEnumerableIAnimatableObject, AnimationTransition) |
Starts an animation using a given transition and applies it to the specified objects.
Namespace: DigitalRune.AnimationAssembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax AnimationController StartAnimation(
ITimeline animation,
IEnumerable<IAnimatableObject> targetObjects,
AnimationTransition transition
)
Function StartAnimation (
animation As ITimeline,
targetObjects As IEnumerable(Of IAnimatableObject),
transition As AnimationTransition
) As AnimationController
AnimationController StartAnimation(
ITimeline^ animation,
IEnumerable<IAnimatableObject^>^ targetObjects,
AnimationTransition^ transition
)
abstract StartAnimation :
animation : ITimeline *
targetObjects : IEnumerable<IAnimatableObject> *
transition : AnimationTransition -> AnimationController
Parameters
- animation
- Type: DigitalRune.AnimationITimeline
The animation. - targetObjects
- Type: System.Collections.GenericIEnumerableIAnimatableObject
The target objects that should be animated. - transition
- Type: DigitalRune.Animation.TransitionsAnimationTransition
The transition that determines how the new animation is applied. The class
AnimationTransitions provides a set of predefined animation transitions.
Return Value
Type:
AnimationControllerThe
AnimationController.
Exceptions Remarks
The returned animation controller can be used to interactively control the animation.
If no AnimationTransition is specified explicitly, then
SnapshotAndReplace will be used.
Important: When animations are started or stopped the animations do not
take effect immediately. That means the new animation values are not immediately applied to
the properties that are being animated. The animations are evaluated when the animation
system is updated (see Update(TimeSpan)) and new animation values are
written when ApplyAnimations is called.
The method UpdateAndApply can be called to immediately
evaluate and apply the animation. But in most cases it is not necessary to call this method
explicitly.
See Also