Overlay Class
Abstract base class for all types of view overlays.
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
Syntax
public abstract class Overlay : EngineObject,
IUserProperties
Remarks
This is a base class for various view overlays, such as TerrainWarningOverlay and LineOfSightOverlay. Please see these subclasses for more information.
Inheritance Hierarchy
System.Object
EngineObject
Overlay
CameraProjectOverlay
LineOfSightOverlay
SurfaceOverlay
TerrainWarningOverlay
Platforms
Windows, Linux, Android
Overlay Members
The Overlay type has the following members.
Properties
Name | Description |
---|---|
Condition | Gets or sets a condition that determines whether the overlay is drawn or not. |
Enabled | Gets or sets a flag determining whether the overlay is drawn or not. |
IsDisposed | Gets a value that tells whether the current Overlay has been disposed. Inherited from EngineObject |
Name | Gets or sets the name of the overlay. |
NativeHandle | Gets the native Carmenta Engine kernel object the current Overlay represents. Inherited from EngineObject |
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 |