DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase Class Reference

Base class for effects controlling a single AnalogToy object. More...

Inheritance diagram for DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase:

Collaboration diagram for DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase:

Public Member Functions
override void	Init (Table.Table Table)
	Initializes the effect. More...
override void	Finish ()
	Finish does all necessary cleanupwork before the effect is discarded. 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 Attributes
Table.Table	Table
	The table which contains the effect. More...

Properties
string	ToyName [get, set]
	Name of the AnalogToy. More...
AnalogAlpha	Layer [get, set]
int	LayerNr [get, set]
	Gets or sets the number of the layer for the AnalogToy effect (Default=0). More...
IAnalogAlphaToy	Toy [get, set]
	Refrence to the AnalogToyy specified in the ToyName property. If the ToyName property is empty or contains a unknown name or the name of a toy which is not a AnalogToy this property will return null. More...

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

Detailed Description

Base class for effects controlling a single AnalogToy object.

Definition at line 15 of file AnanlogToyEffectBase.cs.

Member Function Documentation

override void DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Finish ( )

inlinevirtual

Finish does all necessary cleanupwork before the effect is discarded.

Reimplemented from DirectOutput.FX.EffectBase.

Definition at line 99 of file AnanlogToyEffectBase.cs.

override void DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Init ( Table.Table  Table )

inline

Initializes the effect.

Parameters

Table

Table object containing the effect.

Definition at line 81 of file AnanlogToyEffectBase.cs.

Member Data Documentation

Table.Table DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Table

protected

The table which contains the effect.

Definition at line 20 of file AnanlogToyEffectBase.cs.

Property Documentation

AnalogAlpha DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Layer

getsetprotected

Definition at line 45 of file AnanlogToyEffectBase.cs.

int DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.LayerNr

getset

Gets or sets the number of the layer for the AnalogToy effect (Default=0).

The layer number.

Definition at line 56 of file AnanlogToyEffectBase.cs.

IAnalogAlphaToy DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Toy

getsetprotected

Refrence to the AnalogToyy specified in the ToyName property.
If the ToyName property is empty or contains a unknown name or the name of a toy which is not a AnalogToy this property will return null.

Definition at line 69 of file AnanlogToyEffectBase.cs.

string DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.ToyName

getset

Name of the AnalogToy.

The name of the AnalogToy.

Definition at line 32 of file AnanlogToyEffectBase.cs.

---

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

• C:/Users/Tom/Documents/GitHub/DirectOutput/DirectOutput/FX/AnalogToyFX/AnanlogToyEffectBase.cs