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

Protected Member Functions

override RGBAColor GetEffectValue (int TriggerValue)
 Gets the effect color by mixinging Active and InactiveColor based on the TriggerValue. More...
 

Properties

RGBAColor ActiveColor [get, set]
 Gets or sets the active color. The FadeMode property defines how this value is used. More...
 
RGBAColor InactiveColor [get, set]
 Gets or sets the inactive color. The FadeMode property defines how this value is used. More...
 
- Properties inherited from DirectOutput.FX.MatrixFX.MatrixShiftEffectBase< MatrixElementType >
MatrixShiftDirectionEnum ShiftDirection [get, set]
 Gets or sets the shift direction resp. the direction in which the color moves. More...
 
float ShiftSpeed [get, set]
 Gets or sets the shift speed in percentage of the effect area per second. A speed setting of 100 will shift through the whole area of the effect in 1 second. 200 will shift through the effect area in .5 seconds. 33 will shift through the effect area in approx. 3 seconds. Max. speed is 10000 (shift through the effect area in 1/100 seconds). Min. speed is 1 (shifts through the effect area in 100 seconds). More...
 
float ShiftAcceleration [get, set]
 Gets or sets the acceleration for the shift speed in percent of the effect area per second. Acceleration can be zero, positive or negative. Positive values will increase the shift speed. Speed will be increased up to a max value of 10000. Negative values will decrease the shift speed. Speed will be decreased down to a minimum speed of 1. 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.MatrixShiftEffectBase< MatrixElementType >
override void Trigger (Table.TableElementData TableElementData)
 
override void Init (Table.Table Table)
 
override void Finish ()
 Finishes the effect and releases object references 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...
 

Member Function Documentation

override RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixShiftEffect.GetEffectValue ( int  TriggerValue)
protectedvirtual

Gets the effect color by mixinging Active and InactiveColor based on the TriggerValue.

Parameters
TriggerValueThe trigger value.
Returns
RGBAColor representing a mix of InactiveColor and ActiveColor.

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

Property Documentation

RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixShiftEffect.ActiveColor
getset

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

The active color.

RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixShiftEffect.InactiveColor
getset

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

The inactive color.


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