DirectOutput
DirectOutput framework R3 for virtual pinball cabinets.
Loading...
Searching...
No Matches
DirectOutput.FX.EffectList Class Reference

Collection of IEffect objects. Every object can only exist once in the list and every objects needs to have a unique name. More...

Inheritance diagram for DirectOutput.FX.EffectList:
Collaboration diagram for DirectOutput.FX.EffectList:

Public Member Functions

void WriteXml (XmlWriter writer)
 Serializes the IEffect objects in this list to Xml. IEffect objects are serialized as the contained objects. The enclosing tags represent the object type WriteXml is part of the IXmlSerializable interface.
void ReadXml (XmlReader reader)
 Deserializes the IEffect objects in the XmlReader The IEffect objects are deserialized using the object name in the enclosing tags. ReadXml is part of the IXmlSerializable interface.
System.Xml.Schema.XmlSchema GetSchema ()
 Method is required by the IXmlSerializable interface.
void Finish ()
 Calls Finish on all IEffect objects in the list.
void Init (Table.Table Table)
 Calls Init on all IEffect objects in the list.
 EffectList ()
 Initializes a new instance of the EffectList class.
Public Member Functions inherited from DirectOutput.General.Generic.NamedItemList< T >
bool Contains (string Name)
 Checks if a INamedItem object with the specified name exists in the list.
new void Sort ()
 Sorts the NamedItemList by the Name of the items.
 NamedItemList ()
 Initializes a new instance of the NamedItemList<T> class.
 NamedItemList (IEnumerable< T > EnumerableList)
 Initializes a new instance of the NamedItemList<T> class.
Public Member Functions inherited from DirectOutput.General.Generic.ExtList< T >
int IndexOf (T Item)
 Determines the index of a specific item.
void CopyTo (T[] Array, int ArrayIndex)
 Copies the elements of the ExtList to an Array, starting at a particular Array index.
IEnumerator< T > GetEnumerator ()
 Returns an enumerator that iterates through a ExtList.
void Add (T NewListItem)
 Adds a new item to the ExtList.
void AddRange (IEnumerable< T > Collection)
 Adds a list of items to the ExtList.
ExtList< T > Clone ()
 Creates a clone of the ExtList.
void Insert (int Index, T Item)
 Inserts an item to the ExtList at the specified Index.
void Clear ()
 Clears the ExtList.
bool Remove (T ItemToRemove)
 Romves a item from the ExtList.
void RemoveAt (int Index)
 Removes a item at a specified index.
bool Contains (T ItemToCheck)
 Checks wether the specified item is contained in the ExtList.
void Sort ()
 Sorts the ExtList.
void Sort (IComparer< T > Comparer)
 Sorts the ExtList.
void Sort (Comparison< T > Comparison)
 Sorts the elements in the entire ExtList using the specified System.Comparison<T>.
T[] ToArray ()
 Returns a array containg the ExtList items.
 ExtList ()
 ExtList (IEnumerable< T > EnumerableList)
void CopyTo (Array array, int index)
int Add (object value)
bool Contains (object value)
int IndexOf (object value)
void Insert (int index, object value)
void Remove (object value)

Additional Inherited Members

Properties inherited from DirectOutput.General.Generic.NamedItemList< T >
this[string Name] [get]
 Indexer returning the Item with the specified name.
Properties inherited from DirectOutput.General.Generic.ExtList< T >
bool IsReadOnly [get]
 This ExtList objects are not readonly.
Will always return false.
int Count [get]
 Number of items in the ExtList.
this[int Index] [get, set]
 Indexer of the ExtList.
Returns the item at the specified index.
bool IsSynchronized [get]
object SyncRoot [get]
bool IsFixedSize [get]
Events inherited from DirectOutput.General.Generic.ExtList< T >
EventHandler< EventArgs > BeforeClear
 Fires before the ExtList is cleared.
If a exception is trown within the events, the list is not cleared.
EventHandler< EventArgs > AfterClear
 Fires after the ExtList is cleared.
EventHandler< InsertEventArgs< T > > BeforeInsert
 Fires before a new item is inserted into the ExtList.
If a exception is occurs in the event, to item is not added. OnValidate is called prior to this method.

EventHandler< InsertEventArgs< T > > AfterInsert
 Fires after a new item is inserted into the ExtList.
OnValidate is called prior to this method.

EventHandler< RemoveEventArgs< T > > BeforeRemove
 Fires before a item is removed from the ExtList.
EventHandler< RemoveEventArgs< T > > AfterRemove
 Fires after a item is removed from the ExtList.
EventHandler< SetEventArgs< T > > BeforeSet
 Fires before a item is set in the ExtList. OnValidate is called prior to this method.
EventHandler< SetEventArgs< T > > AfterSet
 Fires after a item has been set in the ExtList.

Detailed Description

Collection of IEffect objects. Every object can only exist once in the list and every objects needs to have a unique name.

Constructor & Destructor Documentation

◆ EffectList()

DirectOutput.FX.EffectList.EffectList ( )

Initializes a new instance of the EffectList class.

Member Function Documentation

◆ Finish()

void DirectOutput.FX.EffectList.Finish ( )

Calls Finish on all IEffect objects in the list.

◆ GetSchema()

System.Xml.Schema.XmlSchema DirectOutput.FX.EffectList.GetSchema ( )

Method is required by the IXmlSerializable interface.

◆ Init()

void DirectOutput.FX.EffectList.Init ( Table.Table Table)

Calls Init on all IEffect objects in the list.

◆ ReadXml()

void DirectOutput.FX.EffectList.ReadXml ( XmlReader reader)

Deserializes the IEffect objects in the XmlReader The IEffect objects are deserialized using the object name in the enclosing tags. ReadXml is part of the IXmlSerializable interface.

◆ WriteXml()

void DirectOutput.FX.EffectList.WriteXml ( XmlWriter writer)

Serializes the IEffect objects in this list to Xml. IEffect objects are serialized as the contained objects. The enclosing tags represent the object type WriteXml is part of the IXmlSerializable interface.


The documentation for this class was generated from the following file: