Broadcast Tuple Reference: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
This is a summary of the item attributes that will be set by Planimate when [[Broadcast|broadcasts]] are sent to [[Entry#Receive_Broadcast|broadcast entries]] by the engine. These broadcasts usually occur because the modeller has selected an option on an object, for example selecting the "Send Table Click" option in a [[Table View|table view]] and specified a broadcast name to use. Other broadcasts are automatically [[Sytem Broadcasts|sent by the engine]] and just require a receiving broadcast entry, configured to "listen" to the correct broadcast name. These are indicated below. | |||
It is up to the modeller to ensure that the [[Item|item class]] involved has the correctly named attribute, otherwise the attribute will be skipped (but an item will still be generated). | |||
Each collection of attributes is referred to as a [[Tuple]]. | |||
The attribute names all start with underscore to set them apart from attributes that the modeller uses for general modelling, hence names starting with underscore should be avoided unless specifically being used to receive the tuples defined here. | |||
The format of an attribute should usually be a value. Times are best formatted as time/calendar values. _pipeid and _paintid are [[_Model Objects]] labels and [[_Paint Objects]] labels respectively. _panel is a [[_Model Panels]] label. | |||
''This note is created automatically. Please do not edit it.'' | |||
== Table Cell Click1 (TableClick) == | |||
This is sent by a broadcast chosen by the modeller and sets these attributes: | |||
*_view_row | |||
*_view_col | |||
*_to_row | |||
*_to_col | |||
== Table Cell | == Table Cell Click2 (TableClick) == | ||
This is sent by a broadcast chosen by the modeller and sets these attributes: | This is sent by a broadcast chosen by the modeller and sets these attributes: | ||
*_view_row | *_view_row | ||
Line 16: | Line 25: | ||
*_to_col | *_to_col | ||
== Table Cell | == Table Cell Click3 (TableClick) == | ||
This is sent by a broadcast chosen by the modeller and sets these attributes: | This is sent by a broadcast chosen by the modeller and sets these attributes: | ||
*_view_row | *_view_row |
Revision as of 20:18, 11 January 2008
This is a summary of the item attributes that will be set by Planimate when broadcasts are sent to broadcast entries by the engine. These broadcasts usually occur because the modeller has selected an option on an object, for example selecting the "Send Table Click" option in a table view and specified a broadcast name to use. Other broadcasts are automatically sent by the engine and just require a receiving broadcast entry, configured to "listen" to the correct broadcast name. These are indicated below.
It is up to the modeller to ensure that the item class involved has the correctly named attribute, otherwise the attribute will be skipped (but an item will still be generated).
Each collection of attributes is referred to as a Tuple.
The attribute names all start with underscore to set them apart from attributes that the modeller uses for general modelling, hence names starting with underscore should be avoided unless specifically being used to receive the tuples defined here.
The format of an attribute should usually be a value. Times are best formatted as time/calendar values. _pipeid and _paintid are _Model Objects labels and _Paint Objects labels respectively. _panel is a _Model Panels label.
This note is created automatically. Please do not edit it.
Table Cell Click1 (TableClick)
This is sent by a broadcast chosen by the modeller and sets these attributes:
- _view_row
- _view_col
- _to_row
- _to_col
Table Cell Click2 (TableClick)
This is sent by a broadcast chosen by the modeller and sets these attributes:
- _view_row
- _view_col
- _to_row
- _to_col
Table Cell Click3 (TableClick)
This is sent by a broadcast chosen by the modeller and sets these attributes:
- _view_row
- _view_col
- _to_row
- _to_col