DirectOutputR1
DirectOutput framework R1 for virtual pinball cabinets.
 Go to:
Overview 
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for DirectOutput.FX.EffectBase:
Collaboration graph
[legend]

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

- 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.FX.IEffect
new string Name [get, set]
 Name of the effect.
More...
 
- Events inherited from DirectOutput.General.Generic.NamedItemBase
EventHandler< NameChangeEventArgs > AfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgs > BeforeNameChange
 Event is fired before the value of the property Name is changed. More...
 
- Events inherited from DirectOutput.FX.IEffect
new EventHandler
< NameChangeEventArgs > 		AfterNameChanged
 This event must be fired after the Name property of a IEffect object has changed. More...
 
new EventHandler
< NameChangeEventArgs > 		BeforeNameChange
 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

virtual void DirectOutput.FX.EffectBase.Finish ( )
inlinevirtual

Finish does all necessary cleanupwork before the object is discarded.

Implements DirectOutput.FX.IEffect.

Reimplemented in DirectOutput.FX.AnalogToyFX.AnalogToyFadeOnOffEffect, DirectOutput.FX.RGBAFX.RGBAFadeOnOffEffect, DirectOutput.FX.TimmedFX.BlinkEffect, DirectOutput.FX.TimmedFX.MinDurationEffect, DirectOutput.FX.RGBAFX.RGBAEffectBase, DirectOutput.FX.AnalogToyFX.AnanlogToyEffectBase, DirectOutput.FX.TimmedFX.DurationEffect, DirectOutput.FX.TimmedFX.ExtendDurationEffect, DirectOutput.FX.EffectEffectBase, DirectOutput.FX.RGBAFX.RGBAOnOffEffect, DirectOutput.FX.AnalogToyFX.AnalogToyOnOffEffect, DirectOutput.FX.TimmedFX.DelayEffect, and DirectOutput.FX.ListFX.ListEffect.

Definition at line 37 of file EffectBase.cs.

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.TimmedFX.ExtendDurationEffect, and DirectOutput.FX.TimmedFX.DelayEffect.

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

Triggers the effect with the given TableElementData.

Warning
Remember that the TableElementData parameter will contain null if a effect is called as a static effect. Make sure your implementation of this method does not fail resp. throw exceptions when called with null.
Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Implements DirectOutput.FX.IEffect.

Implemented in DirectOutput.FX.TimmedFX.DelayEffect.

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