Sets the spefied area of matrix to the specified colors depending on the trigger value. More...

Inheritance diagram for DirectOutput.FX.MatrixFX.RGBAMatrixColorEffect:

[legend]

Collaboration diagram for DirectOutput.FX.MatrixFX.RGBAMatrixColorEffect:

[legend]

Protected Member Functions
override RGBAColor	GetEffectValue (int TriggerValue)
	Gets the effect color by mixinging Active and InactiveColor based on the TriggerValue.
Protected Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixValueEffectBase< MatrixElementType >
MatrixElementType	GetEffectValue (int TriggerValue)
	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)

Properties
RGBAColor	ActiveColor `[get, set]`
	Gets or sets the active color. The FadeMode property defines how this value is used.
RGBAColor	InactiveColor `[get, set]`
	Gets or sets the inactive color. The FadeMode property defines how this value is used.
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.

Additional Inherited Members
Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixValueEffectBase< MatrixElementType >
override void	Trigger (Table.TableElementData TableElementData)
	Triggers the effect with the given TableElementData.
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.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.
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

Sets the spefied area of matrix to the specified colors depending on the trigger value.

Member Function Documentation

◆ GetEffectValue()

override RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixColorEffect.GetEffectValue ( int TriggerValue )

protected

Gets the effect color by mixinging Active and InactiveColor based on the TriggerValue.

Parameters

TriggerValue The trigger value.

Returns: RGBAColor representing a mix of InactiveColor and ActiveColor.

Property Documentation

◆ ActiveColor

RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixColorEffect.ActiveColor

getset

Gets or sets the active color. The FadeMode property defines how this value is used.

The active color.

◆ InactiveColor

RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixColorEffect.InactiveColor

getset

Gets or sets the inactive color. The FadeMode property defines how this value is used.

The inactive color.

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

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

Protected Member Functions