WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.FX.EffectBase Class Referenceabstract

Abstract base class for IEffect objects.
This class inherits NamedItemBase and implements IEffect. More...

Inheritance diagram for DirectOutput.FX.EffectBase:
DirectOutput.General.Generic.NamedItemBase DirectOutput.FX.IEffect DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase DirectOutput.FX.EffectEffectBase DirectOutput.FX.ListFX.ListEffect DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType > DirectOutput.FX.NullFX.NullEffect DirectOutput.FX.RGBAFX.RGBAEffectBase DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect DirectOutput.FX.ConditionFX.TableElementConditionEffect DirectOutput.FX.TimmedFX.BlinkEffect DirectOutput.FX.TimmedFX.DelayEffect DirectOutput.FX.TimmedFX.DurationEffect DirectOutput.FX.TimmedFX.ExtendDurationEffect DirectOutput.FX.TimmedFX.FadeEffect DirectOutput.FX.TimmedFX.MaxDurationEffect DirectOutput.FX.TimmedFX.MinDurationEffect DirectOutput.FX.ValueFX.ValueInvertEffect DirectOutput.FX.ValueFX.ValueMapFullRangeEffect DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType > DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType > DirectOutput.FX.MatrixFX.MatrixFlickerEffectBase< MatrixElementType > DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType > DirectOutput.FX.MatrixFX.MatrixShiftEffectBase< MatrixElementType > DirectOutput.FX.MatrixFX.MatrixValueEffectBase< MatrixElementType > DirectOutput.FX.RGBAFX.RGBAColorEffect

Public Member Functions

abstract void Trigger (TableElementData TableElementData)
 Triggers the effect with the given TableElementData. More...
 
abstract void Init (Table.Table Table)
 Init does all necessary initialization work after the effect object has been instanciated. More...
 
virtual void Finish ()
 Finish does all necessary cleanupwork before the object is discarded. More...
 

Additional Inherited Members

- Protected Member Functions inherited from DirectOutput.General.Generic.NamedItemBase
virtual void AfterNameChange (string OldName, string NewName)
 
virtual void BeforeNameChange (string OldName, string NewName)
 
virtual void OnPropertyChanged (string propertyName)
 
virtual void OnPropertyChanging (string propertyName)
 
- Properties inherited from DirectOutput.General.Generic.NamedItemBase
string Name [get, set]
 Name of the named item.
Triggers BeforeNameChange before a new Name is set.
Triggers AfterNameChanged after a new name has been set. More...
 
- Properties inherited from DirectOutput.General.Generic.INamedItem
string Name [get, set]
 Gets or sets the name of the item.
Must fire the BeforeNameChange and AfterNameChange events when the value of the property is changed. More...
 
- Properties inherited from DirectOutput.FX.IEffect
new string Name [get, set]
 Name of the effect.
More...
 
- Events inherited from DirectOutput.General.Generic.NamedItemBase
EventHandler< NameChangeEventArgsAfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgsBeforeNameChanged
 Event is fired before the value of the property Name is changed. More...
 
PropertyChangedEventHandler PropertyChanged
 
PropertyChangingEventHandler PropertyChanging
 
- Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgsBeforeNameChanged
 Occurs before the name of the item changes. More...
 
EventHandler< NameChangeEventArgsAfterNameChanged
 Occurs when after the name of the item has changed. More...
 
- Events inherited from DirectOutput.FX.IEffect
new EventHandler< NameChangeEventArgsAfterNameChanged
 This event must be fired after the Name property of a IEffect object has changed. More...
 
new EventHandler< NameChangeEventArgsBeforeNameChanged
 This event must be fired before the Name property of a IEffect object is changed. More...
 

Detailed Description

Abstract base class for IEffect objects.
This class inherits NamedItemBase and implements IEffect.

Definition at line 15 of file EffectBase.cs.

Member Function Documentation

abstract void DirectOutput.FX.EffectBase.Init ( Table.Table  Table)
pure virtual

Init does all necessary initialization work after the effect object has been instanciated.

Parameters
TableTable object containing the effect.

Implements DirectOutput.FX.IEffect.

Implemented in DirectOutput.FX.ConditionFX.TableElementConditionEffect, DirectOutput.FX.EffectEffectBase, DirectOutput.FX.TimmedFX.ExtendDurationEffect, and DirectOutput.FX.TimmedFX.DelayEffect.

abstract void DirectOutput.FX.EffectBase.Trigger ( TableElementData  TableElementData)
pure virtual

Triggers the effect with the given TableElementData.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Implements DirectOutput.FX.IEffect.

Implemented in DirectOutput.FX.ConditionFX.TableElementConditionEffect, DirectOutput.FX.TimmedFX.MinDurationEffect, and DirectOutput.FX.TimmedFX.DelayEffect.


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