DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase Class Reference

Base class for effects controlling a single AnalogToy object. More...

Inheritance diagram for DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase:
Collaboration diagram for DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase:

Public Member Functions

override void Init (Table.Table Table)
 Initializes the effect. More...
 
override void Finish ()
 Finish does all necessary cleanupwork before the effect is discarded. 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

Table.Table Table
 The table which contains the effect. More...
 

Properties

string ToyName [get, set]
 Name of the AnalogToy. More...
 
AnalogAlpha Layer [get, set]
 
int LayerNr [get, set]
 Gets or sets the number of the layer for the AnalogToy effect (Default=0). More...
 
IAnalogAlphaToy Toy [get, set]
 Refrence to the AnalogToyy specified in the ToyName property.
If the ToyName property is empty or contains a unknown name or the name of a toy which is not a AnalogToy this property will return null. 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.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
BeforeNameChange
 This event must be fired before the Name property of a IEffect object is changed. More...
 

Detailed Description

Base class for effects controlling a single AnalogToy object.

Member Function Documentation

override void DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Finish ( )
virtual

Finish does all necessary cleanupwork before the effect is discarded.

Reimplemented from DirectOutput.FX.EffectBase.

override void DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Init ( Table.Table  Table)

Initializes the effect.

Parameters
TableTable object containing the effect.

Member Data Documentation

Table.Table DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Table
protected

The table which contains the effect.

Property Documentation

AnalogAlpha DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Layer
getsetprotected
int DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.LayerNr
getset

Gets or sets the number of the layer for the AnalogToy effect (Default=0).

The layer number.

IAnalogAlphaToy DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.Toy
getsetprotected

Refrence to the AnalogToyy specified in the ToyName property.
If the ToyName property is empty or contains a unknown name or the name of a toy which is not a AnalogToy this property will return null.

string DirectOutput.FX.AnalogToyFX.AnalogToyEffectBase.ToyName
getset

Name of the AnalogToy.

The name of the AnalogToy.


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