agi.foundation.graphics.imaging

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

Class RasterStream

java.lang.Object

agi.foundation.graphics.imaging.Raster

agi.foundation.graphics.imaging.RasterStream

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

FilteringRasterStream, VideoStream

public abstract class RasterStream
extends Raster
implements IDisposable

A raster, the data of which, is updated dynamically at the specified UpdateDelta. The class can be used to stream video and other dynamic raster data to textures and other Raster clients. Note to Implementers: When implementing a derived class of RasterStream, you must provide an implementation for the Update method. The Attributes (get) property of the Raster should be set in the constructor of the derived class.

See Also:

Raster, VideoStream, FilteringRasterStream, ProjectedRaster, Raster and Projection Streams topic

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RasterStream()

Method Summary

Modifier and Type	Method and Description
protected void	dispose(boolean disposing)
Duration	getUpdateDelta() Gets the update delta of the raster stream in seconds.
void	setUpdateDelta(Duration value) Sets the update delta of the raster stream in seconds.
abstract boolean	update(JulianDate time, JulianDate nextTime) When overridden in a derived class, updates the raster data associated with the raster stream at the specified time.

Methods inherited from class agi.foundation.graphics.imaging.Raster

apply, applyInPlace, copyFromBitmap, copyFromMemory, copyFromRaster, dispose, extractBand, extractBand, finalize, flip, getAttributes, getHeight, getWidth, rotate, setAttributes, toBitmap

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

RasterStream

protected RasterStream()

Method Detail

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class Raster

getUpdateDelta

public Duration getUpdateDelta()

Gets the update delta of the raster stream in seconds. The UpdateDelta defines the interval at which the Update method will be called. The default UpdateDelta is 0, which will call the Update method every time the SceneManager time changes. When animating, this means the Update method would be called on every animation step.

setUpdateDelta

public void setUpdateDelta(Duration value)

Sets the update delta of the raster stream in seconds. The UpdateDelta defines the interval at which the Update method will be called. The default UpdateDelta is 0, which will call the Update method every time the SceneManager time changes. When animating, this means the Update method would be called on every animation step.

update

public abstract boolean update(JulianDate time,
                               JulianDate nextTime)

When overridden in a derived class, updates the raster data associated with the raster stream at the specified time. When the Update method is called, the raster stream contains a raster data buffer defined by the current Attributes (get) of the stream for updating the raster data. The time parameter provides the current and next SceneManager time. Return true if the raster data was updated, otherwise return false.

Parameters:

time - The current SceneManager time.

nextTime - The next SceneManager time.

Returns:

True if the stream was updated, and false if it was not.