TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class ListSet in Tinman.Core.Collections

An IBag implementation that keeps the order in which elements have been added.

sealed class ListSet with <T>  
  extends BagBase<T>

Public / Attributes

Count

The number of elements in this collection.

public override property Count { get }
type int32
value [>=0] The number of elements.
implements BagConstBase.Count

Public / Constructors

ListSet

public constructor ListSet (EqualsDelegate<T> equals = null)
params equals

Public / Methods

Add

Adds the given element to this collection.

public override method Add (T element)
type bool
params element The element to add.
returns true if the collection has changed, false if not.
implements BagBase.Add

Remarks:

Implementing methods shall return false iff the element has already been collected, i.e. it is contained in the collection. If in doubt, return true.

AddAll

Adds the given elements to this collection.

public method AddAll (IEnumerable<T> elements)
type bool
params elements [not-null] The elements to add.
returns true if the collection has changed, false if not.
inherited BagBase.AddAll

Adds the given elements to this collection.

public virtual method AddAll (T[] elements, int32 first = 0, int32 count = -1)
type bool
params elements [not-null] The elements to add.
  first [>=0] Index of first element to add.
  count [>=-1] Number of elements to add. If -1 all elements from first to the last element are added.
returns true if the collection has changed, false if not.
inherited BagBase.AddAll

Clear

Removes all elements from this collection.

public override method Clear ()
implements BagBase.Clear

Contains

Returns if this collection contains the given element.

[Pure]
public override method Contains (T element)
type bool
params element The element.
returns true if element is contained in this collection, false if not.
implements BagConstBase.Contains

ContainsAll

Returns if this collection contains all given elements.

public method ContainsAll (IEnumerable<T> elements)
type bool
params elements [not-null] The elements.
returns true if all elements are contained in this collection, false if not.
inherited BagConstBase.ContainsAll

First

Returns the first enumerated value.

[Pure]
public virtual method First ()
type T
returns The first enumerated value.
inherited BagConstBase.First

Exceptions:

GetEnumerator

public override method GetEnumerator ()
type IEnumerator<T>
implements EnumerableBase.GetEnumerator

Last

Returns the last enumerated value.

[Pure]
public virtual method Last ()
type T
returns The last enumerated value.
inherited BagConstBase.Last

Exceptions:

Remove

Removes the given element from this collection.

public override method Remove (T element)
type bool
params element The element to remove.
returns true if the collection has changed, false if not.
implements BagBase.Remove

RemoveAll

Removes the given elements from this collection.

public method RemoveAll (IEnumerable<T> elements)
type bool
params elements [not-null] The elements to remove.
returns true if the collection has changed, false if not.
inherited BagBase.RemoveAll

RemoveWhere

Removes all elements from this collection for which the given predicate evaluates to true.

public virtual method RemoveWhere (PredicateDelegate<T> predicate)
type bool
params predicate [not-null] The predicate to use.
returns true if the collection has changed, false if not.
inherited BagBase.RemoveWhere

ToArray

Returns the elements of this enumerable object as a fresh array.

[Pure]
public method ToArray ()
type T[]
returns [not-null] The array of elements.
inherited BagConstBase.ToArray

ToArrayCopy

Returns the elements of this collection as an array.

public override method ToArrayCopy (T[] array, int32 offset = 0)
type T[]
params array [not-null] The output array.
  offset [>=0] Offset into array. Defaults to 0.
returns [not-null] The filled array.
implements BagConstBase.ToArrayCopy

Remarks:

The elements in this collection will be copied into the given array, starting at the array index specified by offset.

ToArrayList

Returns the elements of this enumerable object as a list.

[Pure]
public virtual method ToArrayList ()
type IArrayVector<T>
returns [not-null] The list of elements.
inherited BagConstBase.ToArrayList

ToList

Returns the elements of this enumerable object as a list.

[Pure]
public virtual method ToList ()
type IVectorConst<T>
returns [not-null] The list of elements.
inherited BagConstBase.ToList