agi.foundation.cesium

(agi.foundation.cesium-2023r2.jar)

Class CesiumResource

java.lang.Object

agi.foundation.cesium.CesiumResource

public class CesiumResource
extends Object

A resource to be linked from or embedded into a CZML document.

Constructor Summary

Constructors

Constructor and Description
CesiumResource(String uri, CesiumResourceBehavior behavior) Initializes a new instance.
CesiumResource(URI uri, CesiumResourceBehavior behavior) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static CesiumResource	fromImage(RenderedImage image, CesiumImageFormat imageFormat) Create a CZML resource from an image loaded into memory.
static CesiumResource	fromStream(InputStream stream, CesiumImageFormat imageFormat) Create a CZML resource from a stream containing image data.
static CesiumResource	fromStream(InputStream stream, String mimeType) Create a CZML resource from a stream.
CesiumResourceBehavior	getBehavior() Gets how the resource is to be included in the document.
String	getUri() Gets the URI of the resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

CesiumResource

public CesiumResource(URI uri,
                      @Nonnull
                      CesiumResourceBehavior behavior)

Initializes a new instance.

Parameters:

uri - The URI of the resource.

behavior - The enumeration describing how the resource is to be included in the document.

CesiumResource

public CesiumResource(String uri,
                      @Nonnull
                      CesiumResourceBehavior behavior)

Initializes a new instance.

Parameters:

uri - The URI of the resource.

behavior - The enumeration describing how the resource is to be included in the document.

Method Detail

getUri

public final String getUri()

Gets the URI of the resource.

getBehavior

@Nonnull
public final CesiumResourceBehavior getBehavior()

Gets how the resource is to be included in the document.

fromImage

public static CesiumResource fromImage(RenderedImage image,
                                       @Nonnull
                                       CesiumImageFormat imageFormat)

Create a CZML resource from an image loaded into memory. The image data will be embedded in the CZML document using a data URI.

Parameters:

image - The image to write.

imageFormat - The format of the image.

Returns:

A new CesiumResource containing the image data as a data URI.

fromStream

public static CesiumResource fromStream(InputStream stream,
                                        @Nonnull
                                        CesiumImageFormat imageFormat)

Create a CZML resource from a stream containing image data. The image data will be embedded in the CZML document using a data URI.

Parameters:

stream - The stream containing image data to write.

imageFormat - The format of the image.

Returns:

A new CesiumResource containing the image data as a data URI.

fromStream

public static CesiumResource fromStream(InputStream stream,
                                        String mimeType)

Create a CZML resource from a stream. The data will be embedded in the CZML document using a data URI.

Parameters:

stream - The stream containing data to write.

mimeType - The mime type of the data.

Returns:

A new CesiumResource containing the data as a data URI.