WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType > Class Template Reference

This toys allows the grouping of several toys into a matrix, which can be controlled by matrix effects. More...

Inheritance diagram for DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >:
DirectOutput.Cab.Toys.ToyBaseUpdatable DirectOutput.Cab.Toys.IToy DirectOutput.Cab.Toys.IMatrixToy< MatrixElementType > DirectOutput.Cab.Toys.ToyBase DirectOutput.Cab.Toys.IToyUpdatable DirectOutput.General.Generic.INamedItem DirectOutput.Cab.Toys.IToy DirectOutput.General.Generic.NamedItemBase DirectOutput.Cab.Toys.IToy DirectOutput.Cab.Toys.IToy DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem

Public Member Functions

override void UpdateOutputs ()
 Updates the toys specified in the toy names array with the values from the layers of this toy. More...
 
override void Init (Cabinet Cabinet)
 Initializes the toy. More...
 
override void Reset ()
 Resets the state of the IToy to its default state. More...
 
override void Finish ()
 Finished the toy, releases references to toys and layers. More...
 
MatrixElementType[,] GetLayer (int LayerNr)
 Gets the 2 dimensional data array for the specified layer. More...
 

Properties

List< List< string > > ToyNames [get, set]
 Gets or sets the 2-dimensional array of rgba toy names. More...
 
int LayerOffset [get, set]
 Gets or sets the layer offset.
The layer offset defines a fixed positive or negative offset to the layers which are controlled on the target toy. More...
 
MatrixDictionaryBase< MatrixElementType > Layers [get]
 Gets the layers dictionary of the toy. More...
 
int Height [get]
 Gets the height resp. the y dimension of the toys matrix. More...
 
int Width [get]
 Gets the width resp. the x dimension of the toys matrix. 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.Cab.Toys.IToy
new string Name [get, set]
 Gets or sets the Name of the IToy. More...
 
- Properties inherited from DirectOutput.Cab.Toys.IMatrixToy< MatrixElementType >
int Height [get]
 Gets the height resp. the y dimension of the toys matrix. More...
 
int Width [get]
 Gets the width resp. the x dimension of the toys matrix. 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...
 

Detailed Description

This toys allows the grouping of several toys into a matrix, which can be controlled by matrix effects.

Note
Be sure to define this toy in the cabinet config file before the toys, which are listed in the ToyNames array.
Type Constraints
MatrixElementType :new() 

Definition at line 15 of file ToyGroupBase.cs.

Member Function Documentation

override void DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.Finish ( )

Finished the toy, releases references to toys and layers.

Implements DirectOutput.Cab.Toys.IToy.

Definition at line 131 of file ToyGroupBase.cs.

MatrixElementType [,] DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.GetLayer ( int  LayerNr)

Gets the 2 dimensional data array for the specified layer.

Dimension 0 of the array represents the x resp. horizontal direction. Dimension 1 of the array repersent the y resp. vertical direction. Position 0,0 is the upper left corner of the array.

Parameters
LayerNrThe layer nr.
Returns
The data array for the specified layer.

Implements DirectOutput.Cab.Toys.IMatrixToy< MatrixElementType >.

Definition at line 160 of file ToyGroupBase.cs.

override void DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.Init ( Cabinet  Cabinet)

Initializes the toy.

Parameters
CabinetCabinet object to which the IToy belongs.

Implements DirectOutput.Cab.Toys.IToy.

Definition at line 81 of file ToyGroupBase.cs.

override void DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.Reset ( )

Resets the state of the IToy to its default state.

Implements DirectOutput.Cab.Toys.IToy.

Definition at line 123 of file ToyGroupBase.cs.

override void DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.UpdateOutputs ( )
virtual

Updates the toys specified in the toy names array with the values from the layers of this toy.

Implements DirectOutput.Cab.Toys.ToyBaseUpdatable.

Definition at line 56 of file ToyGroupBase.cs.

Property Documentation

int DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.Height
get

Gets the height resp. the y dimension of the toys matrix.

The height resp. the y dimension of the toys matrix.

Definition at line 172 of file ToyGroupBase.cs.

int DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.LayerOffset
getset

Gets or sets the layer offset.
The layer offset defines a fixed positive or negative offset to the layers which are controlled on the target toy.

The layer offset which defines a fixed positive or negative offset to the layers which are controlled on the target toy..

Definition at line 47 of file ToyGroupBase.cs.

MatrixDictionaryBase<MatrixElementType> DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.Layers
get

Gets the layers dictionary of the toy.

The layers dictionary of the toy.

Definition at line 147 of file ToyGroupBase.cs.

List<List<string> > DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.ToyNames
getset

Gets or sets the 2-dimensional array of rgba toy names.

The 2 dimensional array of RGBA toy names.

Definition at line 29 of file ToyGroupBase.cs.

int DirectOutput.Cab.Toys.Virtual.ToyGroupBase< MatrixElementType >.Width
get

Gets the width resp. the x dimension of the toys matrix.

The width resp. the x dimension of the toys matrix.

Definition at line 187 of file ToyGroupBase.cs.


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