This effect controlls sets the value and alpha channel of a analog alpha toy based on the trigger value. More...

Inheritance diagram for DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect:

Public Member Functions
override void	Trigger (Table.TableElementData TableElementData)
	Triggers the effect with the given TableElementData. More...

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.AnalogToyFX.AnalogToyEffectBase
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...

Properties
AnalogAlpha	ActiveValue `[get, set]`
	Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is not zero. More...

AnalogAlpha	InactiveValue `[get, set]`
	Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is zero. More...

FadeModeEnum	FadeMode `[get, set]`
	Gets or sets the fade mode. More...

Properties inherited from DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase
string	ToyName `[get, set]`
	Name of the AnalogToy. More...

AnalogAlpha	Layer `[get]`

int	LayerNr `[get, set]`
	Gets or sets the number of the layer for the AnalogToy effect (Default=0). More...

IAnalogAlphaToy	Toy `[get]`
	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...

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

Properties inherited from DirectOutput.General.Generic.INamedItem
string	Name `[get, set]`
	Gets or sets the name of the item. Must fire the BeforeNameChange and AfterNameChange events when the value of the property is changed. More...

Properties inherited from DirectOutput.FX.IEffect
new string	Name `[get, set]`
	Name of the effect. More...

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)

Protected Attributes inherited from DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase
Table.Table	Table
	The table which contains the effect. More...

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 >	BeforeNameChanged
	Event is fired before the value of the property Name is changed. More...

PropertyChangedEventHandler	PropertyChanged

PropertyChangingEventHandler	PropertyChanging

Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgs >	BeforeNameChanged
	Occurs before the name of the item changes. More...

EventHandler< NameChangeEventArgs >	AfterNameChanged
	Occurs when after the name of the item has 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 >	BeforeNameChanged
	This event must be fired before the Name property of a IEffect object is changed. More...

Detailed Description

This effect controlls sets the value and alpha channel of a analog alpha toy based on the trigger value.

Dependinging on the FadeMode property the effect sets the value of the target layer either to the active inactive value in OnOff mode or a mix of the value in Fade mode.

Definition at line 15 of file AnalogToyValueEffect.cs.

Member Function Documentation

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

virtual

Finish does all necessary cleanupwork before the effect is discarded.

Reimplemented from DirectOutput.FX.EffectBase.

Definition at line 92 of file AnalogToyValueEffect.cs.

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

Initializes the effect.

Parameters

Table Table object containing the effect.

Definition at line 84 of file AnalogToyValueEffect.cs.

override void DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.Trigger ( Table.TableElementData TableElementData )

Triggers the effect with the given TableElementData.

Parameters

TableElementData TableElementData for the TableElement which has triggered the effect.

Definition at line 66 of file AnalogToyValueEffect.cs.

Property Documentation

AnalogAlpha DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.ActiveValue

getset

Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is not zero.

The active value and alpha channel between 0 and 255.

Definition at line 27 of file AnalogToyValueEffect.cs.

FadeModeEnum DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.FadeMode

getset

Gets or sets the fade mode.

Fade (active and inactive color will fade depending on trigger value) or OnOff (actvice color is used for triger values >0, otherwise inactive color will be used).

Definition at line 56 of file AnalogToyValueEffect.cs.

AnalogAlpha DirectOutput.FX.AnalogToyFX.AnalogToyValueEffect.InactiveValue

getset

Gets or sets the value which is set on the specified layer of the referenced AnalogToy object if this effect is triggered with a TableElementData instance having a Value which is zero.

The inactive value and alpha channel between 0 and 255.

Definition at line 41 of file AnalogToyValueEffect.cs.

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

C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/FX/AnalogToyFX/AnalogToyValueEffect.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation