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:

[legend]

Collaboration diagram for DirectOutput.FX.TimmedFX.FadeEffect:

[legend]

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, set]`
	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, set]`
	Gets the table object which is hosting 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...

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

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.

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.

Property Documentation

int DirectOutput.FX.TimmedFX.FadeEffect.FadeDownDuration

getset

Gets or sets the duration for the fading down.

The duration for the fading down.

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.

int DirectOutput.FX.TimmedFX.FadeEffect.FadeUpDuration

getset

Gets or sets the duration for fading up.

The duration for fading up.

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