This effect fades towards the value passed to the effect in the TableElementData of the trigger methods. It is calling the target effect repeatedly with the changing values. More...

Inheritance diagram for DirectOutput.FX.TimmedFX.FadeEffect:

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

Public Member Functions inherited from DirectOutput.FX.EffectEffectBase
override void	Init (Table.Table Table)
	Initializes the EffectEffect. Resolves the name of the TargetEffect. More...

override void	Finish ()
	Finishes the EffectEffect. Releases the references to the target effect and to the table object. More...

Public Member Functions inherited from DirectOutput.FX.EffectBase
abstract void	Trigger (TableElementData TableElementData)
	Triggers the effect with the given TableElementData. More...

Properties
int	FadeUpDuration `[get, set]`
	Gets or sets the duration for fading up. More...

int	FadeDownDuration `[get, set]`
	Gets or sets the duration for the fading down. More...

FadeEffectDurationModeEnum	FadeDurationMode `[get, set]`
	Gets or sets the fade duration mode. More...

Properties inherited from DirectOutput.FX.EffectEffectBase
string	TargetEffectName `[get, set]`
	Name of the target effect. Triggers EffectNameChanged if value is changed. More...

IEffect	TargetEffect `[get]`
	TargetEffect for the effect (ReadOnly). The property is resolved from the TargetEffectName. If TargetEffectName is empty or unknown this property will return null. More...

Table.Table	Table `[get]`
	Gets the table object which is hosting the effect. 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.FX.EffectEffectBase
void	TriggerTargetEffect (TableElementData TriggerData)
	Triggers the target effect. The method will deactivate the target effect if it throws a exception. More...

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)

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 fades towards the value passed to the effect in the TableElementData of the trigger methods. It is calling the target effect repeatedly with the changing values.

Definition at line 12 of file FadeEffect.cs.

Member Function Documentation

override void DirectOutput.FX.TimmedFX.FadeEffect.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 72 of file FadeEffect.cs.

Property Documentation

int DirectOutput.FX.TimmedFX.FadeEffect.FadeDownDuration

getset

Gets or sets the duration for the fading down.

The duration for the fading down.

Definition at line 40 of file FadeEffect.cs.

FadeEffectDurationModeEnum DirectOutput.FX.TimmedFX.FadeEffect.FadeDurationMode

getset

Gets or sets the fade duration mode.

The fade duration mode.
Depending on the FadeDurationMode the transition from the current to the target value will use one of the duration values directly or use the duration values to determine how long it would take to fade through the whole possible value range and the effective fading duration will depend on the defference between the current and the target value.

Definition at line 55 of file FadeEffect.cs.

int DirectOutput.FX.TimmedFX.FadeEffect.FadeUpDuration

getset

Gets or sets the duration for fading up.

The duration for fading up.

Definition at line 26 of file FadeEffect.cs.

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

C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/FX/TimmedFX/FadeEffect.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation