WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.FX.ValueFX.ValueMapFullRangeEffect Class Reference

This effects maps the trigger value to the full range of 0 - 255. If the trigger value is 0, the mapped trigger value for the target effect is also 0. If the trigger value is >0, the mapped trigger value for the target effect is 255. More...

Inheritance diagram for DirectOutput.FX.ValueFX.ValueMapFullRangeEffect:
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. 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...
 
override void Finish ()
 Finishes the EffectEffect.
Releases the references to the target effect and to the table object. More...
 
- Public Member Functions inherited from DirectOutput.FX.EffectBase
abstract void Trigger (TableElementData TableElementData)
 Triggers the effect with the given TableElementData. 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)
 
- 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...
 
- 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

This effects maps the trigger value to the full range of 0 - 255. If the trigger value is 0, the mapped trigger value for the target effect is also 0. If the trigger value is >0, the mapped trigger value for the target effect is 255.

Definition at line 14 of file ValueMapFullRangeEffect.cs.

Member Function Documentation

override void DirectOutput.FX.ValueFX.ValueMapFullRangeEffect.Trigger ( Table.TableElementData  TableElementData)

Triggers the effect with the given TableElementData.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Definition at line 20 of file ValueMapFullRangeEffect.cs.


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