KeyFrameCollection(T) Class

KeyFrameCollection<T> Class

Manages a collection of key frames.

Inheritance Hierarchy

System.Object
System.Collections.ObjectModel.Collection<IKeyFrame<T>>
DigitalRune.Animation.KeyFrameCollection<T>

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

Syntax

C++

Copy

public class KeyFrameCollection<T> : Collection<IKeyFrame<T>>

Public Class KeyFrameCollection(Of T)
	Inherits Collection(Of IKeyFrame(Of T))

generic<typename T>
public ref class KeyFrameCollection : public Collection<IKeyFrame<T>^>

type KeyFrameCollection<'T> =  
    class
        inherit Collection<IKeyFrame<'T>>
    end

Type Parameters

T: The type of the animation value.

The KeyFrameCollection< T> type exposes the following members.

Constructors

	Name	Description
	KeyFrameCollection<T>	Initializes a new instance of the KeyFrameCollection< T> class

Top

Methods

	Name	Description
	Add	Adds an object to the end of the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	Clear	Removes all elements from the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	ClearItems	Removes all elements from the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	Contains	Determines whether an element is in the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	CopyTo	Copies the entire Collection< T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<IKeyFrame<T>>.)
	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.)
	GetEnumerator	Returns an enumerator that iterates through the KeyFrameCollection<T>.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	Insert	Inserts an element into the Collection< T> at the specified index. (Inherited from Collection<IKeyFrame<T>>.)
	InsertItem	Inserts an element into the Collection< T> at the specified index. (Inherited from Collection<IKeyFrame<T>>.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	RemoveAt	Removes the element at the specified index of the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	RemoveItem	Removes the element at the specified index of the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	SetItem	Replaces the element at the specified index. (Inherited from Collection<IKeyFrame<T>>.)
	Sort	Sorts the key frames in the collection by their time value.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Count	Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)
	Item	Gets or sets the element at the specified index. (Inherited from Collection<IKeyFrame<T>>.)
	Items	Gets a IList< T> wrapper around the Collection<T>. (Inherited from Collection<IKeyFrame<T>>.)

Top

Explicit Interface Implementations

	Name	Description
	IList.Add	Adds an item to the IList. (Inherited from Collection<IKeyFrame<T>>.)
	IList.Contains	Determines whether the IList contains a specific value. (Inherited from Collection<IKeyFrame<T>>.)
	ICollection.CopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<IKeyFrame<T>>.)
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from Collection<IKeyFrame<T>>.)
	IList.IndexOf	Determines the index of a specific item in the IList. (Inherited from Collection<IKeyFrame<T>>.)
	IList.Insert	Inserts an item into the IList at the specified index. (Inherited from Collection<IKeyFrame<T>>.)
	IList.IsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<IKeyFrame<T>>.)
	ICollection<T>.IsReadOnly	Gets a value indicating whether the ICollection< T> is read-only. (Inherited from Collection<IKeyFrame<T>>.)
	IList.IsReadOnly	Gets a value indicating whether the IList is read-only. (Inherited from Collection<IKeyFrame<T>>.)
	ICollection.IsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<IKeyFrame<T>>.)
	IList.Item	Gets or sets the element at the specified index. (Inherited from Collection<IKeyFrame<T>>.)
	IList.Remove	Removes the first occurrence of a specific object from the IList. (Inherited from Collection<IKeyFrame<T>>.)
	ICollection.SyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<IKeyFrame<T>>.)

Top

Remarks

Important: The KeyFrameAnimation< T> expects that the key frames are sorted by their time. But the KeyFrameCollection< T> does not automatically order the key frames. The method Sort() needs to be called if key frames are added in the wrong order!

Reference

DigitalRune.Animation Namespace