DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
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:
Collaboration diagram for DirectOutput.FX.EffectBase:

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< NameChangeEventArgsAfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgsBeforeNameChange
 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.

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: