DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect Class Reference

This effect controlls sets the value and alpha channel of a analog alpha toy based on the trigger value. More...

Inheritance diagram for DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect:
Collaboration diagram for DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect:

Public Member Functions

override void Trigger (Table.TableElementData TableElementData)
 Triggers the effect with the given TableElementData. More...
 
override void Init (Table.Table Table)
 Initializes the effect. More...
 
override void Finish ()
 Finish does all necessary cleanupwork before the effect is discarded. More...
 
- Public Member Functions inherited from DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase
override void Init (Table.Table Table)
 Initializes the effect. More...
 
override void Finish ()
 Finish does all necessary cleanupwork before the effect is discarded. More...
 
- Public Member Functions inherited from DirectOutput.FX.EffectBase
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...
 

Properties

AnalogAlpha ActiveValue [get, set]
 Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is not zero. More...
 
AnalogAlpha InactiveValue [get, set]
 Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is zero. More...
 
FadeModeEnum FadeMode [get, set]
 Gets or sets the fade mode. More...
 
- Properties inherited from DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase
string ToyName [get, set]
 Name of the AnalogToy. More...
 
AnalogAlpha Layer [get, set]
 
int LayerNr [get, set]
 Gets or sets the number of the layer for the AnalogToy effect (Default=0). More...
 
IAnalogAlphaToy Toy [get, set]
 Refrence to the AnalogToyy specified in the ToyName property.
If the ToyName property is empty or contains a unknown name or the name of a toy which is not a AnalogToy this property will return null. More...
 

Additional Inherited Members

- Protected Attributes inherited from DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase
Table.Table Table
 The table which contains 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

This effect controlls sets the value and alpha channel of a analog alpha toy based on the trigger value.

Dependinging on the FadeMode property the effect sets the value of the target layer either to the active inactive value in OnOff mode or a mix of the value in Fade mode.

Member Function Documentation

override void DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.Finish ( )
virtual

Finish does all necessary cleanupwork before the effect is discarded.

Reimplemented from DirectOutput.FX.EffectBase.

override void DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.Init ( Table.Table  Table)

Initializes the effect.

Parameters
TableTable object containing the effect.
override void DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.Trigger ( Table.TableElementData  TableElementData)

Triggers the effect with the given TableElementData.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Property Documentation

AnalogAlpha DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.ActiveValue
getset

Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is not zero.

The active value and alpha channel between 0 and 255.

FadeModeEnum DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.FadeMode
getset

Gets or sets the fade mode.

Fade (active and inactive color will fade depending on trigger value) or OnOff (actvice color is used for triger values >0, otherwise inactive color will be used).

AnalogAlpha DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.InactiveValue
getset

Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is zero.

The inactive value and alpha channel between 0 and 255.


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