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

interface IVectorConst in Tinman.Core.Collections

Base interface for classes that represent a read-only list of elements.

interface IVectorConst with <T>  
  extends IBagConst<T>
  IEquatable<IVectorConst<T>>
  base of IArrayVector
  IDeque
  IVector
  VectorConstBase

Attributes

Count

The number of elements in this collection.

property Count { get }
type int32
value [>=0] The number of elements.
inherited IBagConst.Count

Methods

Contains

Returns if this collection contains the given element.

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

ContainsAll

Returns if this collection contains all given elements.

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 IBagConst.ContainsAll

First

Returns the first enumerated value.

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

Exceptions:

GetAt

Returns the element at the given list index.

[Pure]
method GetAt (int32 index)
type T
params index [0..Count-1] The list index.
returns The element.

GetEnumerator

method GetEnumerator ()
type IEnumerator<T>
inherited IEnumerable.GetEnumerator

IndexOf

Returns the list index of the given element.

[Pure]
method IndexOf (T element)
type int32
params element The element.
returns The list index or -1 if the element is not contained in the list.

Last

Returns the last enumerated value.

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

Exceptions:

ToArray

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

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

ToArrayCopy

Returns the elements of this collection as an array.

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.
inherited IBagConst.ToArrayCopy

Remarks:

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