DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
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:
Collaboration diagram for DirectOutput.FX.RGBAFX.RGBAColorEffect:

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, set]
 
int LayerNr [get, set]
 Gets or sets the number of the layer for the RGBA effect (Default=0). More...
 
IRGBAToy RGBAToy [get, set]
 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...
 

Additional Inherited Members

- 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< NameChangeEventArgsBeforeNameChange
 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

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.

Member Function Documentation

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

Finishes the effect.

Reimplemented from DirectOutput.FX.EffectBase.

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

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.

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

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.


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