agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r3.jar)

Class GlobeOverlay

java.lang.Object

agi.foundation.graphics.advanced.GlobeOverlay

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

GlobeImageOverlay, TerrainOverlay

public abstract class GlobeOverlay
extends Object
implements IDisposable

The base class of all TerrainOverlay and GlobeImageOverlay objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobeOverlay()

Method Summary

Modifier and Type	Method and Description
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected void	dispose(boolean disposing)
CentralBody	getCentralBody() Gets the CentralBody that the GlobeOverlay is displayed on.
DisplayCondition	getDisplayCondition() Gets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.
CartographicExtent	getExtent() Gets the CartographicExtent that represents the area covered by the GlobeOverlay.
boolean	getIsValid() Gets whether or not the overlay is valid.
GlobeOverlayRole	getRole() Gets the GlobeOverlayRole of the GlobeOverlay.
Object	getTag() Gets custom data associated with this globe overlay.
URI	getUri() Gets the URI specifying the location of the GlobeOverlay.
void	setDisplayCondition(DisplayCondition value) Sets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.
void	setExtent(CartographicExtent value) Gets the CartographicExtent that represents the area covered by the GlobeOverlay.
void	setTag(Object value) Sets custom data associated with this globe overlay.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

GlobeOverlay

protected GlobeOverlay()

Method Detail

dispose

public final void dispose()

Description copied from interface: IDisposable

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable

dispose

protected void dispose(boolean disposing)

getCentralBody

public CentralBody getCentralBody()

Gets the CentralBody that the GlobeOverlay is displayed on. It will return null if the GlobeOverlay hasn't been added to a CentralBody.

getExtent

public CartographicExtent getExtent()

Gets the CartographicExtent that represents the area covered by the GlobeOverlay.

setExtent

public void setExtent(CartographicExtent value)

Gets the CartographicExtent that represents the area covered by the GlobeOverlay.

getRole

public GlobeOverlayRole getRole()

Gets the GlobeOverlayRole of the GlobeOverlay.

getUri

public URI getUri()

Gets the URI specifying the location of the GlobeOverlay.

getIsValid

public boolean getIsValid()

Gets whether or not the overlay is valid. It can be invalid because of a missing file, corrupt file, unlicensed file, or a file on the incorrect CentralBody.

getDisplayCondition

public DisplayCondition getDisplayCondition()

Gets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.

setDisplayCondition

public void setDisplayCondition(DisplayCondition value)

Sets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.

getTag

public Object getTag()

Gets custom data associated with this globe overlay.

setTag

public void setTag(Object value)

Sets custom data associated with this globe overlay.