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

Does create random flickering with a defineable density, durations and value within the spefied area of a matrix. More...

Inheritance diagram for DirectOutput.FX.MatrixFX.AnalogAlphaMatrixFlickerEffect:
Collaboration diagram for DirectOutput.FX.MatrixFX.AnalogAlphaMatrixFlickerEffect:

Protected Member Functions

override AnalogAlpha GetEffectValue (int TriggerValue)
 Gets the effect value by mixinging Active and InactiveValue based on the TriggerValue. More...
 

Properties

AnalogAlpha ActiveValue [get, set]
 Gets or sets the active value. The FadeMode property defines how this value is used. More...
 
AnalogAlpha InactiveValue [get, set]
 Gets or sets the inactive value. The FadeMode property defines how this value is used. More...
 
- Properties inherited from DirectOutput.FX.MatrixFX.MatrixFlickerEffectBase< MatrixElementType >
int Density [get, set]
 Gets or sets the density of the flickering in percent. For 0 no elements of the defined area will will flicker, for 50 half of the elements will flicker, for 100 all elements will flicker. More...
 
int MinFlickerDurationMs [get, set]
 Gets or sets the min duration in milliseconds for a single flicker/blink of a element. More...
 
int MaxFlickerDurationMs [get, set]
 Gets or sets the max duration in milliseconds for a single flicker/blink of a element. More...
 
- Properties inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
string ToyName [get, set]
 Gets or sets the name of the toy which is to be controlled by the effect. More...
 
IMatrixToy< MatrixElementType > Matrix [get, set]
 Gets the matrix toy which is referenced by the ToyName property. This property is initialized by the Init method. More...
 
float Width [get, set]
 Gets or sets the width in percent of target area of the ledstrip which is controlled by the effect. More...
 
float Height [get, set]
 Gets or sets the height in percent of target area of the ledstrip which is controlled by the effect. More...
 
float Left [get, set]
 Gets or sets the left resp. X positon of the upper left corner in percent of the target area of the ledstrip which is controlled by the effect. More...
 
float Top [get, set]
 Gets or sets the top resp. Y positon of the upper left corner in percent of the target area of the ledstrip which is controlled by the effect. More...
 
int LayerNr [get, set]
 Gets or sets the number of the layer which is targeted by the effect. More...
 
FadeModeEnum FadeMode [get, set]
 Gets or sets the fade mode. More...
 
int AreaWidth [get]
 Gets the number of leds on horizontal direction of the area for the effect. More...
 
int AreaHeight [get]
 Gets the number of leds on vertical direction of the area for the effect. More...
 
Table.Table Table [get, set]
 Gets the table object which was specified during initialisation of the effect. More...
 

Additional Inherited Members

- Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixFlickerEffectBase< MatrixElementType >
override void Trigger (Table.TableElementData TableElementData)
 Triggers the effect with the given TableElementData. More...
 
- Protected Attributes inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
int AreaLeft = 0
 The gets the X position of the led in the upper left corner of the effect area. More...
 
int AreaTop = 0
 The gets the Y position of the led in the upper left corner of the effect area. More...
 
int AreaRight = 0
 The gets the X position of the led in the lower right corner of the effect area. More...
 
int AreaBottom = 0
 The gets the Y position of the led in the lower right corner of the effect area. More...
 
MatrixElementType[,] MatrixLayer
 The layer array of a IRGBAMatrix object as specified by the ToyName and the LayerNr. This reference is initialized by the Init method. 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

Does create random flickering with a defineable density, durations and value within the spefied area of a matrix.

Member Function Documentation

override AnalogAlpha DirectOutput.FX.MatrixFX.AnalogAlphaMatrixFlickerEffect.GetEffectValue ( int  TriggerValue)
protectedvirtual

Gets the effect value by mixinging Active and InactiveValue based on the TriggerValue.

Parameters
TriggerValueThe trigger value.
Returns
AnalogAlpha value representing a mix of InactiveValue and ActiveValue.

Implements DirectOutput.FX.MatrixFX.MatrixFlickerEffectBase< MatrixElementType >.

Property Documentation

AnalogAlpha DirectOutput.FX.MatrixFX.AnalogAlphaMatrixFlickerEffect.ActiveValue
getset

Gets or sets the active value. The FadeMode property defines how this value is used.

The active value.

AnalogAlpha DirectOutput.FX.MatrixFX.AnalogAlphaMatrixFlickerEffect.InactiveValue
getset

Gets or sets the inactive value. The FadeMode property defines how this value is used.

The inactive value.


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