StateCollection Class

Manages a collection of States.

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionState
    System.Collections.ObjectModelKeyedCollectionString, State
      DigitalRune.CollectionsNamedObjectCollectionState
        DigitalRune.Game.StatesStateCollection

Namespace: DigitalRune.Game.States
Assembly: DigitalRune.Game (in DigitalRune.Game.dll) Version: 1.4.0.0 (1.4.0.14427)

Syntax

C++

Copy

public class StateCollection : NamedObjectCollection<State>

Public Class StateCollection
	Inherits NamedObjectCollection(Of State)

public ref class StateCollection : public NamedObjectCollection<State^>

type StateCollection =  
    class
        inherit NamedObjectCollection<State>
    end

The StateCollection type exposes the following members.

Constructors

	Name	Description
	StateCollection	Initializes a new instance of the StateCollection class.

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionState.)
	AddRange	Adds the elements of the specified collection to the end of the NamedObjectCollectionT. (Inherited from NamedObjectCollectionT.)
	ChangeItemKey	Changes the key associated with the specified element in the lookup dictionary. (Inherited from KeyedCollectionString, State.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionState.)
	ClearItems	Removes all elements from the CollectionT. (Overrides NamedObjectCollectionTClearItems.)
	Contains(TKey)	Determines whether the collection contains an element with the specified key. (Inherited from KeyedCollectionString, State.)
	Contains(T)	Determines whether an element is in the CollectionT. (Inherited from CollectionState.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionState.)
	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 StateCollection.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetKeyForItem	When implemented in a derived class, extracts the key from the specified element. (Inherited from NamedObjectCollectionT.)
	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 CollectionState.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionState.)
	InsertItem	Inserts an element into the CollectionT at the specified index. (Overrides NamedObjectCollectionTInsertItem(Int32, T).)
	InsertRange	Inserts the elements of a collection into the NamedObjectCollectionT at the specified index. (Inherited from NamedObjectCollectionT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Move	Moves the item at the specified index to a new location in the collection. (Inherited from NamedObjectCollectionT.)
	MoveItem	Moves the item at the specified index to a new location in the collection. (Inherited from NamedObjectCollectionT.)
	OnCollectionChanged	Raises the CollectionChanged event. (Inherited from NamedObjectCollectionT.)
	Remove(TKey)	Removes the element with the specified key from the KeyedCollectionTKey, TItem. (Inherited from KeyedCollectionString, State.)
	Remove(T)	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionState.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionState.)
	RemoveItem	Removes the element at the specified index of the CollectionT. (Overrides NamedObjectCollectionTRemoveItem(Int32).)
	RemoveRange	Removes a range of elements from the NamedObjectCollectionT. (Inherited from NamedObjectCollectionT.)
	SetItem	Replaces the element at the specified index. (Overrides NamedObjectCollectionTSetItem(Int32, T).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGet(String, T)	Gets the object associated with the specified key. (Inherited from NamedObjectCollectionT.)

Top

Properties

	Name	Description
	ActiveState	Gets the active state.
	Comparer	Gets the generic equality comparer that is used to determine equality of keys in the collection. (Inherited from KeyedCollectionString, State.)
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionState.)
	Dictionary	Gets the lookup dictionary of the KeyedCollectionTKey, TItem. (Inherited from KeyedCollectionString, State.)
	FinalState	Gets or sets the final state.
	InitialState	Gets or sets the initial state.
	ItemTKey	Gets the element with the specified key. (Inherited from KeyedCollectionString, State.)
	ItemInt32	Gets or sets the element at the specified index. (Inherited from CollectionState.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionState.)
	Owner	Gets the state that owns this state collection.
	SaveHistory	Gets or sets a value indicating whether this state collection has a "history state".

Top

Events

	Name	Description
	CollectionChanged	Occurs when items were added, replaced or removed. (Inherited from NamedObjectCollectionT.)

Top

Explicit Interface Implementations

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

Top

Remarks

items or duplicate items are not allowed in this collection. The collection has a few special state references: InitialState, FinalState, and ActiveState. These references must refer to states contained in the collection. If a referenced state is removed from the collection the reference is set to .

Reference

DigitalRune.Game.States Namespace