DirectOuput Framework R2
DirectOutput framework R2 for virtual pinball cabinets
Go to:
Overview 
 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.

Definition at line 15 of file AnalogAlphaToy.cs.

Constructor & Destructor Documentation

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

Initializes a new instance of the AnalogAlphaToy class.

Definition at line 191 of file AnalogAlphaToy.cs.

Member Function Documentation

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

Resets the toy and releases all references

Implements DirectOutput.Cab.Toys.IToy.

Definition at line 166 of file AnalogAlphaToy.cs.

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

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

Returns
A analog value.

Definition at line 31 of file AnalogAlphaToy.cs.

override void DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Init ( Cabinet  Cabinet)
inline

Initializes the toy.

Parameters
CabinetCabinet object to which the IToy belongs.

Implements DirectOutput.Cab.Toys.IToy.

Definition at line 128 of file AnalogAlphaToy.cs.

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

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

Implements DirectOutput.Cab.Toys.IToy.

Definition at line 179 of file AnalogAlphaToy.cs.

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

Updates the output of the toy.

Implements DirectOutput.Cab.Toys.ToyBaseUpdatable.

Definition at line 153 of file AnalogAlphaToy.cs.

Member Data Documentation

Cabinet DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Cabinet
protected

Definition at line 121 of file AnalogAlphaToy.cs.

Curve DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.FadingCurve = null
protected

Definition at line 75 of file AnalogAlphaToy.cs.

IOutput DirectOutput.Cab.Toys.Layer.AnalogAlphaToy.Output
protected

Definition at line 58 of file AnalogAlphaToy.cs.

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.

Definition at line 85 of file AnalogAlphaToy.cs.

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

Gets the layers dictionary.

The layers dictionary.

Definition at line 25 of file AnalogAlphaToy.cs.

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.

Definition at line 67 of file AnalogAlphaToy.cs.


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