WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.FX.TimmedFX.ExtendDurationEffect Class Reference

The extend duration effect triggers another effect for a duration which is extebnded by the number of milliseconds specified in DurationMs.
This is done by forwarding triggers calls which are seting the effect to active directly to the target effect and delaying the forwarding of calls which set the effect to inactive by the number of milliseconds specified in DurationMs.
More...

Inheritance diagram for DirectOutput.FX.TimmedFX.ExtendDurationEffect:
DirectOutput.FX.EffectEffectBase DirectOutput.FX.EffectBase DirectOutput.General.Generic.NamedItemBase DirectOutput.FX.IEffect DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem

Public Member Functions

override void Trigger (Table.TableElementData TableElementData)
 Triggers the effect with the given TableElementData.
Trigger calls of a TableElemenData value which is not equal 0, are forwarded directly to the target effect.
Calls with a TableElementData Value of 0, are delayed by the Duration specifed in DurationMs before they are forwarded to the target effect. More...
 
override void Init (Table.Table Table)
 Inititializes the ExtendDurationEffect. More...
 
override void Finish ()
 Finishes the ExtendDurationEffect.
Clears all pending/delayed calls. More...
 
- Public Member Functions inherited from DirectOutput.FX.EffectBase
abstract void Trigger (TableElementData TableElementData)
 Triggers the effect with the given TableElementData. More...
 

Properties

int DurationMs [get, set]
 Gets or sets the duration in milliseconds which will is added to the duration during which the effect is triggered/active. More...
 
- Properties inherited from DirectOutput.FX.EffectEffectBase
string TargetEffectName [get, set]
 Name of the target effect.
Triggers EffectNameChanged if value is changed. More...
 
IEffect TargetEffect [get]
 TargetEffect for the effect (ReadOnly).
The property is resolved from the TargetEffectName. If TargetEffectName is empty or unknown this property will return null. More...
 
Table.Table Table [get]
 Gets the table object which is hosting the effect. More...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from DirectOutput.FX.EffectEffectBase
void TriggerTargetEffect (TableElementData TriggerData)
 Triggers the target effect.
The method will deactivate the target effect if it throws a exception. More...
 
- 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)
 
- 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

The extend duration effect triggers another effect for a duration which is extebnded by the number of milliseconds specified in DurationMs.
This is done by forwarding triggers calls which are seting the effect to active directly to the target effect and delaying the forwarding of calls which set the effect to inactive by the number of milliseconds specified in DurationMs.

FX_ExtendDuration.png
ExtendDuration effect

Definition at line 11 of file ExtendDurationEffect.cs.

Member Function Documentation

override void DirectOutput.FX.TimmedFX.ExtendDurationEffect.Finish ( )
virtual

Finishes the ExtendDurationEffect.
Clears all pending/delayed calls.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 79 of file ExtendDurationEffect.cs.

override void DirectOutput.FX.TimmedFX.ExtendDurationEffect.Init ( Table.Table  Table)
virtual

Inititializes the ExtendDurationEffect.

Parameters
TableThe table which uses the effect.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 70 of file ExtendDurationEffect.cs.

override void DirectOutput.FX.TimmedFX.ExtendDurationEffect.Trigger ( Table.TableElementData  TableElementData)

Triggers the effect with the given TableElementData.
Trigger calls of a TableElemenData value which is not equal 0, are forwarded directly to the target effect.
Calls with a TableElementData Value of 0, are delayed by the Duration specifed in DurationMs before they are forwarded to the target effect.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.
Todo:
implement proper retrigger behaviour

Definition at line 36 of file ExtendDurationEffect.cs.

Property Documentation

int DirectOutput.FX.TimmedFX.ExtendDurationEffect.DurationMs
getset

Gets or sets the duration in milliseconds which will is added to the duration during which the effect is triggered/active.

The extended duration in milliseconds.

Definition at line 22 of file ExtendDurationEffect.cs.


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