DirectOutput.FX.ValueFX.ValueMapFullRangeEffect Class Reference

This effects maps the trigger value to the full range of 0 - 255. If the trigger value is 0, the mapped trigger value for the target effect is also 0. If the trigger value is >0, the mapped trigger value for the target effect is 255. More...

Inheritance diagram for DirectOutput.FX.ValueFX.ValueMapFullRangeEffect:

Collaboration diagram for DirectOutput.FX.ValueFX.ValueMapFullRangeEffect:

Public Member Functions
override void	Trigger (Table.TableElementData TableElementData)
	Triggers the effect with the given TableElementData.
Public Member Functions inherited from DirectOutput.FX.EffectEffectBase
override void	Init (Table.Table Table)
	Initializes the EffectEffect. Resolves the name of the TargetEffect.
override void	Finish ()
	Finishes the EffectEffect. Releases the references to the target effect and to the table object.
Public Member Functions inherited from DirectOutput.FX.EffectBase
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.

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.
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.FX.EffectEffectBase
string	TargetEffectName [get, set]
	Name of the target effect. Triggers EffectNameChanged if value is changed.
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.
Table.Table	Table [get]
	Gets the table object which is hosting the effect.
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

This effects maps the trigger value to the full range of 0 - 255. If the trigger value is 0, the mapped trigger value for the target effect is also 0. If the trigger value is >0, the mapped trigger value for the target effect is 255.

Member Function Documentation

Trigger()

override void DirectOutput.FX.ValueFX.ValueMapFullRangeEffect.Trigger

(

Table.TableElementData

TableElementData

)

Triggers the effect with the given TableElementData.

Parameters

TableElementData

TableElementData for the TableElement which has triggered the effect.

---

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

• D:/a/DirectOutput/DirectOutput/DirectOutput/FX/ValueFX/ValueMapFullRangeEffect.cs