IUpdateableGui

Description

interface Tinman.Engine.GUI.IUpdateableGui

Extended by

AnimationGui sealed
BookmarksGui sealed
CameraPathGui sealed
DefaultVisibleCheckGui sealed
HeightmapSampleGui sealed
IWidget
LightingGui sealed
MapCoordinatesGui sealed
MeshBufferGui sealed
MeshDynamicGui sealed
ProfilerGui sealed
ShadowMappingGui sealed
TerrainBufferGui sealed
TerrainLayerListGui sealed
TerrainViewGui sealed

Base interface for classes that provide a GUI and a standard mechanism for updating it according to the current data model values.

Public / Methods

Update​Gui

public method UpdateGui → (2)

valuesOnly in : bool

true to update values in the existing GUI structure,
false to rebuild the GUI structure before updating values.

which opt : int64 = ~0

A bitmask that indicates which parts of the GUI to update. The concrete type of the called object defines the set of allowed update bits.

Updates GUI components, according to current values in the data model.

Implementing methods are expected to be fail-safe, i.e. their behaviour is well-defined, even if there is no GUI or the data model is empty. Thus, the UpdateGui method may be called at any time.

This method may be called repeatedly when valuesOnly in is true. Implementing methods are expected to perform efficiently in this case.