WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType > Class Template Referenceabstract
Inheritance diagram for DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >:
DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType > DirectOutput.FX.EffectBase DirectOutput.FX.MatrixFX.IMatrixEffect DirectOutput.General.Generic.NamedItemBase DirectOutput.FX.IEffect DirectOutput.FX.IEffect DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem

Public Member Functions

override void Trigger (Table.TableElementData TableElementData)
 
- Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
override void Init (Table.Table Table)
 Initializes the effect. Resolves object references. More...
 
override void Finish ()
 Finishes the effect and releases object references 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 Member Functions

abstract MatrixElementType GetEffectValue (int TriggerValue, double Time, double Value, double X, double Y)
 
- 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

int PlasmaSpeed [get, set]
 Gets or sets the plasma speed. Default is 100. More...
 
int PlasmaScale [get, set]
 Gets or sets the plasma scale. Defaults to 100. Higher values will give plasma effects with a higher density/more ripples. More...
 
int PlasmaDensity [get, set]
 Gets or sets the plasma density. Default is 100. More...
 
bool Active [get]
 
- Properties inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
string ToyName [get, set]
 Gets or sets the name of the toy which is to be controlled by the effect. More...
 
IMatrixToy< MatrixElementType > Matrix [get]
 Gets the matrix toy which is referenced by the ToyName property. This property is initialized by the Init method. More...
 
float Width [get, set]
 Gets or sets the width in percent of target area of the ledstrip which is controlled by the effect. More...
 
float Height [get, set]
 Gets or sets the height in percent of target area of the matrix which is controlled by the effect. More...
 
float Left [get, set]
 Gets or sets the left resp. X positon of the upper left corner in percent of the target area of the matrix which is controlled by the effect. More...
 
float Top [get, set]
 Gets or sets the top resp. Y positon of the upper left corner in percent of the target area of the ledstrip which is controlled by the effect. More...
 
int LayerNr [get, set]
 Gets or sets the number of the layer which is targeted by the effect. More...
 
FadeModeEnum FadeMode [get, set]
 Gets or sets the fade mode. More...
 
int AreaWidth [get]
 Gets the number of leds on horizontal direction of the area for the effect. More...
 
int AreaHeight [get]
 Gets the number of leds on vertical direction of the area for the effect. More...
 
Table.Table Table [get]
 Gets the table object which was specified during initialisation of the effect. 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...
 
- Properties inherited from DirectOutput.FX.MatrixFX.IMatrixEffect
DirectOutput.FX.FadeModeEnum FadeMode [get, set]
 
float Height [get, set]
 
int LayerNr [get, set]
 
float Left [get, set]
 
float Top [get, set]
 
string ToyName [get, set]
 
float Width [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >
int AreaLeft = 0
 The gets the X position of the led in the upper left corner of the effect area. More...
 
int AreaTop = 0
 The gets the Y position of the led in the upper left corner of the effect area. More...
 
int AreaRight = 0
 The gets the X position of the led in the lower right corner of the effect area. More...
 
int AreaBottom = 0
 The gets the Y position of the led in the lower right corner of the effect area. More...
 
MatrixElementType[,] MatrixLayer
 The layer array of a IRGBAMatrix object as specified by the ToyName and the LayerNr. This reference is initialized by the Init method. More...
 
- 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

Definition at line 9 of file MatrixPlasmaEffectBase.cs.

Member Function Documentation

abstract MatrixElementType DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >.GetEffectValue ( int  TriggerValue,
double  Time,
double  Value,
double  X,
double  Y 
)
protectedpure virtual
override void DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >.Trigger ( Table.TableElementData  TableElementData)

Definition at line 197 of file MatrixPlasmaEffectBase.cs.

Property Documentation

bool DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >.Active
get

Definition at line 71 of file MatrixPlasmaEffectBase.cs.

int DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >.PlasmaDensity
getset

Gets or sets the plasma density. Default is 100.

The plasma density.

Definition at line 54 of file MatrixPlasmaEffectBase.cs.

int DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >.PlasmaScale
getset

Gets or sets the plasma scale. Defaults to 100. Higher values will give plasma effects with a higher density/more ripples.

The plasma scale.

Definition at line 38 of file MatrixPlasmaEffectBase.cs.

int DirectOutput.FX.MatrixFX.MatrixPlasmaEffectBase< MatrixElementType >.PlasmaSpeed
getset

Gets or sets the plasma speed. Default is 100.

The plasma speed.

Definition at line 22 of file MatrixPlasmaEffectBase.cs.


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