TerrainWarningOverlay Class
Specifies parameters that control a terrain warning overlay in a 2D View or a GlobeView.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class TerrainWarningOverlay : OverlayRemarks
This class is used to configure a terrain warning overlay, an analysis that shows how close the ground is to an aircraft, in a 2D View or a GlobeView.
 |
When configured properly, and using either the DirectX or OpenGL renderer, the elevation data will be cached on the graphics card and the entire analysis and visualization is done by the GPU. This makes it is very cheap to track a live aircraft position and re-calculate the terrain warning relative the new position.
Carmenta Engine supports 2D terrain warnings using the Software renderer but it much slower than offloading the work to the graphics card. It should only be used if DirectX or OpenGL does not work.
To enable a terrain warning overlay you assign a TerrainWarningOverlay to the View.TerrainWarningOverlay property. The aircraft position can either be specified directly with the Position property, or it can be read from a point feature from the Input operator. In a 2D view you must also make sure that the view has access to ground elevation data that passes through a TerrainWarningOperator.
A TerrainWarningOperator can also be used in a 3D globe if the terrain warning overlay should be applied to more than the ground mesh, for example buildings.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Overlay
TerrainWarningOverlay
Platforms
Windows, Linux, Android
TerrainWarningOverlay Members
The TerrainWarningOverlay type has the following members.
Constructors
| Name | Description |
|---|---|
| TerrainWarningOverlay | Initializes a new instance of the TerrainWarningOverlay class. |
Properties
| Name | Description |
|---|---|
| ColorTable | Gets the color table that defines the colors and the elevations at which they get applied to the ground. |
| Condition | Gets or sets a condition that determines whether the overlay is drawn or not. Inherited from Overlay |
| Enabled | Gets or sets a flag determining whether the overlay is drawn or not. Inherited from Overlay |
| Input | Gets or sets the input operator used to read a point feature specifying the aircraft position. |
| IsDisposed | Gets a value that tells whether the current TerrainWarningOverlay has been disposed. Inherited from EngineObject |
| MaxDistance | Gets or sets the maximum distance from the aircraft position at which the terrain warning is displayed. |
| Name | Gets or sets the name of the overlay. Inherited from Overlay |
| NativeHandle | Gets the native Carmenta Engine kernel object the current TerrainWarningOverlay represents. Inherited from EngineObject |
| Position | Gets or sets the aircraft position the terrain warning is generated relative. |
| 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 |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |