DirectOutputR1
DirectOutput framework R1 for virtual pinball cabinets.
Go to:
Overview 
 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  ListFX
 The DirectOutput.FX.ListFX namepsace contains the classes for the ListEffect.
 
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)
 

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 { CurrentToDefined, DefinedToDefined }
 This enum describes the possible fading modes. More...
 
enum  RetriggerBehaviourEnum { RestartEffect, IgnoreRetrigger }
 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

This enum describes the possible fading modes.

Enumerator
CurrentToDefined 

Fading starts with the current value and fades towards a specified target value (depending on the trigger value either active or inactive value).

DefinedToDefined 

Fadding starts with a defined value (depending on the tigger value either active or in active vallue) and fades towards a specified target value (the other of the 2 defined active resp. inactive values).

Definition at line 11 of file FadeModeEnum.cs.

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
RestartEffect 

The effect gets restarted in a retrigger situation.

IgnoreRetrigger 

Retrigger calls are ignored. The effect is not being restarted.

Definition at line 8 of file RetriggerBehaviourEnum.cs.