View.SetViewUpdateSettings Method
Required when making a MapControl.
Thread safety: This method is not thread-safe and it should only be called from the GUI thread. Show
SetViewUpdateSettings(System.Boolean enabled, MapControlUpdateMode mode, System.Int32 interval, System.Int32 guiDelayMinimum, System.Int32 guiDelayPercentage, System.Boolean requestUpdatesInAdvance, System.Boolean supportsBlockingUpdates)
Required when making a MapControl.Syntax
public void SetViewUpdateSettings (
System.Boolean enabled,
MapControlUpdateMode mode,
System.Int32 interval,
System.Int32 guiDelayMinimum,
System.Int32 guiDelayPercentage,
System.Boolean requestUpdatesInAdvance,
System.Boolean supportsBlockingUpdates
)Parameters
enabled
Type: System.Boolean
Whether the internal view update scheduling mechanism for this view should be enabled. Map controls generally use True when a View is attached and False when it is detached.
Whether the internal view update scheduling mechanism for this view should be enabled. Map controls generally use True when a View is attached and False when it is detached.
mode
Type: MapControlUpdateMode
The update mode used for updates.
The update mode used for updates.
interval
Type: System.Int32
An interval in milliseconds. Used differently depending on the mode.
An interval in milliseconds. Used differently depending on the mode.
guiDelayMinimum
Type: System.Int32
The minimum amount of time in milliseconds that needs to pass between updates.
The minimum amount of time in milliseconds that needs to pass between updates.
guiDelayPercentage
Type: System.Int32
Percentage of the previous update time that will be used to calculate a suitable amount of time that needs to pass between updates.
Percentage of the previous update time that will be used to calculate a suitable amount of time that needs to pass between updates.
requestUpdatesInAdvance
Type: System.Boolean
True to allow sending more requests for higher framerate, at the possible expense of less input being handled. False if an update must be performed before another update request can be made. In the event that an update takes longer than what Carmenta Engine expects, it is possible to request a new update before the first one is completed so that the next update will be done as fast as possible. This is currently only used in the QtQuick map control. It has a special rendering process in which it inserts a delay upon receiving the first paint event, where it can handle input. Enabling requests in advance can improve the framerate since it minimizes the delay between updates, but for most map controls it can cause them to be starved of input events which could lead to a worse perceived framerate.
True to allow sending more requests for higher framerate, at the possible expense of less input being handled. False if an update must be performed before another update request can be made. In the event that an update takes longer than what Carmenta Engine expects, it is possible to request a new update before the first one is completed so that the next update will be done as fast as possible. This is currently only used in the QtQuick map control. It has a special rendering process in which it inserts a delay upon receiving the first paint event, where it can handle input. Enabling requests in advance can improve the framerate since it minimizes the delay between updates, but for most map controls it can cause them to be starved of input events which could lead to a worse perceived framerate.
supportsBlockingUpdates
Type: System.Boolean
Indicates if the map can be updated directly from an application calling Update, or if update requests must be passed back to to the MapControl, which will call UpdateByMapControl at some later time. Most controls can pass True here, but for instance controls using an external drawable should pass False.
Indicates if the map can be updated directly from an application calling Update, or if update requests must be passed back to to the MapControl, which will call UpdateByMapControl at some later time. Most controls can pass True here, but for instance controls using an external drawable should pass False.
Remarks
Note
Only to be called by a MapControl.
A MapControl needs to set a few properties on its connected View using this method so that the Carmenta Engine kernel can perform scheduling of view updates.
Platforms
Windows, Linux, Android