Displays parts of a bitmap as a animation on a matrix of AnalogAlpha elements. Check the docu on the other bitmap effects for more details on these effect types. More...

Inheritance diagram for DirectOutput.FX.MatrixFX.AnalogAlphaMatrixBitmapAnimationEffect:

[legend]

Collaboration diagram for DirectOutput.FX.MatrixFX.AnalogAlphaMatrixBitmapAnimationEffect:

[legend]

Protected Member Functions
override AnalogAlpha	GetEffectValue (int TriggerValue, PixelData Pixel)
	Gets the value for a single element in the matrix.
Protected Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >
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.
Protected Member Functions inherited from DirectOutput.General.Generic.NamedItemBase
virtual void	AfterNameChange (string OldName, string NewName)
virtual void	BeforeNameChange (string OldName, string NewName)
virtual void	OnPropertyChanged (string propertyName)
virtual void	OnPropertyChanging (string propertyName)

Additional Inherited Members
Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >
override void	Trigger (Table.TableElementData TableElementData)
	Triggers the effect with the given data.
override void	Init (Table.Table Table)
	Initializes the effect. Resolves object references, extracts source image data.
override void	Finish ()
	Finishes the effect and releases object references.
Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
override void	Init (Table.Table Table)
	Initializes the effect. Resolves object references.
override void	Finish ()
	Finishes the effect and releases object references.
Public Member Functions inherited from DirectOutput.FX.EffectBase
void	Trigger (TableElementData TableElementData)
	Triggers the effect with the given TableElementData.
void	Init (Table.Table Table)
	Init does all necessary initialization work after the effect object has been instanciated.
Protected Attributes inherited from DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >
PixelData[][,]	Pixels
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.
int	AreaTop = 0
	The gets the Y position of the led in the upper left corner of the effect area.
int	AreaRight = 0
	The gets the X position of the led in the lower right corner of the effect area.
int	AreaBottom = 0
	The gets the Y position of the led in the lower right corner of the effect area.
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.
Properties inherited from DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >
MatrixAnimationStepDirectionEnum	AnimationStepDirection `[get, set]`
	Gets or sets the animation direction.
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.
int	AnimationFrameCount `[get, set]`
	Gets or sets the number of frames for the whole animation.
AnimationBehaviourEnum	AnimationBehaviour `[get, set]`
	Gets or sets the animation behaviour.
int	AnimationFrameDurationMs `[get, set]`
	Gets or sets the animation frame duration in ms.
int	BitmapFrameNumber `[get, set]`
	Gets or sets the number of the frame to be displayed.
int	BitmapTop `[get, set]`
	Gets or sets the top of the the part of the bitmap which is to be displayed.
int	BitmapLeft `[get, set]`
	Gets or sets the left boundary of the the part of the bitmap which is to be displayed.
int	BitmapWidth `[get, set]`
	Gets or sets the width of the the part of the bitmap which is to be displayed.
int	BitmapHeight `[get, set]`
	Gets or sets the height of the the part of the bitmap which is to be displayed.
FastBitmapDataExtractModeEnum	DataExtractMode `[get, set]`
	Gets or sets the mode how data is extracted from the source bitmap.
FilePattern	BitmapFilePattern `[get, set]`
	Gets or sets the file pattern which is used to load the bitmap file for the effect.
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.
IMatrixToy< MatrixElementType >	Matrix `[get]`
	Gets the matrix toy which is referenced by the ToyName property. This property is initialized by the Init method.
float	Width `[get, set]`
	Gets or sets the width in percent of target area of the ledstrip which is controlled by the effect.
float	Height `[get, set]`
	Gets or sets the height in percent of target area of the matrix which is controlled by the effect.
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 matrix which is controlled by the effect.
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.
int	LayerNr `[get, set]`
	Gets or sets the number of the layer which is targeted by the effect.
FadeModeEnum	FadeMode `[get, set]`
	Gets or sets the fade mode.
int	AreaWidth `[get]`
	Gets the number of leds on horizontal direction of the area for the effect.
int	AreaHeight `[get]`
	Gets the number of leds on vertical direction of the area for the effect.
Table.Table	Table `[get]`
	Gets the table object which was specified during initialisation of the effect.
Properties inherited from DirectOutput.General.Generic.NamedItemBase
string	Name `[get, set]`
	Name of the named item. Triggers BeforeNameChange before a new Name is set. Triggers AfterNameChanged after a new name has been set.
Properties inherited from DirectOutput.FX.IEffect
new string	Name `[get, set]`
	Name of the effect.
Events inherited from DirectOutput.General.Generic.NamedItemBase
EventHandler< NameChangeEventArgs >	AfterNameChanged
	Event is fired after the value of the property Name has changed.
EventHandler< NameChangeEventArgs >	BeforeNameChanged
	Event is fired before the value of the property Name is changed.
PropertyChangedEventHandler	PropertyChanged
PropertyChangingEventHandler	PropertyChanging
Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgs >	BeforeNameChanged
	Occurs before the name of the item changes.
EventHandler< NameChangeEventArgs >	AfterNameChanged
	Occurs when after the name of the item has changed.
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.
new EventHandler< NameChangeEventArgs >	BeforeNameChanged
	This event must be fired before the Name property of a IEffect object is changed.

Detailed Description

Displays parts of a bitmap as a animation on a matrix of AnalogAlpha elements. Check the docu on the other bitmap effects for more details on these effect types.

Member Function Documentation

◆ GetEffectValue()

override AnalogAlpha DirectOutput.FX.MatrixFX.AnalogAlphaMatrixBitmapAnimationEffect.GetEffectValue	(	int	TriggerValue,
		PixelData	Pixel )

protected

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 AnalogAlpha value for a element in the matrix

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

D:/a/DirectOutput/DirectOutput/DirectOutput/FX/MatrixFX/AnalogAlphaMatrixBitmapAnimationEffect.cs

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetEffectValue()