agi.foundation.graphics

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

Class KmlGraphics

java.lang.Object

agi.foundation.graphics.KmlGraphics

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class KmlGraphics
extends Object
implements IDisposable

Provides loading and unloading of KmlDocuments for a particular CentralBody.

Method Summary

Modifier and Type	Method and Description
void	addDocumentLoaded(EventHandler<KmlDocumentLoadedEventArgs> value) Adds a handler for an event that occurs when an asynchronous document load operation completes.
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
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.
List<KmlDocument>	getDocuments() The collection of KmlDocuments that are currently loaded.
KmlDocument	load(String kmlDocument) Loads a KmlDocument from a string containing the document.
void	loadAsync(String kmlDocument) Loads a KmlDocument asynchronously from a string containing the document.
KmlDocument	loadDocument(String kmlUri) Loads a KmlDocument from a Uri.
KmlDocument	loadDocument(URI kmlUri) Loads a KmlDocument from a URI.
void	loadDocumentAsync(String kmlUri) Loads a KmlDocument asynchronously from a Uri.
void	loadDocumentAsync(URI kmlUri) Loads a KmlDocument asynchronously from a URI.
void	removeDocumentLoaded(EventHandler<KmlDocumentLoadedEventArgs> value) Removes a handler for an event that occurs when an asynchronous document load operation completes.
void	unload(KmlDocument kmlDocument) Unloads a KmlDocument.
void	unloadAll() Unloads all KmlDocuments associated with this central body.

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

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

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)

getDocuments

public final List<KmlDocument> getDocuments()

The collection of KmlDocuments that are currently loaded.

addDocumentLoaded

public void addDocumentLoaded(EventHandler<KmlDocumentLoadedEventArgs> value)

Adds a handler for an event that occurs when an asynchronous document load operation completes.

Parameters:

value - The event handler.

removeDocumentLoaded

public void removeDocumentLoaded(EventHandler<KmlDocumentLoadedEventArgs> value)

Removes a handler for an event that occurs when an asynchronous document load operation completes.

Parameters:

value - The event handler.

loadDocument

public final KmlDocument loadDocument(URI kmlUri)

Loads a KmlDocument from a URI.

Parameters:

kmlUri - The URI of the document.

Returns:

The KmlDocument.

loadDocument

public final KmlDocument loadDocument(String kmlUri)

Loads a KmlDocument from a Uri.

Parameters:

kmlUri - The Uri of the document.

Returns:

The KmlDocument.

load

public final KmlDocument load(String kmlDocument)

Loads a KmlDocument from a string containing the document.

Parameters:

kmlDocument - A string containing the document.

Returns:

The KmlDocument.

loadDocumentAsync

public final void loadDocumentAsync(URI kmlUri)

Loads a KmlDocument asynchronously from a URI. The DocumentLoaded event is raised when the document is loaded.

Parameters:

kmlUri - The URI of the document.

loadDocumentAsync

public final void loadDocumentAsync(String kmlUri)

Loads a KmlDocument asynchronously from a Uri. The DocumentLoaded event is raised when the document is loaded.

Parameters:

kmlUri - The Uri of the document.

loadAsync

public final void loadAsync(String kmlDocument)

Loads a KmlDocument asynchronously from a string containing the document. The DocumentLoaded event is raised when the document is loaded.

Parameters:

kmlDocument - A string containing the document.

unload

public final void unload(KmlDocument kmlDocument)

Unloads a KmlDocument. All associated visual features will be removed from the Scene. Once a KmlDocument is unloaded, it is no longer valid and will throw when accessing properties or methods.

Parameters:

kmlDocument - The KmlDocument to be unloaded.

unloadAll

public final void unloadAll()

Unloads all KmlDocuments associated with this central body. All associated visual features will be removed from the Scene. Once a KmlDocument is unloaded, it is no longer valid and will throw when accessing properties or methods.