TimelineGroup Class

TimelineGroup Class

Organizes a group of animations which can be played simultaneously.

Inheritance Hierarchy

SystemObject
DigitalRune.AnimationTimelineGroup

Namespace: DigitalRune.Animation
Assembly: DigitalRune.Animation (in DigitalRune.Animation.dll) Version: 1.4.0.0 (1.4.1.14427)

Syntax

C++

Copy

public class TimelineGroup : ITimeline, 
	IList<ITimeline>, ICollection<ITimeline>, IEnumerable<ITimeline>, 
	IEnumerable

Public Class TimelineGroup
	Implements ITimeline, IList(Of ITimeline), 
	ICollection(Of ITimeline), IEnumerable(Of ITimeline), IEnumerable

public ref class TimelineGroup : ITimeline, 
	IList<ITimeline^>, ICollection<ITimeline^>, IEnumerable<ITimeline^>, 
	IEnumerable

type TimelineGroup =  
    class
        interface ITimeline
        interface IList<ITimeline>
        interface ICollection<ITimeline>
        interface IEnumerable<ITimeline>
        interface IEnumerable
    end

The TimelineGroup type exposes the following members.

Constructors

	Name	Description
	TimelineGroup	Initializes a new instance of the TimelineGroup class.

Top

Methods

	Name	Description
	Add	Adds a timeline to the TimelineGroup.
	Clear	Removes all timelines from the TimelineGroup.
	Contains	Determines whether the TimelineGroup contains a specific timeline.
	CreateInstance	Creates an animation instance that can be used to play back the animation. (For internal use only.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationTime	Gets the animation time for the specified time on the timeline.
	GetEnumerator	Returns an enumerator that iterates through the TimelineGroup.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetState	Gets the state of the animation for the specified time on the timeline.
	GetTotalDuration	Gets the total length of the timeline.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of a specific timeline in the TimelineGroup.
	Insert	Inserts a timeline into the TimelineGroup at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific timeline from the TimelineGroup.
	RemoveAt	Removes the timeline at the specified index from the TimelineGroup.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	AddRangeITimeline	Adds the specified items to the ICollectionT. (Defined by CollectionHelper.)
	DoITimeline(ActionITimeline)	Overloaded. Performs the given action on each element in a sequence when it is enumerated. (Defined by LinqHelper.)
	DoITimeline(ActionITimeline, Int32)	Overloaded. Performs the given action on each element (incorporating its index) in a sequence when it is enumerated. (Defined by LinqHelper.)
	ForEachITimeline(ActionITimeline)	Overloaded. Immediately performs the given action on each element in a sequence. (Defined by LinqHelper.)
	ForEachITimeline(ActionITimeline, Int32)	Overloaded. Immediately performs the given action on each element (incorporating its index) in a sequence. (Defined by LinqHelper.)
	IndexOfITimeline	Returns the index of the first element in a sequence that satisfies the specified condition. (Defined by LinqHelper.)

Top

Properties

	Name	Description
	Count	Gets the number of timelines contained in the TimelineGroup.
	FillBehavior	Gets or sets a value that specifies how the animation behaves when it reaches the end of its duration.
	Item	Gets or sets the timeline at the specified index.
	TargetObject	Gets or sets the object to which the animation is applied by default.

Top

Explicit Interface Implementations

	Name	Description
	ICollectionITimelineCopyTo	Copies the elements of the TimelineGroup to an Array, starting at a particular Array index.
	IEnumerableITimelineGetEnumerator	Returns an enumerator that iterates through the collection.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through the collection.
	ICollectionITimelineIsReadOnly	Gets a value indicating whether this collection is read-only.

Top

Remarks

Different animations can be grouped together to be executed simultaneously. The group of animations is sometimes called "storyboard".

Nested Timelines: Timeline groups can be nested. That means a TimelineGroup can contain other TimelineGroups.

Important: Animations must not be added or removed while the timeline group is playing!

Reference

DigitalRune.Animation Namespace