DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.Cab.Toys.Layer.AnalogAlphaToy Class Reference

This toy handles analog values (0-255) in a layer structure including alpha value (0=completely transparent, 255=fully opaque) and outputs the belended result of the layers on a single output. More...

Inheritance diagram for DirectOutput.Cab.Toys.Layer.AnalogAlphaToy:
Collaboration diagram for DirectOutput.Cab.Toys.Layer.AnalogAlphaToy:

Public Member Functions

override void Init (Cabinet Cabinet)
 Initializes the toy. More...
 
override void UpdateOutputs ()
 Updates the output of the toy. More...
 
override void Finish ()
 Resets the toy and releases all references More...
 
override void Reset ()
 Resets the toy.
Clears the Layers object and turn off the output (if available). Method must be overwritten. More...
 
 AnalogAlphaToy ()
 Initializes a new instance of the AnalogAlphaToy class. More...
 

Protected Member Functions

int GetResultingValue ()
 Gets the analog value which results from the analog values and alpha values in the dirctionary. More...
 

Protected Attributes

IOutput Output
 
Curve FadingCurve = null
 
Cabinet Cabinet
 

Properties

LayerDictionary< AnalogAlphaLayers [get, set]
 Gets the layers dictionary. More...
 
string OutputName [get, set]
 Gets or sets the name of the IOutput object of the toy. More...
 
string FadingCurveName [get, set]
 Gets or sets the name of the fading curve as defined in the Curves list of the cabinet object. This curve can be used to adjust the output values of the toy to fit the behaviour of the toys hardware and/or human perception. More...
 
- Properties inherited from DirectOutput.Cab.Toys.ISingleOutputToy
string OutputName [get, set]
 Gets or sets the name of the output of the toy. 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.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...
 

Additional Inherited Members

- 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.General.Generic.INamedItem
EventHandler< NameChangeEventArgsBeforeNameChange
 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 toy handles analog values (0-255) in a layer structure including alpha value (0=completely transparent, 255=fully opaque) and outputs the belended result of the layers on a single output.

Constructor & Destructor Documentation

DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.AnalogAlphaToy ( )

Initializes a new instance of the AnalogAlphaToy class.

Member Function Documentation

override void DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Finish ( )

Resets the toy and releases all references

Implements DirectOutput.Cab.Toys.IToy.

int DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.GetResultingValue ( )
protected

Gets the analog value which results from the analog values and alpha values in the dirctionary.

Returns
A analog value.
override void DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Init ( Cabinet  Cabinet)

Initializes the toy.

Parameters
CabinetCabinet object to which the IToy belongs.

Implements DirectOutput.Cab.Toys.IToy.

override void DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Reset ( )

Resets the toy.
Clears the Layers object and turn off the output (if available). Method must be overwritten.

Implements DirectOutput.Cab.Toys.IToy.

override void DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.UpdateOutputs ( )
virtual

Updates the output of the toy.

Implements DirectOutput.Cab.Toys.ToyBaseUpdatable.

Member Data Documentation

Cabinet DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Cabinet
protected
Curve DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.FadingCurve = null
protected
IOutput DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Output
protected

Property Documentation

string DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.FadingCurveName
getset

Gets or sets the name of the fading curve as defined in the Curves list of the cabinet object. This curve can be used to adjust the output values of the toy to fit the behaviour of the toys hardware and/or human perception.

The name of the fading curve.

LayerDictionary<AnalogAlpha> DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Layers
getset

Gets the layers dictionary.

The layers dictionary.

string DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.OutputName
getset

Gets or sets the name of the IOutput object of the toy.

The name of the output.


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