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

Outputs a defined part of a bitmap on a area of a matrix More...

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

Public Member Functions

abstract MatrixElementType GetEffectValue (int TriggerValue, PixelData Pixel)
 Gets the value which is to be applied to all elements of the matrix area controlled by the effect. This methed must be overwritten. More...
 
override void Trigger (Table.TableElementData TableElementData)
 Triggers the effect with the given data. More...
 
override void Init (Table.Table Table)
 Initializes the effect. Resolves object references, extracts source image data. More...
 
override void Finish ()
 Finishes the effect and releases object references More...
 
- Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
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...
 

Properties

int BitmapFrameNumber [get, set]
 Gets or sets the number of the frame to be used. This is usefull if you work with animated gifs. More...
 
int BitmapTop [get, set]
 Gets or sets the top of the the part of the bitmap which is to be used. More...
 
int BitmapLeft [get, set]
 Gets or sets the left boundary of the the part of the bitmap which is to be used. More...
 
int BitmapWidth [get, set]
 Gets or sets the width of the the part of the bitmap which is to be used. More...
 
int BitmapHeight [get, set]
 Gets or sets the height of the the part of the bitmap which is to be used. More...
 
FastBitmapDataExtractModeEnum DataExtractMode [get, set]
 Gets or sets the mode how data is extracted from the source bitmap. More...
 
FilePattern BitmapFilePattern [get, set]
 Gets or sets the file pattern which is used to load the bitmap file for the effect. 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

- 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

Outputs a defined part of a bitmap on a area of a matrix

Member Function Documentation

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

Finishes the effect and releases object references

Reimplemented from DirectOutput.FX.EffectBase.

abstract MatrixElementType DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.GetEffectValue ( int  TriggerValue,
PixelData  Pixel 
)
pure virtual

Gets the value which is to be applied to all elements of the matrix area controlled by the effect. This methed must be overwritten.

Parameters
TriggerValueThe trigger value.
PixelThe pixel to be applied to the matrix element.
Returns
Returns the value which is to be applied to to elements of the matrix representing the Pixel.

Implemented in DirectOutput.FX.MatrixFX.RGBAMatrixBitmapEffect, and DirectOutput.FX.MatrixFX.AnalogAlphaMatrixBitmapEffect.

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

Initializes the effect. Resolves object references, extracts source image data.

Parameters
TableTable object containing the effect.
override void DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.Trigger ( Table.TableElementData  TableElementData)

Triggers the effect with the given data.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Property Documentation

FilePattern DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.BitmapFilePattern
getset

Gets or sets the file pattern which is used to load the bitmap file for the effect.

The bitmap file pattern which is used to load the bitmap file for the effect.

int DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.BitmapFrameNumber
getset

Gets or sets the number of the frame to be used. This is usefull if you work with animated gifs.

The number of the frame to be used (for animated gifs).

int DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.BitmapHeight
getset

Gets or sets the height of the the part of the bitmap which is to be used.

The height of the the part of the bitmap which is to be used.

int DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.BitmapLeft
getset

Gets or sets the left boundary of the the part of the bitmap which is to be used.

The left boundary of the the part of the bitmap which is to be used.

int DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.BitmapTop
getset

Gets or sets the top of the the part of the bitmap which is to be used.

The top of the the part of the bitmap which is to be used.

int DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.BitmapWidth
getset

Gets or sets the width of the the part of the bitmap which is to be used.

The width of the the part of the bitmap which is to be used.

FastBitmapDataExtractModeEnum DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >.DataExtractMode
getset

Gets or sets the mode how data is extracted from the source bitmap.

The data extract mode which defines how the data is extracted from the source bitmap.


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