Layer Class
Represents a layer in a Carmenta Engine View.
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 abstract class Layer : EngineObject,
IUserPropertiesRemarks
A Layer object represents a layer in a Carmenta Engine view. A Layer holds operators which do the processing and visualization of the data. Some types of layers can also hold other layers.
Layer is an abstract base class that can not be instantiated. The most commonly used subclass is OrdinaryLayer.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Layer
LayerSet
OgcWmtsServerLayer
OrdinaryLayer
PlotLayer
RadarVideoLayer
Platforms
Windows, Linux, Android
Layer Members
The Layer type has the following members.
Properties
| Name | Description |
|---|---|
| BlendMode | Gets or sets the blend mode that determines how the layer is combined with previously rendered layers. |
| Condition | Gets or sets the Condition that determines whether the Layer is drawn or not. |
| CoverageHint | Gets or sets a value that can assert that the visualization is fully opaque within the data extent. |
| Description | Gets or sets a short description of the layer. |
| DisableOnError | Gets or sets a value specifying if an error within the layer should automatically disable the layer, or throw an exception. |
| DisplayName | Gets or sets a display name for the layer. |
| Effects | List of effects |
| Enabled | Determines whether the Layer is enabled or not. |
| EnabledDuringQuickUpdates | Determines whether the Layer is temporarily turned off during mouse interactions. |
| IsDisposed | Gets a value that tells whether the current Layer has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path or URL to an ISO 19139 metadata document for the layer. |
| Legend | Gets or sets a map legend associated with this 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 Layer should be drawn. |
| MinScale | Gets or sets the lowest inverted nominal scale this Layer should be drawn at. |
| Name | Gets or sets the name of the layer. |
| NamedStyles | Gets the list of named styles that can be enabled for the layer. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Layer represents. Inherited from EngineObject |
| Opacity | Gets or sets a value that specifies the opacity of the layer. |
| Selectable | Gets or sets a value that determines whether features in this Layer can be selected. |
| 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. |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. |
| FlushCache | Marks the layer as flushed which will release cached resources during the next update. |
| GetChildObjects | Overloaded. Gets the child objects of the current object. |
| GetDataBounds | Calculates the bounds of all dataset coverages in the layer. |
| GetFeatureAttributes | Gets information about all attributes that may be present on features in this layer. |
| GetFeatures | Overloaded. Gets features from the layer and any child layers. |
| GetLastError | Gets the error message for the last error that occurred within the layer. |
| GetLocalizedDescription | Gets a localized version of the layer description in a specific language. |
| GetLocalizedDisplayName | Gets a localized version of the layer display name in a specific language. |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. |
| HasLocalizedDescription | Checks if a localized version of the layer description is available in a specific language. |
| HasLocalizedDisplayName | Checks if a localized version of the layer display name is available in a specific language. |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. |
| IsStyleEnabled | Checks if a certain style is enabled for the layer or not. |
| SetLocalizedDescription | Sets a layer description in a specific language. |
| SetLocalizedDisplayName | Sets a layer display name in a specific language. |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the layer, for a specific language. |
Events
| Name | Description |
|---|---|
| EnabledChanged | Occurs when the value of the Enabled property has changed. |