agi.foundation.graphics

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

Class DistanceToPositionDisplayCondition

java.lang.Object

agi.foundation.graphics.DisplayCondition

agi.foundation.graphics.DistanceToPositionDisplayCondition

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class DistanceToPositionDisplayCondition
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 a position defined in the given ReferenceFrame.

See Also:

Display Conditions topic, DistanceDisplayCondition

Constructor Summary

Constructors

Constructor and Description
DistanceToPositionDisplayCondition() Initializes a default distance to position display condition.
DistanceToPositionDisplayCondition(Cartesian position, double minimumDistance, double maximumDistance) Initializes a distance display condition with the inclusive distance interval [minimumDistance, maximumDistance].
DistanceToPositionDisplayCondition(ReferenceFrame referenceFrame, Cartesian position, double minimumDistance, double maximumDistance) Initializes a distance display condition with 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.
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.
Cartesian	getPosition() Gets the position used to compute the distance from the camera.
ReferenceFrame	getReferenceFrame() Gets the reference frame that Position is defined in.
void	setMaximumDistance(double value) Sets the maximum distance, in meters, of the inclusive distance interval.
void	setMinimumDistance(double value) Sets the minimum distance, in meters, of the inclusive distance interval.
void	setPosition(Cartesian value) Sets the position used to compute the distance from the camera.
void	setReferenceFrame(ReferenceFrame value) Sets the reference frame that Position is defined in.

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

DistanceToPositionDisplayCondition

public DistanceToPositionDisplayCondition()

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

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

• Position: agi.foundation.coordinates.cartesian.Zero
• MinimumDistance: 0
• MaximumDistance: Double.MaxValue
• ReferenceFrame: EarthCentralBody.FixedFrame

See Also:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,double,double)

DistanceToPositionDisplayCondition

public DistanceToPositionDisplayCondition(Cartesian position,
                                          double minimumDistance,
                                          double maximumDistance)

Initializes a distance display condition with 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 position is within the interval. position is interpreted to be in the default EarthCentralBody.FixedFrame reference frame. This display condition can be assigned to multiple objects.

Parameters:

position - The position used to compute the distance from the camera.

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

DistanceToPositionDisplayCondition

public DistanceToPositionDisplayCondition(ReferenceFrame referenceFrame,
                                          Cartesian position,
                                          double minimumDistance,
                                          double maximumDistance)

Initializes a distance display condition with 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 position is within the interval. position is interpreted to be in the reference frame specified by referenceFrame. This display condition can be assigned to multiple objects.

Parameters:

position - The position used to compute the distance from the camera.

referenceFrame - The reference frame of the position.

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.

ArgumentNullException - ReferenceFrame is null.

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

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:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,double,double)

setMinimumDistance

public final void setMinimumDistance(double value)

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

Throws:

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

See Also:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,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:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,double,double)

setMaximumDistance

public final void setMaximumDistance(double value)

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:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,double,double)

getMaximumDistanceSquared

public final double getMaximumDistanceSquared()

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

See Also:

MaximumDistance

getPosition

public final Cartesian getPosition()

Gets the position used to compute the distance from the camera. position is interpreted to be in the same reference frame as the ReferenceFrame property. This display condition can be assigned to multiple objects.

See Also:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,double,double)

setPosition

public final void setPosition(Cartesian value)

Sets the position used to compute the distance from the camera. position is interpreted to be in the same reference frame as the ReferenceFrame property. This display condition can be assigned to multiple objects.

See Also:

DistanceToPositionDisplayCondition.DistanceToPositionDisplayCondition(agi.foundation.coordinates.Cartesian,double,double)

getReferenceFrame

public final ReferenceFrame getReferenceFrame()

Gets the reference frame that Position is defined in.

Throws:

ArgumentNullException - ReferenceFrame is null.

setReferenceFrame

public final void setReferenceFrame(ReferenceFrame value)

Sets the reference frame that Position is defined in.

Throws:

ArgumentNullException - ReferenceFrame is null.