DirectOutput.FX.EffectBase Class Reference

Abstract base class for IEffect objects.
This class inherits NamedItemBase and implements IEffect. More...

Inheritance diagram for DirectOutput.FX.EffectBase:

Collaboration diagram for DirectOutput.FX.EffectBase:

Public Member Functions
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.
virtual void	Finish ()
	Finish does all necessary cleanupwork before the object is discarded.

Additional Inherited Members
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 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

Abstract base class for IEffect objects.
This class inherits NamedItemBase and implements IEffect.

Member Function Documentation

Finish()

virtual void DirectOutput.FX.EffectBase.Finish ( )

virtual

Finish does all necessary cleanupwork before the object is discarded.

Implements DirectOutput.FX.IEffect.

Reimplemented in DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase, DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect, DirectOutput.FX.ConditionFX.TableElementConditionEffect, 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.EffectBase.Init ( Table.Table Table )

abstract

Init does all necessary initialization work after the effect object has been instanciated.

Parameters

Table

Table object containing the effect.

Implements DirectOutput.FX.IEffect.

Trigger()

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

abstract

Triggers the effect with the given TableElementData.

Parameters

TableElementData

TableElementData for the TableElement which has triggered the effect.

Implements DirectOutput.FX.IEffect.

---

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

• D:/a/DirectOutput/DirectOutput/DirectOutput/FX/EffectBase.cs