WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.FX.RGBAFX.RGBAColorEffect Class Reference

The effects sets the color of a RGBAToy based on the trigger value. More...

Inheritance diagram for DirectOutput.FX.RGBAFX.RGBAColorEffect:
DirectOutput.FX.RGBAFX.RGBAEffectBase DirectOutput.FX.EffectBase DirectOutput.General.Generic.NamedItemBase DirectOutput.FX.IEffect DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem

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.
Resolves the name of the RGBA toy. More...
 
override void Finish ()
 Finishes the effect. More...
 
- Public Member Functions inherited from DirectOutput.FX.RGBAFX.RGBAEffectBase
override void Init (Table.Table Table)
 Initializes the RGBA effect.
Resolves the name of the RGBA toy. More...
 
override void Finish ()
 Finishes the RGBA effect. 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

RGBAColor ActiveColor [get, set]
 Gets or sets the active color. The FadeMode property defines how this value is used. More...
 
RGBAColor InactiveColor [get, set]
 Gets or sets the inactive color. The FadeMode property defines how this value is used. More...
 
FadeModeEnum FadeMode [get, set]
 Gets or sets the fade mode. More...
 
- Properties inherited from DirectOutput.FX.RGBAFX.RGBAEffectBase
string ToyName [get, set]
 Name of the RGBAToy. More...
 
RGBAColor Layer [get]
 
int LayerNr [get, set]
 Gets or sets the number of the layer for the RGBA effect (Default=0). More...
 
IRGBAToy RGBAToy [get]
 Refrence to the RGBA Toy specified in the RGBAToyName property.
If the RGBAToyName property is empty or contains a unknown name or the name of a toy which is not a IRGBAToy 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.RGBAFX.RGBAEffectBase
Table.Table Table
 
- Events inherited from DirectOutput.General.Generic.NamedItemBase
EventHandler< NameChangeEventArgsAfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgsBeforeNameChanged
 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< NameChangeEventArgsBeforeNameChanged
 Occurs before the name of the item changes. More...
 
EventHandler< NameChangeEventArgsAfterNameChanged
 Occurs when after the name of the item has changed. More...
 
- Events inherited from DirectOutput.FX.IEffect
new EventHandler< NameChangeEventArgsAfterNameChanged
 This event must be fired after the Name property of a IEffect object has changed. More...
 
new EventHandler< NameChangeEventArgsBeforeNameChanged
 This event must be fired before the Name property of a IEffect object is changed. More...
 

Detailed Description

The effects sets the color of a RGBAToy based on the trigger value.

Depending on the setting of the FadeMode property, the effect uses the active or inactive color or a mix of those colors.

Definition at line 14 of file RGBAColorEffect.cs.

Member Function Documentation

override void DirectOutput.FX.RGBAFX.RGBAColorEffect.Finish ( )
virtual

Finishes the effect.

Reimplemented from DirectOutput.FX.EffectBase.

Definition at line 96 of file RGBAColorEffect.cs.

override void DirectOutput.FX.RGBAFX.RGBAColorEffect.Init ( Table.Table  Table)

Initializes the effect.
Resolves the name of the RGBA toy.

Parameters
TableTable object containing the effect.

Definition at line 88 of file RGBAColorEffect.cs.

override void DirectOutput.FX.RGBAFX.RGBAColorEffect.Trigger ( Table.TableElementData  TableElementData)

Triggers the effect with the given TableElementData.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Definition at line 67 of file RGBAColorEffect.cs.

Property Documentation

RGBAColor DirectOutput.FX.RGBAFX.RGBAColorEffect.ActiveColor
getset

Gets or sets the active color. The FadeMode property defines how this value is used.

The active color.

Definition at line 27 of file RGBAColorEffect.cs.

FadeModeEnum DirectOutput.FX.RGBAFX.RGBAColorEffect.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 57 of file RGBAColorEffect.cs.

RGBAColor DirectOutput.FX.RGBAFX.RGBAColorEffect.InactiveColor
getset

Gets or sets the inactive color. The FadeMode property defines how this value is used.

The inactive color.

Definition at line 42 of file RGBAColorEffect.cs.


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