LineOfSightOverlay Class
Specifies parameters for a line of sight analysis overlay in a GlobeView.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class LineOfSightOverlay : OverlayRemarks
In addition to the line of sight analysis the LineOfSightOperator can do from elevation raster data, the GlobeView can also perform a line of sight analysis on the 3D ground meshes loaded in the view. This includes any auxiliary ground meshes, for instances from a 3D city model with detailed buildings.
Up to 10 simultaneous observers are read in each frame as point features from the Input operator. Each observer supports 2 different ranges displayed in different colors. Ranges and colors can be controlled individually for each observer, using attributes on the point features. Each observer may also be configured to look in a specific direction with limited field of view, or it may be omni-directional and use a 360 degree field of view.
The output from the analysis is used directly in the view to add a colored overlay to existing ground meshes. Surfaces that are visible from one or more observers are highlighted in different colors, while other surfaces are displayed normally, like in the following image:
 |
To create a line of sight overlay in your globe view, just create an instance of this class and add it to the GlobeView.LineOfSightOverlay property.
Even though the analysis is performed using the GPU and is quite fast, it will affect performance. The analysis will be recalculated each time an observer is modified, or whenever new ground meshes within the range of an observer are loaded. Displaying the overlay will also affect performance. Be sure to check that your target system can handle the extra load if you use this function.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Overlay
LineOfSightOverlay
Platforms
Windows, Linux, Android
LineOfSightOverlay Members
The LineOfSightOverlay type has the following members.
Constructors
| Name | Description |
|---|---|
| LineOfSightOverlay | Initializes a new instance of the LineOfSightOverlay class. |
Properties
| Name | Description |
|---|---|
| Bearing | Gets or sets the direction the observer is looking. |
| BlendMode | Gets or sets the blend mode that determines how the overlay is combined with previously rendered content. |
| Color1 | Gets or sets the color used for surfaces seen by one observer within the first range. |
| Color2 | Gets or sets the color used for surfaces seen by one observer within the second range. |
| Condition | Gets or sets a condition that determines whether the overlay is drawn or not. Inherited from Overlay |
| Dynamic | Gets or sets a value specifying if the analysis will be recalculated whenever the underlying ground changes. |
| Effects | Gets or sets the list of effects |
| Enabled | Gets or sets a flag determining whether the overlay is drawn or not. Inherited from Overlay |
| FieldOfView | Gets or sets the field of view of the observer. |
| InheritGroundEffects | Gets or sets the value determining if the effects in GlobeView.GroundEffects should be inherited |
| Input | Gets or sets the input operator used to read point features specifying the observer positions and attributes. |
| IsDisposed | Gets a value that tells whether the current LineOfSightOverlay has been disposed. Inherited from EngineObject |
| Name | Gets or sets the name of the overlay. Inherited from Overlay |
| NativeHandle | Gets the native Carmenta Engine kernel object the current LineOfSightOverlay represents. Inherited from EngineObject |
| OverlapColor1 | Gets or sets the color used for surfaces seen by two or more observers within the first range. |
| OverlapColor2 | Gets or sets the color used for surfaces seen by two or more observers within the second range. |
| Pitch | Gets or sets the pitch angle in which the observer is looking. |
| Range1Max | Gets or sets the upper bounds of the first observer range. |
| Range1Min | Gets or sets the lower bounds of the first observer range. |
| Range2Max | Gets or sets the upper bounds of the second observer range. |
| Range2Min | Gets or sets the lower bounds of the second observer range. |
| Roll | Gets or sets the roll angle of the observer. |
| 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 |