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.LedControl.Loader.TableConfigSetting Class Reference

A single setting from a LedControl.ini file. More...

Public Member Functions

void ParseSettingData (string SettingData)
 Parses the setting data.
More...
 
 TableConfigSetting (string SettingData)
 Initializes a new instance of the TableConfigSetting class. Parses the setting data.
More...
 
 TableConfigSetting ()
 Initializes a new instance of the TableConfigSetting class. More...
 

Public Attributes

string TableElement = null
 The table element triggering the effect (if available) More...
 
string Condition = null
 The condition if available. More...
 
int BlinkLow
 
int AreaLeft = 0
 
int AreaTop = 0
 
int AreaWidth = 100
 
int AreaHeight = 100
 
int AreaSpeed = 100
 
int AreaAcceleration = 0
 
int AreaFlickerDensity = 0
 
int AreaFlickerMinDurationMs = 0
 
int AreaFlickerMaxDurationMs = 0
 
MatrixShiftDirectionEnum AreaDirection = null
 
bool IsArea = false
 
bool IsBitmap = false
 
int AreaBitmapTop = 0
 
int AreaBitmapLeft = 0
 
int AreaBitmapWidth = -1
 
int AreaBitmapHeight = -1
 
int AreaBitmapFrame =0
 
int AreaBitmapAnimationStepSize = 1
 
int AreaBitmapAnimationStepCount = 0
 
int AreaBitmapAnimationFrameDuration = 30
 
MatrixAnimationStepDirectionEnum AreaBitmapAnimationDirection = MatrixAnimationStepDirectionEnum.Frame
 
AnimationBehaviourEnum AreaBitmapAnimationBehaviour = AnimationBehaviourEnum.Loop
 

Properties

OutputControlEnum OutputControl [get, set]
 Defines the control mode for a output. It can be constantly on, off or it can be controlled by a element of a pinball table. More...
 
string ColorName [get, set]
 Gets or sets the name of the color of the setting.
This should only be set for RGB outputs. More...
 
ColorConfig ColorConfig [get, set]
 Gets or sets the color config. More...
 
OutputTypeEnum OutputType [get]
 Gets the type of the output.
The value of this property depends on the value of the ColorName property. More...
 
int DurationMs [get, set]
 Gets or sets the duration in milliseconds. More...
 
int MinDurationMs [get, set]
 Gets or sets the minimum duration in milliseconds. More...
 
int MaxDurationMs [get, set]
 Gets or sets the max duration for the effect in milliseconds. More...
 
int ExtDurationMs [get, set]
 Gets or sets the extended duration for the effect in milliseconds. More...
 
int Intensity [get, set]
 Gets or sets the intensity.
If the property ColorName is set, this property will always return -1. More...
 
int FadingUpDurationMs [get, set]
 Gets or sets the duration for fading up in milliseconds. More...
 
int FadingDownDurationMs [get, set]
 Gets or sets the duration for fading down in milliseconds. More...
 
int Blink [get, set]
 Gets or sets the number blinks. More...
 
int BlinkIntervalMs [get, set]
 Gets or sets the blink interval in milliseconds. More...
 
int BlinkIntervalMsNested [get, set]
 Gets or sets the blink interval in milliseconds for nested blinking. More...
 
int BlinkPulseWidthNested [get, set]
 Gets or sets the width of the blink pulse for nested blinking. Value must be between 1 and 99 (defaults to 50). More...
 
int BlinkPulseWidth [get, set]
 Gets or sets the width of the blink pulse. Value must be between 1 and 99 (defaults to 50). More...
 
bool Invert [get, set]
 Gets or sets a value indicating whether the trigger value for the effect is inverted. More...
 
bool NoBool [get, set]
 Indicates the the trigger value of the effect is not to be treated as a boolean value resp. that the value should not be mapped to 0 or 255 (255 for all values which are not 0). More...
 
int WaitDurationMs [get, set]
 Gets or sets the wait duration before the effect is triggered. More...
 
int Layer [get, set]
 Gets or sets the layer for the settings. More...
 

Detailed Description

A single setting from a LedControl.ini file.

Definition at line 9 of file TableConfigSetting.cs.

Constructor & Destructor Documentation

DirectOutput.LedControl.Loader.TableConfigSetting.TableConfigSetting ( string  SettingData)
inline

Initializes a new instance of the TableConfigSetting class. Parses the setting data.

Parameters
SettingDataThe setting data.
Exceptions
System.ExceptionNo data to parse.
or
Cant parse the part {0} of the ledcontrol table config setting {1}.

Definition at line 677 of file TableConfigSetting.cs.

DirectOutput.LedControl.Loader.TableConfigSetting.TableConfigSetting ( )
inline

Initializes a new instance of the TableConfigSetting class.

Definition at line 688 of file TableConfigSetting.cs.

Member Function Documentation

void DirectOutput.LedControl.Loader.TableConfigSetting.ParseSettingData ( string  SettingData)
inline

Parses the setting data.

Parameters
SettingDataThe setting data.
Exceptions
System.ExceptionNo data to parse. or Cant parse the part {0} of the ledcontrol table config setting {1}..
Todo:
Maybe add a check for the condition validity

Definition at line 277 of file TableConfigSetting.cs.

Member Data Documentation

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaAcceleration = 0

Definition at line 248 of file TableConfigSetting.cs.

AnimationBehaviourEnum DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapAnimationBehaviour = AnimationBehaviourEnum.Loop

Definition at line 266 of file TableConfigSetting.cs.

MatrixAnimationStepDirectionEnum DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapAnimationDirection = MatrixAnimationStepDirectionEnum.Frame

Definition at line 265 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapAnimationFrameDuration = 30

Definition at line 264 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapAnimationStepCount = 0

Definition at line 263 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapAnimationStepSize = 1

Definition at line 262 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapFrame =0

Definition at line 260 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapHeight = -1

Definition at line 259 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapLeft = 0

Definition at line 257 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapTop = 0

Definition at line 256 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaBitmapWidth = -1

Definition at line 258 of file TableConfigSetting.cs.

MatrixShiftDirectionEnum DirectOutput.LedControl.Loader.TableConfigSetting.AreaDirection = null

Definition at line 252 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaFlickerDensity = 0

Definition at line 249 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaFlickerMaxDurationMs = 0

Definition at line 251 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaFlickerMinDurationMs = 0

Definition at line 250 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaHeight = 100

Definition at line 246 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaLeft = 0

Definition at line 243 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaSpeed = 100

Definition at line 247 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaTop = 0

Definition at line 244 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.AreaWidth = 100

Definition at line 245 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.BlinkLow

Definition at line 206 of file TableConfigSetting.cs.

string DirectOutput.LedControl.Loader.TableConfigSetting.Condition = null

The condition if available.

Definition at line 50 of file TableConfigSetting.cs.

bool DirectOutput.LedControl.Loader.TableConfigSetting.IsArea = false

Definition at line 253 of file TableConfigSetting.cs.

bool DirectOutput.LedControl.Loader.TableConfigSetting.IsBitmap = false

Definition at line 255 of file TableConfigSetting.cs.

string DirectOutput.LedControl.Loader.TableConfigSetting.TableElement = null

The table element triggering the effect (if available)

Definition at line 44 of file TableConfigSetting.cs.

Property Documentation

int DirectOutput.LedControl.Loader.TableConfigSetting.Blink
getset

Gets or sets the number blinks.

The number of blinks. -1 means infinite number of blinks.

Definition at line 156 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.BlinkIntervalMs
getset

Gets or sets the blink interval in milliseconds.

The blink interval in milliseconds.

Definition at line 164 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.BlinkIntervalMsNested
getset

Gets or sets the blink interval in milliseconds for nested blinking.

The blink interval in milliseconds for nested blinking.

Definition at line 173 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.BlinkPulseWidth
getset

Gets or sets the width of the blink pulse. Value must be between 1 and 99 (defaults to 50).

The width of the blink pulse.

Definition at line 200 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.BlinkPulseWidthNested
getset

Gets or sets the width of the blink pulse for nested blinking. Value must be between 1 and 99 (defaults to 50).

The width of the blink pulse for nested blinking.

Definition at line 185 of file TableConfigSetting.cs.

ColorConfig DirectOutput.LedControl.Loader.TableConfigSetting.ColorConfig
getset

Gets or sets the color config.

The color config.

Definition at line 38 of file TableConfigSetting.cs.

string DirectOutput.LedControl.Loader.TableConfigSetting.ColorName
getset

Gets or sets the name of the color of the setting.
This should only be set for RGB outputs.

The name of the color as specified in the color section of the Ledcontrol.ini file.

Definition at line 28 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.DurationMs
getset

Gets or sets the duration in milliseconds.

The duration in milliseconds.

Definition at line 74 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.ExtDurationMs
getset

Gets or sets the extended duration for the effect in milliseconds.

The extended duration of the effect in milliseconds.

Definition at line 105 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.FadingDownDurationMs
getset

Gets or sets the duration for fading down in milliseconds.

The duration of the fading in milliseconds.

Definition at line 145 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.FadingUpDurationMs
getset

Gets or sets the duration for fading up in milliseconds.

The duration of the fading in milliseconds.

Definition at line 131 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.Intensity
getset

Gets or sets the intensity.
If the property ColorName is set, this property will always return -1.

The intensity.

Definition at line 116 of file TableConfigSetting.cs.

bool DirectOutput.LedControl.Loader.TableConfigSetting.Invert
getset

Gets or sets a value indicating whether the trigger value for the effect is inverted.

true if invert; otherwise, false.

Definition at line 214 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.Layer
getset

Gets or sets the layer for the settings.

The layer for the settings.

Definition at line 240 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.MaxDurationMs
getset

Gets or sets the max duration for the effect in milliseconds.

The max duration of the effect in milliseconds.

Definition at line 97 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.MinDurationMs
getset

Gets or sets the minimum duration in milliseconds.

The minimum duration in milliseconds.

Definition at line 85 of file TableConfigSetting.cs.

bool DirectOutput.LedControl.Loader.TableConfigSetting.NoBool
getset

Indicates the the trigger value of the effect is not to be treated as a boolean value resp. that the value should not be mapped to 0 or 255 (255 for all values which are not 0).

true if [no bool]; otherwise, false.

Definition at line 222 of file TableConfigSetting.cs.

OutputControlEnum DirectOutput.LedControl.Loader.TableConfigSetting.OutputControl
getset

Defines the control mode for a output. It can be constantly on, off or it can be controlled by a element of a pinball table.

The output control enum value.

Definition at line 19 of file TableConfigSetting.cs.

OutputTypeEnum DirectOutput.LedControl.Loader.TableConfigSetting.OutputType
get

Gets the type of the output.
The value of this property depends on the value of the ColorName property.

The type of the output.

Definition at line 61 of file TableConfigSetting.cs.

int DirectOutput.LedControl.Loader.TableConfigSetting.WaitDurationMs
getset

Gets or sets the wait duration before the effect is triggered.

The wait duration in milliseconds

Definition at line 231 of file TableConfigSetting.cs.


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