SimpleScreenElement Class
A ScreenElement that contains a visualizer and can be displayed by a ScreenLayer.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class SimpleScreenElement : ScreenElementRemarks
A SimpleScreenElement displays the result of a visualizer in a corner of the map window, possibly offset in the x and y directions. In the simplest case, the visualizer is a TextVisualizer that just displays a constant text. But the text of text visualizer could also be dynamic, since it could be an attribute variable whose value depends on the View.UpdateAttributes. And the visualizer could be a SymbolVisualizer or a PointVisualizerSet: anything that inherits from the abstract base class PointVisualizer.
 |
The screenshot shows a SimpleScreenElement used to display geodata credits. To get just the line breaks, we could have used a single text visualizer with newline characters in its text. But for this example, we also wanted a bolder font for the first line, so this screen element uses a PointVisualizerSet that refers to three text visualizers.
Instead of a SimpleScreenElement, it can be more efficient to use a Legend if the visualization is static, since a legend visualization will be cached:
If you just need to display a static text in a single font, you can use a Legend with a caption but no items.
More generally, if you have a designed a static SimpleScreenElement with a complex visualizer, you can create a similar Legend by using an empty legend caption and a single PointLegendItem with an empty description, and then moving the complex visualizer into the visualizers of the PointLegendItem. However, in Carmenta Studio it is not obvious how to make an empty legend caption or or an empty legend item description: their default values are "no caption" and "no description", so you cannot just let the value fields be empty. As a workaround, you can click in the value field and then on the green plus symbol that appears, then choose Add new String, which will create a new String object that you can let remain empty (and rename to EmptyString).
In some cases, your complex visualization can be adapted to the basic Legend layout with a single caption and columns of images and texts. There is an example of such a design in the sample configuration screen_elements.px.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
ScreenElement
SimpleScreenElement
Platforms
Windows, Linux, Android
SimpleScreenElement Members
The SimpleScreenElement type has the following members.
Constructors
| Name | Description |
|---|---|
| SimpleScreenElement | Initializes a new instance of the SimpleScreenElement class. |
Properties
| Name | Description |
|---|---|
| AlignLeft | Gets or sets a flag that controls horizontal alignment of the entire element. Inherited from ScreenElement |
| AlignTop | Gets or sets a flag that controls vertical alignment of the entire element. Inherited from ScreenElement |
| BackgroundColor | Gets or sets the background color. Inherited from ScreenElement |
| IsDisposed | Gets a value that tells whether the current SimpleScreenElement has been disposed. Inherited from EngineObject |
| Name | Gets or sets the name of the SimpleScreenElement. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current SimpleScreenElement represents. Inherited from EngineObject |
| OffsetX | Gets or sets a rightward pixel offset for the element (rightward is the screen x axis direction). Inherited from ScreenElement |
| OffsetY | Gets or sets a downward pixel offset for the element (downward is the screen y axis direction). Inherited from ScreenElement |
| OutlineColor | Gets or sets the color of the screen element outline. Inherited from ScreenElement |
| OutlineMargin | Gets or sets the distance between the screen element outline and its contents. Inherited from ScreenElement |
| OutlineWidth | Gets or sets the width of the screen element outline. Inherited from ScreenElement |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| Visualizer | Gets or sets the visualizer. |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |