agi.foundation.graphics

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

Class GlobeImageOverlay

java.lang.Object

agi.foundation.graphics.advanced.GlobeOverlay

agi.foundation.graphics.GlobeImageOverlay

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

AGIProcessedImageGlobeOverlay, AGIRoamImageGlobeOverlay, CustomImageGlobeOverlay, GeospatialImageGlobeOverlay

public abstract class GlobeImageOverlay
extends GlobeOverlay
implements IDisposable

A GlobeOverlay that shows an image.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobeImageOverlay()

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing)
double	getAltitudeBasedTranslucencyLowerAltitude() Gets the lower altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true.
float	getAltitudeBasedTranslucencyLowerTranslucency() Gets the lower translucency value for the image when UseAltitudeBasedTranslucency is set to true.
double	getAltitudeBasedTranslucencyUpperAltitude() Gets the upper altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true.
float	getAltitudeBasedTranslucencyUpperTranslucency() Gets the upper translucency value for the image when UseAltitudeBasedTranslucency is set to true.
static boolean	getMoreThanOneImageGlobeOverlaySupported() Gets whether or not the video card allows for more than one image globe overlay GlobeImageOverlay to be added.
float	getTranslucency() Gets the translucency value for the image.
boolean	getUseAltitudeBasedTranslucency() Gets whether to use altitude to determine the translucency value for the image or not.
void	setAltitudeBasedTranslucencyLowerAltitude(double value) Sets the lower altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true.
void	setAltitudeBasedTranslucencyLowerTranslucency(float value) Sets the lower translucency value for the image when UseAltitudeBasedTranslucency is set to true.
void	setAltitudeBasedTranslucencyUpperAltitude(double value) Sets the upper altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true.
void	setAltitudeBasedTranslucencyUpperTranslucency(float value) Sets the upper translucency value for the image when UseAltitudeBasedTranslucency is set to true.
void	setTranslucency(float value) Sets the translucency value for the image.
void	setUseAltitudeBasedTranslucency(boolean value) Sets whether to use altitude to determine the translucency value for the image or not.

Methods inherited from class agi.foundation.graphics.advanced.GlobeOverlay

dispose, getCentralBody, getDisplayCondition, getExtent, getIsValid, getRole, getTag, getUri, setDisplayCondition, setExtent, setTag

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, dispose

Constructor Detail

GlobeImageOverlay

protected GlobeImageOverlay()

Method Detail

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class GlobeOverlay

getTranslucency

public float getTranslucency()

Gets the translucency value for the image. The translucency is between 0 and 1, where 0 is fully opaque and 1 is invisible.

setTranslucency

public void setTranslucency(float value)

Sets the translucency value for the image. The translucency is between 0 and 1, where 0 is fully opaque and 1 is invisible.

getUseAltitudeBasedTranslucency

public boolean getUseAltitudeBasedTranslucency()

Gets whether to use altitude to determine the translucency value for the image or not. If false, the Translucency value is used. If true, the translucency will be determined by the values of AltitudeBasedTranslucencyLowerTranslucency, AltitudeBasedTranslucencyUpperTranslucency, AltitudeBasedTranslucencyLowerAltitude, and AltitudeBasedTranslucencyUpperAltitude.

setUseAltitudeBasedTranslucency

public void setUseAltitudeBasedTranslucency(boolean value)

Sets whether to use altitude to determine the translucency value for the image or not. If false, the Translucency value is used. If true, the translucency will be determined by the values of AltitudeBasedTranslucencyLowerTranslucency, AltitudeBasedTranslucencyUpperTranslucency, AltitudeBasedTranslucencyLowerAltitude, and AltitudeBasedTranslucencyUpperAltitude.

getAltitudeBasedTranslucencyLowerTranslucency

public float getAltitudeBasedTranslucencyLowerTranslucency()

Gets the lower translucency value for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or below AltitudeBasedTranslucencyLowerAltitude, the image will have the translucency specified by this property, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyLowerAltitude and AltitudeBasedTranslucencyUpperAltitude.

setAltitudeBasedTranslucencyLowerTranslucency

public void setAltitudeBasedTranslucencyLowerTranslucency(float value)

Sets the lower translucency value for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or below AltitudeBasedTranslucencyLowerAltitude, the image will have the translucency specified by this property, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyLowerAltitude and AltitudeBasedTranslucencyUpperAltitude.

getAltitudeBasedTranslucencyUpperTranslucency

public float getAltitudeBasedTranslucencyUpperTranslucency()

Gets the upper translucency value for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or above AltitudeBasedTranslucencyUpperAltitude, the image will have the translucency specified by this property, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyUpperAltitude and AltitudeBasedTranslucencyLowerAltitude.

setAltitudeBasedTranslucencyUpperTranslucency

public void setAltitudeBasedTranslucencyUpperTranslucency(float value)

Sets the upper translucency value for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or above AltitudeBasedTranslucencyUpperAltitude, the image will have the translucency specified by this property, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyUpperAltitude and AltitudeBasedTranslucencyLowerAltitude.

getAltitudeBasedTranslucencyLowerAltitude

public double getAltitudeBasedTranslucencyLowerAltitude()

Gets the lower altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or below this value, the image will have the translucency specified by AltitudeBasedTranslucencyLowerTranslucency, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyLowerAltitude and AltitudeBasedTranslucencyUpperAltitude.

setAltitudeBasedTranslucencyLowerAltitude

public void setAltitudeBasedTranslucencyLowerAltitude(double value)

Sets the lower altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or below this value, the image will have the translucency specified by AltitudeBasedTranslucencyLowerTranslucency, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyLowerAltitude and AltitudeBasedTranslucencyUpperAltitude.

getAltitudeBasedTranslucencyUpperAltitude

public double getAltitudeBasedTranslucencyUpperAltitude()

Gets the upper altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or above this value, the image will have the translucency specified by AltitudeBasedTranslucencyUpperTranslucency, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyUpperAltitude and AltitudeBasedTranslucencyLowerAltitude.

setAltitudeBasedTranslucencyUpperAltitude

public void setAltitudeBasedTranslucencyUpperAltitude(double value)

Sets the upper altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to true. When the altitude of the viewer is at or above this value, the image will have the translucency specified by AltitudeBasedTranslucencyUpperTranslucency, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyUpperAltitude and AltitudeBasedTranslucencyLowerAltitude.

getMoreThanOneImageGlobeOverlaySupported

public static final boolean getMoreThanOneImageGlobeOverlaySupported()

Gets whether or not the video card allows for more than one image globe overlay GlobeImageOverlay to be added.

Returns true if any number of base, night, specular, and normal images can be added to a central body. false if only one base image can be added to a central body.