agi.foundation.graphics

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

Class DistanceToGlobeOverlayDisplayCondition

java.lang.Object

agi.foundation.graphics.DisplayCondition

agi.foundation.graphics.DistanceToGlobeOverlayDisplayCondition

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class DistanceToGlobeOverlayDisplayCondition
extends DisplayCondition
implements IDisposable

Defines an inclusive distance interval, in meters, that determines when an object, such as a primitive, is rendered based on the distance, in meters, from the camera to the GlobeOverlay. This is different from DistanceDisplayCondition because it is based on the camera's distance to a specified GlobeOverlay, rather than the camera's distance to the object that uses this display condition.

See Also:

Display Conditions topic, DistanceToPositionDisplayCondition

Constructor Summary

Constructors

Constructor and Description
DistanceToGlobeOverlayDisplayCondition() Initializes a default distance to globe overlay display condition.
DistanceToGlobeOverlayDisplayCondition(GlobeOverlay globeOverlay, double minimumDistance, double maximumDistance) Initializes a distance display condition with the GlobeOverlay and the inclusive distance interval [minimumDistance, maximumDistance].

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing)
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
GlobeOverlay	getGlobeOverlay() Gets the globe overlay associated with this instance.
double	getMaximumDistance() Gets the maximum distance, in meters, of the inclusive distance interval.
double	getMaximumDistanceSquared() Gets the squared maximum distance, in meters, of the inclusive distance interval.
double	getMinimumDistance() Gets the minimum distance, in meters, of the inclusive distance interval.
double	getMinimumDistanceSquared() Gets the squared minimum distance, in meters, of the inclusive distance interval.
void	setGlobeOverlay(GlobeOverlay value) Sets the globe overlay associated with this instance.
void	setMaximumDistance(double maximumDistance) Sets the maximum distance, in meters, of the inclusive distance interval.
void	setMinimumDistance(double minimumDistance) Sets the minimum distance, in meters, of the inclusive distance interval.

Methods inherited from class agi.foundation.graphics.DisplayCondition

dispose

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Constructor Detail

DistanceToGlobeOverlayDisplayCondition

public DistanceToGlobeOverlayDisplayCondition()

Initializes a default distance to globe overlay display condition. With this constructor, an object is always rendered regardless of the camera's distance to the GlobeOverlay.

The display condition's properties are initialized to the following values:

• MinimumDistance: -1.7976931348623158e+308
• MaximumDistance: 1.7976931348623158e+308

See Also:

DistanceToGlobeOverlayDisplayCondition.DistanceToGlobeOverlayDisplayCondition(agi.foundation.graphics.advanced.GlobeOverlay,double,double)

DistanceToGlobeOverlayDisplayCondition

public DistanceToGlobeOverlayDisplayCondition(GlobeOverlay globeOverlay,
                                              double minimumDistance,
                                              double maximumDistance)

Initializes a distance display condition with the GlobeOverlay and the inclusive distance interval [minimumDistance, maximumDistance]. When this display condition is assigned to an object, such as a primitive, the object is only rendered when the distance, in meters, from the camera to the GlobeOverlay is within the interval.

Parameters:

globeOverlay - The globe overlay associated with this instance.

minimumDistance - The minimum distance, in meters, of the inclusive distance interval.

maximumDistance - The maximum distance, in meters, of the inclusive distance interval. Use Double.MaxValue to ignore checking the maximum distance.

Throws:

ArgumentOutOfRangeException - minimumDistance and maximumDistance must be greater than or equal to zero.

See Also:

Display Conditions topic

Method Detail

finalize

protected void finalize()
                 throws Throwable

Description copied from class: java.lang.Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

See Also:

WeakReference, PhantomReference

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class DisplayCondition

getGlobeOverlay

public final GlobeOverlay getGlobeOverlay()

Gets the globe overlay associated with this instance.

setGlobeOverlay

public final void setGlobeOverlay(GlobeOverlay value)

Sets the globe overlay associated with this instance.

getMinimumDistance

public final double getMinimumDistance()

Gets the minimum distance, in meters, of the inclusive distance interval.

Throws:

ArgumentOutOfRangeException - MinimumDistance must be greater than or equal to zero.

See Also:

DistanceToGlobeOverlayDisplayCondition.DistanceToGlobeOverlayDisplayCondition(agi.foundation.graphics.advanced.GlobeOverlay,double,double)

setMinimumDistance

public final void setMinimumDistance(double minimumDistance)

Sets the minimum distance, in meters, of the inclusive distance interval.

Throws:

ArgumentOutOfRangeException - MinimumDistance must be greater than or equal to zero.

See Also:

DistanceToGlobeOverlayDisplayCondition.DistanceToGlobeOverlayDisplayCondition(agi.foundation.graphics.advanced.GlobeOverlay,double,double)

getMinimumDistanceSquared

public final double getMinimumDistanceSquared()

Gets the squared minimum distance, in meters, of the inclusive distance interval.

See Also:

MinimumDistance

getMaximumDistance

public final double getMaximumDistance()

Gets the maximum distance, in meters, of the inclusive distance interval. Use Double.MaxValue to ignore checking the maximum distance.

Throws:

ArgumentOutOfRangeException - MaximumDistance must be greater than or equal to zero.

See Also:

DistanceToGlobeOverlayDisplayCondition.DistanceToGlobeOverlayDisplayCondition(agi.foundation.graphics.advanced.GlobeOverlay,double,double)

setMaximumDistance

public final void setMaximumDistance(double maximumDistance)

Sets the maximum distance, in meters, of the inclusive distance interval. Use Double.MaxValue to ignore checking the maximum distance.

Throws:

ArgumentOutOfRangeException - MaximumDistance must be greater than or equal to zero.

See Also:

DistanceToGlobeOverlayDisplayCondition.DistanceToGlobeOverlayDisplayCondition(agi.foundation.graphics.advanced.GlobeOverlay,double,double)

getMaximumDistanceSquared

public final double getMaximumDistanceSquared()

Gets the squared maximum distance, in meters, of the inclusive distance interval.

See Also:

MaximumDistance