DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
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. More...
 
void TriggerStaticEffects ()
 Triggers the static effects for the table. More...
 
void Init (Pinball Pinball)
 Initializes the table and the contained objects(Effects, TableElements). More...
 
void Finish ()
 Finishes the table and the contained objects (Effects, TableElements) More...
 
string GetConfigXml ()
 Returns a serialized XML representation of the Table configuration. More...
 
void SaveConfigXmlFile (string FileName)
 Serializes the Table configuration to a XML file. More...
 
 Table ()
 Initializes a new instance of the Table class. More...
 

Static Public Member Functions

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

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. More...
 
Pinball Pinball [get, set]
 Gets the pinball object to which the Table object belongs. More...
 
FastImageList Bitmaps [get, set]
 Gets or sets the list of bitmaps More...
 
string TableName [get, set]
 Name of the Table.
Triggers TableNameChanged if value is changed. More...
 
string RomName [get, set]
 Name of the table rom.
Triggers RomNameChanged if value is changed. More...
 
string TableFilename [get, set]
 Gets or sets the filename of the table. More...
 
string TableConfigurationFilename [get, set]
 Gets or sets the table configuration filename. More...
 
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. More...
 
TableConfigSourceEnum ConfigurationSource [get, set]
 Gets or sets the configuration source. More...
 
EffectList Effects [get, set]
 List of table specific effects. More...
 
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.
More...
 

Events

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

Detailed Description

Holds all table specific information and handles all TableElements

Constructor & Destructor Documentation

DirectOutput.Table.Table.Table ( )

Initializes a new instance of the Table class.

Member Function Documentation

void DirectOutput.Table.Table.Finish ( )

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

string DirectOutput.Table.Table.GetConfigXml ( )

Returns a serialized XML representation of the Table configuration.

Returns
XMLString
static 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
static 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
static 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
void DirectOutput.Table.Table.Init ( Pinball  Pinball)

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

Parameters
PinballThe Pinball object containing the Table.
void DirectOutput.Table.Table.SaveConfigXmlFile ( string  FileName)

Serializes the Table configuration to a XML file.

Parameters
FileNameName of the XML file.
void DirectOutput.Table.Table.TriggerStaticEffects ( )

Triggers the static effects for the table.

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

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.

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.

FastImageList DirectOutput.Table.Table.Bitmaps
getset

Gets or sets the list of bitmaps

The bitmaps list.

TableConfigSourceEnum DirectOutput.Table.Table.ConfigurationSource
getset

Gets or sets the configuration source.

The configuration source.

EffectList DirectOutput.Table.Table.Effects
getset

List of table specific effects.

Pinball DirectOutput.Table.Table.Pinball
getset

Gets the pinball object to which the Table object belongs.

The pinball object to which the Table object belongs.

string DirectOutput.Table.Table.RomName
getset

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

string DirectOutput.Table.Table.TableConfigurationFilename
getset

Gets or sets the table configuration filename.

The table configuration filename.

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.

string DirectOutput.Table.Table.TableFilename
getset

Gets or sets the filename of the table.

The filename of the table.

string DirectOutput.Table.Table.TableName
getset

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

Event Documentation

EventHandler<EventArgs> DirectOutput.Table.Table.RomNameChanged

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

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: