Common interface for all effects.
If a new effect is implemented it is best to inherit from the abstract class Effect which does also inherit IEffect.
All classes inheriting IEffect must be XMLSerializeable. More...

Inheritance diagram for DirectOutput.FX.IEffect:

[legend]

Collaboration diagram for DirectOutput.FX.IEffect:

[legend]

Public Member Functions
void	Trigger (TableElementData TableElementData)
	Execute triggers the effect for the given TableElement.
void	Init (Table.Table Table)
	Init must do all necessary initialization work after the IEffect object has been instanciated.
void	Finish ()
	Finish must do all necessary cleanupwork before a IEffect object is discarded.

Properties
new string	Name `[get, set]`
	Name of the effect.

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

Detailed Description

Common interface for all effects.
If a new effect is implemented it is best to inherit from the abstract class Effect which does also inherit IEffect.
All classes inheriting IEffect must be XMLSerializeable.

Member Function Documentation

◆ Finish()

void DirectOutput.FX.IEffect.Finish ( )

Finish must do all necessary cleanupwork before a IEffect object is discarded.

Implemented in DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase, DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect, DirectOutput.FX.ConditionFX.TableElementConditionEffect, DirectOutput.FX.EffectBase, DirectOutput.FX.EffectEffectBase, DirectOutput.FX.ListFX.ListEffect, DirectOutput.FX.MatrixFX.MatrixBitmapAnimationEffectBase< MatrixElementType >, DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< MatrixElementType >, DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >, DirectOutput.FX.MatrixFX.MatrixFlickerEffectBase< MatrixElementType >, DirectOutput.FX.MatrixFX.MatrixShiftEffectBase< MatrixElementType >, DirectOutput.FX.MatrixFX.RGBAMatrixColorScaleShapeEffect, DirectOutput.FX.MatrixFX.RGBAMatrixShapeEffect, DirectOutput.FX.RGBAFX.RGBAColorEffect, DirectOutput.FX.RGBAFX.RGBAEffectBase, DirectOutput.FX.TimmedFX.BlinkEffect, DirectOutput.FX.TimmedFX.DelayEffect, DirectOutput.FX.TimmedFX.DurationEffect, DirectOutput.FX.TimmedFX.ExtendDurationEffect, and DirectOutput.FX.TimmedFX.MinDurationEffect.

◆ Init()

void DirectOutput.FX.IEffect.Init ( Table.Table Table )

Init must do all necessary initialization work after the IEffect object has been instanciated.

Parameters

Table The Table object containing the effect.

◆ Trigger()

void DirectOutput.FX.IEffect.Trigger ( TableElementData TableElementData )

Execute triggers the effect for the given TableElement.

Warning: Remember that the TableElementData parameter will contain null if a effect is called as a static effect. Make sure your implementation of this method does not fail when called with null.

Parameters

TableElementData TableElementData object for the TableElement which has triggered the effect.

Implemented in DirectOutput.FX.ConditionFX.TableElementConditionEffect, DirectOutput.FX.EffectBase, DirectOutput.FX.TimmedFX.DelayEffect, and DirectOutput.FX.TimmedFX.MinDurationEffect.

Property Documentation

◆ Name

new string DirectOutput.FX.IEffect.Name

getset

Name of the effect.

Note: Be sure to fire the NameChanged event if the name of the object gets changed. The abstract Effect class does already implement this property and the required NameChanged event.

The name of the effect.

Implements DirectOutput.General.Generic.INamedItem.

Event Documentation

◆ AfterNameChanged

new EventHandler<NameChangeEventArgs> DirectOutput.FX.IEffect.AfterNameChanged

This event must be fired after the Name property of a IEffect object has changed.

◆ BeforeNameChanged

new EventHandler<NameChangeEventArgs> DirectOutput.FX.IEffect.BeforeNameChanged

This event must be fired before the Name property of a IEffect object is changed.

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

D:/a/DirectOutput/DirectOutput/DirectOutput/FX/IEffect.cs

Public Member Functions

Properties

Events