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

The namespace FX contains effect related classes.
Effects can be assigned directly to a Table and will be triggered when the Table is stated or the can be assigned to TableElement objects and will be triggered whenever the value of a TableElement changes.
AssignedEffects are triggered by the Table resp. the TableElement objects of the table.
More...

Namespaces

package  AnalogToyFX
 Namespace for effects controlling AnalogToy objects.
 
package  ConditionFX
 Namespace for effects which trigger target effects based on conditions.
 
package  ListFX
 The DirectOutput.FX.ListFX namepsace contains the classes for the ListEffect.
 
package  MatrixFX
 Effects in this namespace are controlling toys which implement the IMatrix interface
 
package  NullFX
 This namespace does only contain the NullEffect.
 
package  RGBAFX
 This namespace contains effects which deal with RGBA toys. /summary>
 
package  TimmedFX
 Namespace for timmed effects (e.g. delay, duration)
 
package  ValueFX
 Effects which influence the trigger value, before a target effect is called.
 

Classes

class  AssignedEffect
 Handles the assignemt of a effect to a AssignedEffectList. More...
 
class  AssignedEffectList
 List of effects which are assigned to some other object. More...
 
class  EffectBase
 Abstract base class for IEffect objects.
This class inherits NamedItemBase and implements IEffect. More...
 
class  EffectEffectBase
 Base class for effects targeting another effect. More...
 
class  EffectEventArgs
 The EffectEventArgs class is used for events triggered by IEffect objects More...
 
class  BeforeEffectNameChangeAventArgs
 EventArgs for the BeforeEffectNameChanged event More...
 
class  EffectList
 Collection of IEffect objects. Every object can only exist once in the list and every objects needs to have a unique name. More...
 
interface  IEffect
 Common interface for all effects.
If a new effect is implemented it is best to inherit from the abstract class Effect which does also inherit IEffect.
All classes inheriting IEffect must be XMLSerializeable. More...
 

Enumerations

enum  FadeModeEnum { Fade, OnOff }
 Defines the fading behaviour. More...
 
enum  RetriggerBehaviourEnum { Restart, Ignore }
 This enum describes the different retrigger behaviours for the effects.
Retriggering means that a effect is getting another Trigger call with the same table element value as the last call, while it is still active. More...
 

Detailed Description

The namespace FX contains effect related classes.
Effects can be assigned directly to a Table and will be triggered when the Table is stated or the can be assigned to TableElement objects and will be triggered whenever the value of a TableElement changes.
AssignedEffects are triggered by the Table resp. the TableElement objects of the table.

Enumeration Type Documentation

Defines the fading behaviour.

Enumerator
Fade 

Fading is enabled.

OnOff 

No fading. There will be a simple on/off behaviour depending on the triggering value.

This enum describes the different retrigger behaviours for the effects.
Retriggering means that a effect is getting another Trigger call with the same table element value as the last call, while it is still active.

Enumerator
Restart 

The effect or its behaviour gets restarted in a retrigger situation.

Ignore 

Retrigger calls are ignored. The effect or its behaviour is not being restarted.