KeyFrameCollection(T) Class

KeyFrameCollectionT Class

Manages a collection of key frames.

Inheritance Hierarchy

SystemObject
System.Collections.ObjectModelCollectionIKeyFrameT
DigitalRune.AnimationKeyFrameCollectionT

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 KeyFrameCollectionT type exposes the following members.

Constructors

	Name	Description
	KeyFrameCollectionT	Initializes a new instance of the KeyFrameCollectionT class

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionIKeyFrameT.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionIKeyFrameT.)
	ClearItems	Removes all elements from the CollectionT. (Inherited from CollectionIKeyFrameT.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionIKeyFrameT.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionIKeyFrameT.)
	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 KeyFrameCollectionT.
	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 CollectionT. (Inherited from CollectionIKeyFrameT.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionIKeyFrameT.)
	InsertItem	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionIKeyFrameT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionIKeyFrameT.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionIKeyFrameT.)
	RemoveItem	Removes the element at the specified index of the CollectionT. (Inherited from CollectionIKeyFrameT.)
	SetItem	Replaces the element at the specified index. (Inherited from CollectionIKeyFrameT.)
	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 CollectionT. (Inherited from CollectionIKeyFrameT.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionIKeyFrameT.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionIKeyFrameT.)

Top

Explicit Interface Implementations

	Name	Description
	IListAdd	Adds an item to the IList. (Inherited from CollectionIKeyFrameT.)
	IListContains	Determines whether the IList contains a specific value. (Inherited from CollectionIKeyFrameT.)
	ICollectionCopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from CollectionIKeyFrameT.)
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from CollectionIKeyFrameT.)
	IListIndexOf	Determines the index of a specific item in the IList. (Inherited from CollectionIKeyFrameT.)
	IListInsert	Inserts an item into the IList at the specified index. (Inherited from CollectionIKeyFrameT.)
	IListIsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from CollectionIKeyFrameT.)
	ICollectionTIsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from CollectionIKeyFrameT.)
	IListIsReadOnly	Gets a value indicating whether the IList is read-only. (Inherited from CollectionIKeyFrameT.)
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from CollectionIKeyFrameT.)
	IListItem	Gets or sets the element at the specified index. (Inherited from CollectionIKeyFrameT.)
	IListRemove	Removes the first occurrence of a specific object from the IList. (Inherited from CollectionIKeyFrameT.)
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from CollectionIKeyFrameT.)

Top

Remarks

Important: The KeyFrameAnimationT expects that the key frames are sorted by their time. But the KeyFrameCollectionT 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