DirectOutput.FX.MatrixFX.RGBAMatrixBitmapEffect Class Reference

The RGBAMatrixBitmapEffect displays a defined part of a bitmap on a area of a RGBAtoy Matrix. More...

Inheritance diagram for DirectOutput.FX.MatrixFX.RGBAMatrixBitmapEffect:

Collaboration diagram for DirectOutput.FX.MatrixFX.RGBAMatrixBitmapEffect:

Public Member Functions
override RGBAColor	GetEffectValue (int TriggerValue, PixelData Pixel)
	Gets the value for a single element in the matrix. More...
Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >
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...

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...
Properties inherited from DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >
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...
Events inherited from DirectOutput.General.Generic.NamedItemBase
EventHandler< NameChangeEventArgs >	AfterNameChanged
	Event is fired after the value of the property Name has changed. More...
EventHandler< NameChangeEventArgs >	BeforeNameChange
	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

The RGBAMatrixBitmapEffect displays a defined part of a bitmap on a area of a RGBAtoy Matrix.

The properties of the effect allow you to select the part of the bitmap to display as well as the area of the matrix on which the bitmap is displayed. Dempending on the size of your bitmap you might choose different modes for the image extraction.

The effect supports numerous imahe formats, inluding png, gif (also animated) and jpg.

The image extraction takes place upon initalization of the framework. While the framework is active, it only outputs the previously extracted and scaled data to allow for better performance.

Member Function Documentation

override RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixBitmapEffect.GetEffectValue ( int  TriggerValue, PixelData  Pixel  )

virtual

Gets the value for a single element in the matrix.

Parameters

TriggerValue	The trigger value.
Pixel	A pixel representing a element in the matrix.

Returns

The RGBAData for a element in the matrix

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

---

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

• C:/Users/Tom/Documents/GitHub/DirectOutput/DirectOutput/FX/MatrixFX/RGBAMatrixBitmapEffect.cs