WIP
DirectOutput framework for virtual pinball cabinets WIP
|
Go to: Overview |
Base class for effects targeting a matrix of toys (e.g. addressable ledstrip) More...
Public Member Functions | |
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 Attributes | |
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... | |
Properties | |
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 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< NameChangeEventArgs > | AfterNameChanged |
Event is fired after the value of the property Name has changed. More... | |
EventHandler< NameChangeEventArgs > | BeforeNameChanged |
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< NameChangeEventArgs > | BeforeNameChanged |
Occurs before the name of the item changes. More... | |
EventHandler< NameChangeEventArgs > | AfterNameChanged |
Occurs when after the name of the item has 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 > | BeforeNameChanged |
This event must be fired before the Name property of a IEffect object is changed. More... | |
Base class for effects targeting a matrix of toys (e.g. addressable ledstrip)
Definition at line 10 of file MatrixEffectBase.cs.
|
virtual |
Finishes the effect and releases object references
Reimplemented from DirectOutput.FX.EffectBase.
Reimplemented in DirectOutput.FX.MatrixFX.MatrixShiftEffectBase< MatrixElementType >, and DirectOutput.FX.MatrixFX.MatrixFlickerEffectBase< MatrixElementType >.
Definition at line 241 of file MatrixEffectBase.cs.
override void DirectOutput.FX.MatrixFX.MatrixEffectBase< MatrixElementType >.Init | ( | Table.Table | Table | ) |
Initializes the effect. Resolves object references.
Definition at line 213 of file MatrixEffectBase.cs.
|
protected |
The gets the Y position of the led in the lower right corner of the effect area.
Definition at line 159 of file MatrixEffectBase.cs.
|
protected |
The gets the X position of the led in the upper left corner of the effect area.
Definition at line 144 of file MatrixEffectBase.cs.
|
protected |
The gets the X position of the led in the lower right corner of the effect area.
Definition at line 154 of file MatrixEffectBase.cs.
|
protected |
The gets the Y position of the led in the upper left corner of the effect area.
Definition at line 149 of file MatrixEffectBase.cs.
|
protected |
The layer array of a IRGBAMatrix object as specified by the ToyName and the LayerNr. This reference is initialized by the Init method.
A IRGBAMatrix object layer array.
Definition at line 205 of file MatrixEffectBase.cs.
|
getprotected |
Gets the number of leds on vertical direction of the area for the effect.
The number of leds on vertical direction of the area for the effect.
Definition at line 181 of file MatrixEffectBase.cs.
|
getprotected |
Gets the number of leds on horizontal direction of the area for the effect.
The number of leds on horizontal direction of the area for the effect.
Definition at line 169 of file MatrixEffectBase.cs.
|
getset |
Gets or sets the fade mode.
Fade (active and inactive values/color will fade depending on trigger value) or OnOff (actvice value/color is used for trigger values >0, otherwise inactive value/color will be used).
Definition at line 132 of file MatrixEffectBase.cs.
|
getset |
Gets or sets the height in percent of target area of the matrix which is controlled by the effect.
The height in percent of the target area for the effect (0-100).
Definition at line 72 of file MatrixEffectBase.cs.
|
getset |
Gets or sets the number of the layer which is targeted by the effect.
The number of the target layer for the effect.
Definition at line 117 of file MatrixEffectBase.cs.
|
getset |
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.
The left resp. X position of the upper left corner in percent of the target area for the effect (0-100).
Definition at line 86 of file MatrixEffectBase.cs.
|
getprotected |
Gets the matrix toy which is referenced by the ToyName property. This property is initialized by the Init method.
The matrix toy which is referenced by the ToyName property.
Definition at line 44 of file MatrixEffectBase.cs.
|
getprotected |
Gets the table object which was specified during initialisation of the effect.
The table object which was specified during initialisation of the effect..
Definition at line 192 of file MatrixEffectBase.cs.
|
getset |
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.
The top resp. Y position of the upper left corner in percent of the target area for the effect (0-100).
Definition at line 100 of file MatrixEffectBase.cs.
|
getset |
Gets or sets the name of the toy which is to be controlled by the effect.
The name of the toy which is controlled by the effect.
Definition at line 23 of file MatrixEffectBase.cs.
|
getset |
Gets or sets the width in percent of target area of the ledstrip which is controlled by the effect.
The width in percent of the target area for the effect (0-100).
Definition at line 58 of file MatrixEffectBase.cs.