Class AnimationCollection

Namespace

Lime

Assembly

Lime.dll

public sealed class AnimationCollection : IList<Animation>, ICollection<Animation>, IEnumerable<Animation>, IList, ICollection, IEnumerable

Inheritance

object

AnimationCollection

Implements

IList<Animation>

ICollection<Animation>

IEnumerable<Animation>

IList

ICollection

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Mathf.RandomItem<T>(ICollection<T>)

LinqExtensions.Distinct<TSource>(IEnumerable<TSource>, Func<TSource, TSource, bool>)

LinqExtensions.Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>, Func<TSource, TSource, bool>)

LinqExtensions.Intersect<T>(IEnumerable<T>, IEnumerable<T>, Func<T, T, bool>)

Mathf.Shuffle<T>(IEnumerable<T>, IRandom)

Mathf.Shuffle<T>(IEnumerable<T>, Random)

Constructors

AnimationCollection(AnimationComponent)

public AnimationCollection(AnimationComponent owner)

Parameters

owner AnimationComponent

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

this[int]

Gets or sets the element at the specified index.

public Animation this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

Animation

The element at the specified index.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The property is set and the IList<T> is read-only.

Methods

Add(Animation)

Adds an item to the ICollection<T>.

public void Add(Animation item)

Parameters

item Animation

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

AddRange(IEnumerable<Animation>)

public void AddRange(IEnumerable<Animation> collection)

Parameters

collection IEnumerable<Animation>

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(Animation)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(Animation item)

Parameters

item Animation

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(Animation[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(Animation[] array, int arrayIndex)

Parameters

array Animation[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

Find(string)

public Animation Find(string id)

Parameters

id string

Returns

Animation

GetEnumerator()

public List<Animation>.Enumerator GetEnumerator()

Returns

List<Animation>.Enumerator

IndexOf(Animation)

Determines the index of a specific item in the IList<T>.

public int IndexOf(Animation item)

Parameters

item Animation

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, Animation)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, Animation item)

Parameters

index int

The zero-based index at which item should be inserted.

item Animation

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Remove(Animation)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(Animation item)

Parameters

item Animation

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

RemoveAt(int)

Removes the IList<T> item at the specified index.

public void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Run(string, string)

public Animation Run(string animationId, string markerId = null)

Parameters

animationId string

markerId string

Returns

Animation

TryFind(int, out Animation)

public bool TryFind(int idComparisonCode, out Animation animation)

Parameters

idComparisonCode int

animation Animation

Returns

bool

TryFind(string, out Animation)

public bool TryFind(string id, out Animation animation)

Parameters

id string

animation Animation

Returns

bool

TryRun(string, string, double)

public bool TryRun(string animationId, string markerId = null, double animationTimeCorrection = 0)

Parameters

animationId string

markerId string

animationTimeCorrection double

Returns

bool