ScreenLayer Class
Represents a layer that uses screen coordinates for all drawing.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class ScreenLayer : OrdinaryLayerRemarks
A ScreenLayer is used for visualizations that should have a fixed position in the map window, instead of a geographic position. There are two ways to specify the visualizations.
Like other kinds of layers, a screen layer can get features with visualizers from its Input. But for a screen layer, these features must be expressed in screen coordinates – see Crs.ScreenCoordinateSystem – that are unrelated to the current View.Area and View.Crs.
Instead of an Input, it is often more convenient to give the screen layer one or more screen Elements, which will be placed in or near the map window corners. Examples of screen elements are legends and scale bars; see the base class ScreenElement.
A screen layer may have both an input and elements: then the input will be rendered before the elements.
A screen layer will not work inside a TileLayer or GlobeTileLayer.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Layer
OrdinaryLayer
ScreenLayer
Platforms
Windows, Linux, Android
ScreenLayer Members
The ScreenLayer type has the following members.
Constructors
| Name | Description |
|---|---|
| ScreenLayer | Initializes a new instance of the ScreenLayer class. |
Properties
| Name | Description |
|---|---|
| AlwaysOnTop | Gets or sets a flag that tells whether the screen layer shall always appear on top of other layers, including selection/hover/high-priority visualizations. |
| BlendMode | Gets or sets the blend mode that determines how the layer is combined with previously rendered layers. Inherited from Layer |
| CacheMode | Gets or sets a value that determines if and how the ScreenLayer will cache presentation between updates. Inherited from OrdinaryLayer |
| Condition | Gets or sets the Condition that determines whether the ScreenLayer is drawn or not. Inherited from Layer |
| CoverageHint | Gets or sets a value that can assert that the visualization is fully opaque within the data extent. Inherited from Layer |
| Description | Gets or sets a short description of the layer. Inherited from Layer |
| DisableOnError | Gets or sets a value specifying if an error within the layer should automatically disable the layer, or throw an exception. Inherited from Layer |
| DisplayName | Gets or sets a display name for the layer. Inherited from Layer |
| Effects | List of effects Inherited from Layer |
| Elements | Gets the list of screen elements that are displayed by the layer. |
| Enabled | Determines whether the ScreenLayer is enabled or not. Inherited from Layer |
| EnabledDuringQuickUpdates | Determines whether the ScreenLayer is temporarily turned off during mouse interactions. Inherited from Layer |
| GeographicMargin | Gets or sets the geographic distance that the geographic area should be extended with when updating the layer. Inherited from OrdinaryLayer |
| Input | Gets or sets the input operator. Inherited from OrdinaryLayer |
| IsDisposed | Gets a value that tells whether the current ScreenLayer has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path or URL to an ISO 19139 metadata document for the layer. Inherited from Layer |
| Legend | Gets or sets a map legend associated with this layer. Inherited from Layer |
| MaxScale | Gets or sets the highest inverted nominal scale in a 2D view, or the furthest distance in a 3D globe view, at which objects from this ScreenLayer should be drawn. Inherited from Layer |
| MinScale | Gets or sets the lowest inverted nominal scale this ScreenLayer should be drawn at. Inherited from Layer |
| Name | Gets or sets the name of the layer. Inherited from Layer |
| NamedStyles | Gets the list of named styles that can be enabled for the layer. Inherited from Layer |
| NativeHandle | Gets the native Carmenta Engine kernel object the current ScreenLayer represents. Inherited from EngineObject |
| Opacity | Gets or sets a value that specifies the opacity of the layer. Inherited from Layer |
| PixelMarginDown | Gets or sets the number of pixels that should be added to the lower side of the geographic area when updating the layer. Inherited from OrdinaryLayer |
| PixelMarginLeft | Gets or sets the number of pixels that should be added to the left side of the geographic area when updating the layer. Inherited from OrdinaryLayer |
| PixelMarginRight | Gets or sets the number of pixels that should be added to the right side of the geographic area when updating the layer. Inherited from OrdinaryLayer |
| PixelMarginUp | Gets or sets the number of pixels that should be added to the upper side of the geographic area when updating the layer. Inherited from OrdinaryLayer |
| Selectable | Gets or sets a value that determines whether features in this ScreenLayer can be selected. Inherited from Layer |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
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 |
| EnableStyle | Enables or disables a named style for the layer. Inherited from Layer |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Layer |
| FlushCache | Marks the layer as flushed which will release cached resources during the next update. Inherited from Layer |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Layer |
| GetDataBounds | Calculates the bounds of all dataset coverages in the layer. Inherited from Layer |
| GetFeatureAttributes | Gets information about all attributes that may be present on features in this layer. Inherited from Layer |
| GetFeatures | Overloaded. Gets features from the layer and any child layers. Inherited from Layer |
| GetLastError | Gets the error message for the last error that occurred within the layer. Inherited from Layer |
| GetLocalizedDescription | Gets a localized version of the layer description in a specific language. Inherited from Layer |
| GetLocalizedDisplayName | Gets a localized version of the layer display name in a specific language. Inherited from Layer |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Layer |
| HasLocalizedDescription | Checks if a localized version of the layer description is available in a specific language. Inherited from Layer |
| HasLocalizedDisplayName | Checks if a localized version of the layer display name is available in a specific language. Inherited from Layer |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Layer |
| IsStyleEnabled | Checks if a certain style is enabled for the layer or not. Inherited from Layer |
| SetLocalizedDescription | Sets a layer description in a specific language. Inherited from Layer |
| SetLocalizedDisplayName | Sets a layer display name in a specific language. Inherited from Layer |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the layer, for a specific language. Inherited from Layer |
Events
| Name | Description |
|---|---|
| EnabledChanged | Occurs when the value of the Enabled property has changed. Inherited from Layer |