WIP
DirectOutput framework for virtual pinball cabinets WIP
|
Go to: Overview |
Blink effect which triggers a TargetEffect at specified intervalls with active (org value of TableElementData used in Trigger method is used to trigger the TargetEffect) and inactive (uses 0 as the Value of the TableElementData to trigger the TargetEffect) values.
More...
Public Member Functions | |
override void | Trigger (Table.TableElementData TableElementData) |
Triggers the BlinkEffect with the given TableElementData. If the Value property of the TableElementData is >0, the blinking gets started. If the TableElementData Value property is 0, the blinking is stopped. More... | |
override void | Finish () |
Finishes the BlinkEffect. More... | |
Public Member Functions inherited from DirectOutput.FX.EffectEffectBase | |
override void | Init (Table.Table Table) |
Initializes the EffectEffect. Resolves the name of the TargetEffect. More... | |
Public Member Functions inherited from DirectOutput.FX.EffectBase | |
abstract void | Trigger (TableElementData TableElementData) |
Triggers the effect with the given TableElementData. More... | |
Properties | |
int | HighValue [get, set] |
Gets or sets the high value for the blinking. More... | |
int | LowValue [get, set] |
Gets or sets the low value for the blinking. More... | |
int | DurationActiveMs [get, set] |
Gets or sets the active duration for the blinking in milliseconds. More... | |
int | DurationInactiveMs [get, set] |
Gets or sets the inactive duration for the blinking in milliseconds. More... | |
BlinkEffectUntriggerBehaviourEnum | UntriggerBehaviour [get, set] |
Gets or sets the untrigger behaviour which defines how the blinking stops. More... | |
bool | Active [get] |
Gets a value indicating whether this BlinkEffect is currently 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< NameChangeEventArgs > | AfterNameChanged |
Event is fired after the value of the property Name has changed. More... | |
EventHandler< NameChangeEventArgs > | BeforeNameChanged |
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< NameChangeEventArgs > | BeforeNameChanged |
Occurs before the name of the item changes. More... | |
EventHandler< NameChangeEventArgs > | AfterNameChanged |
Occurs when after the name of the item has 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 > | BeforeNameChanged |
This event must be fired before the Name property of a IEffect object is changed. More... | |
Blink effect which triggers a TargetEffect at specified intervalls with active (org value of TableElementData used in Trigger method is used to trigger the TargetEffect) and inactive (uses 0 as the Value of the TableElementData to trigger the TargetEffect) values.
Definition at line 13 of file BlinkEffect.cs.
|
virtual |
Finishes the BlinkEffect.
Reimplemented from DirectOutput.FX.EffectEffectBase.
Definition at line 193 of file BlinkEffect.cs.
override void DirectOutput.FX.TimmedFX.BlinkEffect.Trigger | ( | Table.TableElementData | TableElementData | ) |
Triggers the BlinkEffect with the given TableElementData.
If the Value property of the TableElementData is >0, the blinking gets started. If the TableElementData Value property is 0, the blinking is stopped.
TableElementData | TableElementData for the TableElement which has triggered the effect. |
Definition at line 172 of file BlinkEffect.cs.
|
get |
Gets a value indicating whether this BlinkEffect is currently active.
true
if active; otherwise false
.
Definition at line 101 of file BlinkEffect.cs.
|
getset |
Gets or sets the active duration for the blinking in milliseconds.
The active duration of the blinking in milliseconds.
Definition at line 57 of file BlinkEffect.cs.
|
getset |
Gets or sets the inactive duration for the blinking in milliseconds.
The inactive duration of the blinking in milliseconds.
Definition at line 72 of file BlinkEffect.cs.
|
getset |
Gets or sets the high value for the blinking.
The high value for the blinking. Values between 0 and 255 define the actual values which have to be output during the on phase of the blinking. A value of -1 defines that the value which has been received by the trigger event is used.
Definition at line 24 of file BlinkEffect.cs.
|
getset |
Gets or sets the low value for the blinking.
The low value for the blinking (0-255).
Definition at line 38 of file BlinkEffect.cs.
|
getset |
Gets or sets the untrigger behaviour which defines how the blinking stops.
The untrigger behaviour defines how the blinking stops.
Definition at line 87 of file BlinkEffect.cs.