Display Related System Attributes
Display Related System Attributes
These attribute relate to what is going on concerning the currently visible panels, and status bar displays etc.
Name
Read / Write
Description
ActivityBarColour
W
Use a Value from the _Colours Label list to set the colour of the Activity bar.
ActivityState
W
Shows an activity bar in the status bar.
Value of 0..100 controls length of bar, 0 to reset (no bar).
Automatically reset at start and end of run.
Up to modeller how it gets used.
Since this updates even when running without animating, use carefully to avoid model slowdown
ActivityState0_1
W
Shows an activity bar in the status bar. Value of 0..1 controls length of bar, 0 to reset (no bar). Automatically reset at start and end of run. Up to modeller how it gets used. Since this updates even when running without animating, use carefully to avoid model slowdown.
AnimationUpdateInterval
R/W
Enables a model to control how often animation updates occur.
Set to 0 means there is no animation update interval and the model advances to the next model event only.
The way the Animation Update Interval is handled.
Planimate® always delays a minimum of 15ms every animation update interval regardless of whether there is item animation or not.
This makes model time flow more smoothly especially if time based portal animation is being used.
If a model spends a long time without animation which you want to skip, you can now set the animation update interval system attribute to make the model advance without showing the "Advance" dialog.
CurrentPanelVisible
R/W
This can be either Read or Set.
To Read:
Ask the model if the screen is visible: returns 1 if visible, 2 if it is not.
This way you can detect what the user is looking at, and perhaps alter the animation to suit them.
To Set:
Assigning a value of one to the screen visible attribute makes the screen visible!
You might think of using this to jump to screens if errors or interesting behaviour occurs.
EnableTableCellEdit
R/W
This enables the modeller to decide whether a cell edit should occur when a table cell is clicked, using the cell click broadcast.
If the model sets this attribute nonzero while processing a table cell click broadcast (before edit) then the edit will actually occur.
If this attribute is not set, the edit will not occur (as is current).
This attribute is reset to 0 before each cell click broadcast gets sent.
It is only valid to set/read this attribute in the initial thread of a cell click broadcast.
For this feature to work, the table view option "Don’t Defer BC on FEC" must be enabled.
This forces PL to send the BC immediately rather than waiting until a "safer" time.
With this option "on" the modeller MUST NOT close the panel containing the table view as a result of the cell click broadcast, otherwise the platform will crash.
ItemAnimateSpeed
R/W
Sets the Item Animation Speed value that is found under Run in the Menu Bar.
LockDrawing
W
Set to 1 to stop updates to the screen.
Set to Zero to resume updates.
May need to force a repaint after that to be sure.
LockPortalDrag
W
Enables the modeller to lock portals from being dragged at runtime even though their options setting enables this.
This gives the modeller more control over when users can reposition portals in their display.
MouseX
R
Returns the current Mouse Position X Coordinate.
MouseXPanel
R
Returns ???
MouseY
R
Returns the current Mouse Position Y Coordinate.
MouseYPanel
R
Returns ???
PanelOwnerVisible
R
This returns true (1) if the panel containing the current panel from where the attref is scoped is visible, otherwise it returns "2" for false.
This is useful for event handlers which reside in a subsystem "under" a panel which an end user sees/interacts with.
It enables routine code to determine if the subsystem immediately above is visible without requiring object or panel indices.
TimerBroadcastIntervalMS
W
Lets the modeller change the timing interval of the "_Real Time Tick" broadcast.
A range of 10ms (100 times a second) to 1000ms (once a second) is supported.
100 times a second will be too fast for slower systems so be careful on using the faster rates.
TimeScaling
R/W
Sets the Real Time Scaling value that is found under Run in the Menu Bar.
TraceAnimation
W
Set to 1 to turn on the Trace Animation debugging option.
Set to Zero to turn it off again.
VisiblePanelID
R
Returns the panel index of the currently visible/front most panel. (This is the _Model Panels Label List, not _Model Objects).
VisiblePortalIndex
R If the main visible panel is a subsystem of a portal with an object label, that label index is returned.
If the top level window is visible, 0 is returned.
Otherwise the value is -1