DirectOutput
DirectOutput framework R3 for virtual pinball cabinets.
Loading...
Searching...
No Matches
DirectOutput.Table.Table Class Reference

Holds all table specific information and handles all TableElements. More...

Public Member Functions

void UpdateTableElement (TableElementData Data)
 Updates the TableElements list with data received from Pinmame.
void TriggerStaticEffects ()
 Triggers the static effects for the table.
void Init (Pinball Pinball)
 Initializes the table and the contained objects(Effects, TableElements).
void Finish ()
 Finishes the table and the contained objects (Effects, TableElements)
string GetConfigXml ()
 Returns a serialized XML representation of the Table configuration.
void SaveConfigXmlFile (string FileName)
 Serializes the Table configuration to a XML file.
 Table ()
 Initializes a new instance of the Table class.

Static Public Member Functions

static Table GetTableFromConfigXmlFile (string FileName)
 Instanciates a Table object from a Table configuration in a XML file.
static Table GetTableFromConfigXmlFile (FileInfo TableConfigFile)
 Instanciates a Table object from a Table configuration in a XML file.
static Table GetTableFromConfigXml (string ConfigXml)
 Instanciates a Table object from a Table configuration in a XML string.

Properties

TableElementList TableElements [get, set]
 Lists the TableElement objects for the Table.
This list is automaticaly extend with new TableElement objects if updates for non existing elements are received.
Pinball Pinball [get]
 Gets the pinball object to which the Table object belongs.
FastImageList Bitmaps [get]
 Gets or sets the list of bitmaps.
ShapeDefinitions ShapeDefinitions [get, set]
 Gets or sets the shape definitions.
string TableName [get, set]
 Name of the Table.
Triggers TableNameChanged if value is changed.
string RomName [get, set]
 Name of the table rom.
Triggers RomNameChanged if value is changed.
string TableFilename [get, set]
 Gets or sets the filename of the table.
string TableConfigurationFilename [get, set]
 Gets or sets the table configuration filename.
bool AddLedControlConfig [get, set]
 Gets or sets a value indicating whether configurations from ledcontrol files should be added to the table config from a xml table config file.
TableConfigSourceEnum ConfigurationSource [get, set]
 Gets or sets the configuration source.
EffectList Effects [get, set]
 List of table specific effects.
AssignedEffectList AssignedStaticEffects [get, set]
 Gets or sets the static effects list for the table.
AssignedEffects contained in AssignedStaticEffects are triggered when the Table is started. The Trigger method is called with null as the TableElement parameter.

Events

EventHandler< EventArgs > TableNameChanged
 Event is fired if the value of the property TableName is changed.
EventHandler< EventArgs > RomNameChanged
 Event is fired if the value of the property RomName is changed.

Detailed Description

Holds all table specific information and handles all TableElements.

Constructor & Destructor Documentation

◆ Table()

DirectOutput.Table.Table.Table ( )

Initializes a new instance of the Table class.

Member Function Documentation

◆ Finish()

void DirectOutput.Table.Table.Finish ( )

Finishes the table and the contained objects (Effects, TableElements)

◆ GetConfigXml()

string DirectOutput.Table.Table.GetConfigXml ( )

Returns a serialized XML representation of the Table configuration.

Returns
XMLString

◆ GetTableFromConfigXml()

Table DirectOutput.Table.Table.GetTableFromConfigXml ( string ConfigXml)
static

Instanciates a Table object from a Table configuration in a XML string.

Parameters
ConfigXmlXML string
Returns
Table object

◆ GetTableFromConfigXmlFile() [1/2]

Table DirectOutput.Table.Table.GetTableFromConfigXmlFile ( FileInfo TableConfigFile)
static

Instanciates a Table object from a Table configuration in a XML file.

Parameters
TableConfigFileFileInfo object for the config file.
Returns
Table object

◆ GetTableFromConfigXmlFile() [2/2]

Table DirectOutput.Table.Table.GetTableFromConfigXmlFile ( string FileName)
static

Instanciates a Table object from a Table configuration in a XML file.

Parameters
FileNameName of the XML file.
Returns
Table object

◆ Init()

void DirectOutput.Table.Table.Init ( Pinball Pinball)

Initializes the table and the contained objects(Effects, TableElements).

Parameters
PinballThe Pinball object containing the Table.

◆ SaveConfigXmlFile()

void DirectOutput.Table.Table.SaveConfigXmlFile ( string FileName)

Serializes the Table configuration to a XML file.

Parameters
FileNameName of the XML file.

◆ TriggerStaticEffects()

void DirectOutput.Table.Table.TriggerStaticEffects ( )

Triggers the static effects for the table.

◆ UpdateTableElement()

void DirectOutput.Table.Table.UpdateTableElement ( TableElementData Data)

Updates the TableElements list with data received from Pinmame.

Parameters
DataData received from Pinmame and handled by the PinMameInputManger

Property Documentation

◆ AddLedControlConfig

bool DirectOutput.Table.Table.AddLedControlConfig
getset

Gets or sets a value indicating whether configurations from ledcontrol files should be added to the table config from a xml table config file.

true will add ledcontrol configs, false (default) will ingnore ledcontrol configs.

◆ AssignedStaticEffects

AssignedEffectList DirectOutput.Table.Table.AssignedStaticEffects
getset

Gets or sets the static effects list for the table.
AssignedEffects contained in AssignedStaticEffects are triggered when the Table is started. The Trigger method is called with null as the TableElement parameter.

The static effects list.

◆ Bitmaps

FastImageList DirectOutput.Table.Table.Bitmaps
get

Gets or sets the list of bitmaps.

The bitmaps list.

◆ ConfigurationSource

TableConfigSourceEnum DirectOutput.Table.Table.ConfigurationSource
getset

Gets or sets the configuration source.

The configuration source.

◆ Effects

EffectList DirectOutput.Table.Table.Effects
getset

List of table specific effects.

◆ Pinball

Pinball DirectOutput.Table.Table.Pinball
get

Gets the pinball object to which the Table object belongs.

The pinball object to which the Table object belongs.

◆ RomName

string DirectOutput.Table.Table.RomName
getset

Name of the table rom.
Triggers RomNameChanged if value is changed.

◆ ShapeDefinitions

ShapeDefinitions DirectOutput.Table.Table.ShapeDefinitions
getset

Gets or sets the shape definitions.

The shape definitions.

◆ TableConfigurationFilename

string DirectOutput.Table.Table.TableConfigurationFilename
getset

Gets or sets the table configuration filename.

The table configuration filename.

◆ TableElements

TableElementList DirectOutput.Table.Table.TableElements
getset

Lists the TableElement objects for the Table.
This list is automaticaly extend with new TableElement objects if updates for non existing elements are received.

◆ TableFilename

string DirectOutput.Table.Table.TableFilename
getset

Gets or sets the filename of the table.

The filename of the table.

◆ TableName

string DirectOutput.Table.Table.TableName
getset

Name of the Table.
Triggers TableNameChanged if value is changed.

Event Documentation

◆ RomNameChanged

EventHandler<EventArgs> DirectOutput.Table.Table.RomNameChanged

Event is fired if the value of the property RomName is changed.

◆ TableNameChanged

EventHandler<EventArgs> DirectOutput.Table.Table.TableNameChanged

Event is fired if the value of the property TableName is changed.

The documentation for this class was generated from the following file:
  • D:/a/DirectOutput/DirectOutput/DirectOutput/Table/Table.cs