agi.foundation.graphics

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

Class DurationPathPrimitiveUpdatePolicy

java.lang.Object

agi.foundation.graphics.advanced.PathPrimitiveUpdatePolicy

agi.foundation.graphics.DurationPathPrimitiveUpdatePolicy

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class DurationPathPrimitiveUpdatePolicy
extends PathPrimitiveUpdatePolicy
implements IDisposable

PathPrimitive update policy that removes points from RemoveLocation after a given Duration.

Constructor Summary

Constructors

Constructor and Description
DurationPathPrimitiveUpdatePolicy() Constructs a default update policy.
DurationPathPrimitiveUpdatePolicy(Duration duration, PathPrimitiveRemoveLocation removeLocation) Initializes a policy with the specified duration and removeLocation.

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.
Duration	getDuration() Gets the maximum duration that a point will lie on the line.
PathPrimitiveRemoveLocation	getRemoveLocation() Gets where the positions on the path are removed from.
void	setDuration(Duration value) Sets the maximum duration that a point will lie on the line.
void	setRemoveLocation(PathPrimitiveRemoveLocation value) Sets where the positions on the path are removed from.
void	update(PathPrimitive pathPrimitive, JulianDate date) Removes points from RemoveLocation when the amount of time between a point's Date (get) and date is greater than Duration

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

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

DurationPathPrimitiveUpdatePolicy

public DurationPathPrimitiveUpdatePolicy()

Constructs a default update policy. This is equivalent to constructing a policy with agi.foundation.graphics.durationpathprimitiveupdatepolicy.Duration set to 0 and a agi.foundation.graphics.durationpathprimitiveupdatepolicy.RemoveLocation of Front.

See Also:

DurationPathPrimitiveUpdatePolicy.DurationPathPrimitiveUpdatePolicy(agi.foundation.time.Duration, agi.foundation.graphics.advanced.PathPrimitiveRemoveLocation)

DurationPathPrimitiveUpdatePolicy

public DurationPathPrimitiveUpdatePolicy(Duration duration,
                                         PathPrimitiveRemoveLocation removeLocation)

Initializes a policy with the specified duration and removeLocation.

Parameters:

duration - Sets the amount of time that a point at agi.foundation.graphics.durationpathprimitiveupdatepolicy.RemoveLocation will be on the path.

removeLocation - Sets the remove location to the front or back of the path.

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 PathPrimitiveUpdatePolicy

getDuration

public final Duration getDuration()

Gets the maximum duration that a point will lie on the line.

setDuration

public final void setDuration(Duration value)

Sets the maximum duration that a point will lie on the line.

getRemoveLocation

public final PathPrimitiveRemoveLocation getRemoveLocation()

Gets where the positions on the path are removed from.

Throws:

UnsupportedCaseException - RemoveLocation must be a valid enumeration value in PathPrimitiveRemoveLocation.

setRemoveLocation

public final void setRemoveLocation(PathPrimitiveRemoveLocation value)

Sets where the positions on the path are removed from.

Throws:

UnsupportedCaseException - RemoveLocation must be a valid enumeration value in PathPrimitiveRemoveLocation.

update

public void update(PathPrimitive pathPrimitive,
                   JulianDate date)

Removes points from RemoveLocation when the amount of time between a point's Date (get) and date is greater than Duration

Specified by:

update in class PathPrimitiveUpdatePolicy

Parameters:

pathPrimitive - The primitive to be updated.

date - The time.