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

Base class for effects using RGBA toys More...

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

Public Member Functions

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

Protected Attributes

Table.Table Table
 

Properties

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

Base class for effects using RGBA toys

Definition at line 15 of file RGBAEffectBase.cs.

Member Function Documentation

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

Finishes the RGBA effect.

Reimplemented from DirectOutput.FX.EffectBase.

Definition at line 106 of file RGBAEffectBase.cs.

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

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

Parameters
TableTable object containing the effect.

Definition at line 89 of file RGBAEffectBase.cs.

Member Data Documentation

Table.Table DirectOutput.FX.RGBAFX.RGBAEffectBase.Table
protected

Definition at line 17 of file RGBAEffectBase.cs.

Property Documentation

RGBAColor DirectOutput.FX.RGBAFX.RGBAEffectBase.Layer
getprotected

Definition at line 44 of file RGBAEffectBase.cs.

int DirectOutput.FX.RGBAFX.RGBAEffectBase.LayerNr
getset

Gets or sets the number of the layer for the RGBA effect (Default=0).

The layer number.

Definition at line 57 of file RGBAEffectBase.cs.

IRGBAToy DirectOutput.FX.RGBAFX.RGBAEffectBase.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.

Definition at line 72 of file RGBAEffectBase.cs.

string DirectOutput.FX.RGBAFX.RGBAEffectBase.ToyName
getset

Name of the RGBAToy.

The name of the RGBAToy.

Definition at line 29 of file RGBAEffectBase.cs.


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