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

Base class for effects targeting a matrix of toys (e.g. addressable ledstrip) More...

Inheritance diagram for DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >:
Collaboration diagram for DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >:

Public Member Functions

override void Init (Table.Table Table)
 Initializes the effect. Resolves object references. More...
 
override void Finish ()
 Finishes the effect and releases object references 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...
 

Protected Attributes

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...
 

Properties

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

- 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

Base class for effects targeting a matrix of toys (e.g. addressable ledstrip)

Member Function Documentation

override void DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Finish ( )
virtual

Finishes the effect and releases object references

Reimplemented from DirectOutput.FX.EffectBase.

Reimplemented in DirectOutput.FX.MatrixFX.MatrixShiftEffectBase< MatrixElementType >.

override void DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Init ( Table.Table  Table)

Initializes the effect. Resolves object references.

Parameters
TableTable object containing the effect.

Member Data Documentation

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.AreaBottom = 0
protected

The gets the Y position of the led in the lower right corner of the effect area.

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.AreaLeft = 0
protected

The gets the X position of the led in the upper left corner of the effect area.

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.AreaRight = 0
protected

The gets the X position of the led in the lower right corner of the effect area.

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.AreaTop = 0
protected

The gets the Y position of the led in the upper left corner of the effect area.

MatrixElementType [,] DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.MatrixLayer
protected

The layer array of a IRGBAMatrix object as specified by the ToyName and the LayerNr. This reference is initialized by the Init method.

A IRGBAMatrix object layer array.

Property Documentation

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.AreaHeight
getprotected

Gets the number of leds on vertical direction of the area for the effect.

The number of leds on vertical direction of the area for the effect.

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.AreaWidth
getprotected

Gets the number of leds on horizontal direction of the area for the effect.

The number of leds on horizontal direction of the area for the effect.

FadeModeEnum DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.FadeMode
getset

Gets or sets the fade mode.

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

float DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Height
getset

Gets or sets the height in percent of target area of the ledstrip which is controlled by the effect.

The height in percent of the target area for the effect (0-100).

int DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.LayerNr
getset

Gets or sets the number of the layer which is targeted by the effect.

The number of the target layer for the effect.

float DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Left
getset

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.

The left resp. X position of the upper left corner in percent of the target area for the effect (0-100).

IMatrixToy<MatrixElementType> DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Matrix
getsetprotected

Gets the matrix toy which is referenced by the ToyName property. This property is initialized by the Init method.

The matrix toy which is referenced by the ToyName property.

Table.Table DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Table
getsetprotected

Gets the table object which was specified during initialisation of the effect.

The table object which was specified during initialisation of the effect..

float DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Top
getset

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.

The top resp. Y position of the upper left corner in percent of the target area for the effect (0-100).

string DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.ToyName
getset

Gets or sets the name of the toy which is to be controlled by the effect.

The name of the toy which is controlled by the effect.

float DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Width
getset

Gets or sets the width in percent of target area of the ledstrip which is controlled by the effect.

The width in percent of the target area for the effect (0-100).


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