Inheritance diagram for DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >:

[legend]

Collaboration diagram for DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >:

[legend]

Public Member Functions
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...

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

Properties
MatrixAnimationStepDirectionEnum	AnimationStepDirection `[get, set]`
	Gets or sets the animation direction. More...

int	AnimationStepSize `[get, set]`
	Gets or sets the size of the step in pixels or frames (depending on the AnimationStepDirection) to the next frame of the animation. More...

int	AnimationFrameCount `[get, set]`
	Gets or sets the number of frames for the whole animation. More...

AnimationBehaviourEnum	AnimationBehaviour `[get, set]`
	Gets or sets the animation behaviour. More...

int	AnimationFrameDurationMs `[get, set]`
	Gets or sets the animation frame duration in ms. More...

int	BitmapFrameNumber `[get, set]`
	Gets or sets the number of the frame to be displayed. More...

int	BitmapTop `[get, set]`
	Gets or sets the top of the the part of the bitmap which is to be displayed. More...

int	BitmapLeft `[get, set]`
	Gets or sets the left boundary of the the part of the bitmap which is to be displayed. More...

int	BitmapWidth `[get, set]`
	Gets or sets the width of the the part of the bitmap which is to be displayed. More...

int	BitmapHeight `[get, set]`
	Gets or sets the height of the the part of the bitmap which is to be displayed. 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< 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...

Member Function Documentation

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

virtual

Finishes the effect and releases object references

Reimplemented from DirectOutput.FX.EffectBase.

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

protectedpure 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

TriggerValue	The trigger value.
Pixel	The 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.RGBAMatrixBitmapAnimationEffect, and DirectOutput.FX.MatrixFX.AnalogAlphaMatrixBitmapAnimationEffect.

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

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

Parameters

Table Table object containing the effect.

override void DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.Trigger ( Table.TableElementData TableElementData )

Triggers the effect with the given data.

Parameters

TableElementData TableElementData for the TableElement which has triggered the effect.

Property Documentation

AnimationBehaviourEnum DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.AnimationBehaviour

getset

Gets or sets the animation behaviour.

The animation behaviour defines if a animation should run only once, run in a loop or continue at its last position when triggered.

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.AnimationFrameCount

getset

Gets or sets the number of frames for the whole animation.

The number of frames for the whole animation.

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.AnimationFrameDurationMs

getset

Gets or sets the animation frame duration in ms.

The animation frame duration in miliseconds. Defaults to 30ms if not set.

MatrixAnimationStepDirectionEnum DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.AnimationStepDirection

getset

Gets or sets the animation direction.

The direction in which the effect will step formward through the source image to get the next frame of the animation.

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.AnimationStepSize

getset

Gets or sets the size of the step in pixels or frames (depending on the AnimationStepDirection) to the next frame of the animation.

Thesize of the step in pixels or frames (depending on the AnimationStepDirection) to the next frame of the animation.

FilePattern DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< 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.MatrixBitmapAnimationEffectBase< MatrixElementType >.BitmapFrameNumber

getset

Gets or sets the number of the frame to be displayed.

The number of the frame to be displayed.

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.BitmapHeight

getset

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

The height of the the part of the bitmap which is to be displayed. -1 selects the fully height resp. the remaining height from the BitMapTop position.

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.BitmapLeft

getset

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

The left boundary in pixels of the the part of the bitmap which is to be displayed.

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.BitmapTop

getset

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

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

int DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >.BitmapWidth

getset

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

The width in pixels of the the part of the bitmap which is to be displayed. -1 selects the fully width resp. the remaining width from the BitMapLeft position.

FastBitmapDataExtractModeEnum DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< 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:

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Member Function Documentation

Property Documentation