com.mousebird.maply

Class QuadImageFrameLoader

java.lang.Object

com.mousebird.maply.QuadLoaderBase

com.mousebird.maply.QuadImageLoaderBase

com.mousebird.maply.QuadImageFrameLoader

All Implemented Interfaces:

QuadSamplingLayer.ClientInterface

public class QuadImageFrameLoader
extends QuadImageLoaderBase

The Maply Quad Image Frame Loader is for paging individual frames of image pyramids.
This works much like the Quad Image Loader, but handles more than one frame. You can animate between the frames with the QuadImageFrameAnimator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuadImageFrameLoader.FrameLoadMode
class	QuadImageFrameLoader.FrameStats The Maply Quad Image Frame Loader can generation per-frame stats.
class	QuadImageFrameLoader.Stats Stats generated by the Maply Quad Image Frame Loader.

Nested classes/interfaces inherited from class com.mousebird.maply.QuadLoaderBase

QuadLoaderBase.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	valid

Fields inherited from class com.mousebird.maply.QuadImageLoaderBase

BaseDrawPriorityDefault, DrawPriorityPerLevelDefault

Fields inherited from class com.mousebird.maply.QuadLoaderBase

loadInterp, samplingLayer, tileFetcher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QuadImageFrameLoader()
	QuadImageFrameLoader(BaseController control)
	QuadImageFrameLoader(SamplingParams params, TileInfoNew[] inTileInfos, BaseController control)

Method Summary

Modifier and Type	Method and Description
void	addFocus() Add another rendering focus to the frame loader.
double	getCurrentImage() Return the interpolated location within the array of frames.
double	getCurrentImage(int focusID) Return the interpolated location for a given focus within the array of frames.
int	getNumFocus() Return the number of focii.
int	getNumFrames() Number of tile sources passed in as individual frames.
QuadImageFrameLoader.Stats	getStats() Pull out the per-frame instantaneous stats.
void	setCurrentImage(double where) Set the interpolated location within the array of frames.
void	setCurrentImage(int focusID, double where) Set the currentImage for the given focus.
protected void	setCurrentImageNative(int focusID, double where)
void	setLoadFrameMode(QuadImageFrameLoader.FrameLoadMode mode) How frames are loaded (top down vs broad).
protected void	setLoadFrameModeNative(int mode)
void	setRenderTarget(int focusID, RenderTarget renderTarget) An optional render target for this loader.
protected void	setRenderTargetIDNative(int focusID, long renderTargetID)
void	setRequireTopTiles(boolean newVal) Set whether we require the top tiles to be loaded before a frame can be displayed.
void	setShader(int focusID, Shader shader) Shader to use for rendering the image frames for a particular focus.
protected void	setShaderIDNative(int focusID, long renderTargetID)
void	shutdown() Turn off the loader and shut things down.

Methods inherited from class com.mousebird.maply.QuadImageLoaderBase

changeTileInfo, delayedInit, delayedInitNative, getTileFetcher, makeLoaderReturn, setBaseDrawPriority, setBorderTexel, setColor, setColor, setDrawPriorityPerLevel, setImageFormat, setImageFormatNative, setRenderTarget, setRenderTargetID, setShader, setShaderID, setZBufferRead, setZBufferWrite

Methods inherited from class com.mousebird.maply.QuadLoaderBase

boundsForTile, boundsForTileNative, changeLoaderInterpreter, cleanupNative, clearFrameAsset, displayCenterForTile, displayCenterForTileNative, finalize, geoBoundsForTile, geoBoundsForTileNative, getController, getFlipY, getFrameID, getGeneration, mergeLoaderReturn, processBatchOps, reload, reloadNative, samplingLayerConnect, samplingLayerDisconnect, setDebugMode, setFlipY, setLoaderInterpreter, setTileFetcher, startTileFetch

Methods inherited from class java.lang.Object

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

Field Detail

valid

protected boolean valid

Constructor Detail

QuadImageFrameLoader

protected QuadImageFrameLoader()

QuadImageFrameLoader

public QuadImageFrameLoader(BaseController control)

QuadImageFrameLoader

public QuadImageFrameLoader(SamplingParams params,
                            TileInfoNew[] inTileInfos,
                            BaseController control)

Method Detail

setLoadFrameMode

public void setLoadFrameMode(QuadImageFrameLoader.FrameLoadMode mode)

How frames are loaded (top down vs broad). Top down is the default.

setLoadFrameModeNative

protected void setLoadFrameModeNative(int mode)

addFocus

public void addFocus()

Add another rendering focus to the frame loader. Normally you'd have one point of focus for a frame loader resulting in one image to be displayed. But if you're using render targets, you may want to have two and combine them in some way yourself. Or more. No idea why you'd do that. If you're going to do this, call addFocus right after you create the FrameLoader.

getNumFocus

public int getNumFocus()

Return the number of focii. Normally it's 1. See addFocus for what these are. You probably don't need to be using them.

setCurrentImage

public void setCurrentImage(double where)

Set the interpolated location within the array of frames.
Each set of frames can be accessed from [0.0,numFrames]. Images will be interpolated between those values and may be snapped if data has not yet loaded.
This value is used once per frame, so feel free to call this as much as you'd like.

setCurrentImage

public void setCurrentImage(int focusID,
                            double where)

Set the currentImage for the given focus. See addFocus for what those are.

Parameters:

focusID - Which focus to use. Only use this method if you've got more than one.

where - What to set the currentImage to.

setCurrentImageNative

protected void setCurrentImageNative(int focusID,
                                     double where)

getCurrentImage

public double getCurrentImage()

Return the interpolated location within the array of frames.

getCurrentImage

public double getCurrentImage(int focusID)

Return the interpolated location for a given focus within the array of frames.

setRequireTopTiles

public void setRequireTopTiles(boolean newVal)

Set whether we require the top tiles to be loaded before a frame can be displayed. Normally the system wants all the top level tiles to be loaded (just one at level 0) to be in memory before it will display a frame at all. You can turn this off.

setRenderTarget

public void setRenderTarget(int focusID,
                            RenderTarget renderTarget)

An optional render target for this loader. The loader can draw to a render target rather than to the screen. You use this in a multi-pass rendering setup. This version takes a specific focus. See addFocus for what that means.

setRenderTargetIDNative

protected void setRenderTargetIDNative(int focusID,
                                       long renderTargetID)

setShader

public void setShader(int focusID,
                      Shader shader)

Shader to use for rendering the image frames for a particular focus. Consult addFocus for what this means.

setShaderIDNative

protected void setShaderIDNative(int focusID,
                                 long renderTargetID)

getNumFrames

public int getNumFrames()

Number of tile sources passed in as individual frames.

shutdown

public void shutdown()

Description copied from class: QuadLoaderBase

Turn off the loader and shut things down.
This unregisters us with the sampling layer and shuts down the various objects we created.

Overrides:

shutdown in class QuadLoaderBase

getStats

public QuadImageFrameLoader.Stats getStats()

Pull out the per-frame instantaneous stats.