com.mousebird.maply

Class QuadLoaderBase

java.lang.Object

com.mousebird.maply.QuadLoaderBase

All Implemented Interfaces:

QuadSamplingLayer.ClientInterface

Direct Known Subclasses:

QuadImageLoaderBase, QuadPagingLoader

public class QuadLoaderBase
extends java.lang.Object
implements QuadSamplingLayer.ClientInterface

Base class for the quad loaders.
The image, frame, and data paging loaders all share much of the same functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuadLoaderBase.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected LoaderInterpreter	loadInterp
protected java.lang.ref.WeakReference<QuadSamplingLayer>	samplingLayer
protected TileFetcher	tileFetcher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QuadLoaderBase()
protected	QuadLoaderBase(BaseController inControl)
protected	QuadLoaderBase(BaseController inControl, SamplingParams params, int numFrames, QuadLoaderBase.Mode mode)

Method Summary

Modifier and Type	Method and Description
Mbr	boundsForTile(TileID tileID) Calculate the bounding box for a single tile in the local coordinate system.
protected void	boundsForTileNative(int x, int y, int level, Point2d ll, Point2d ur)
void	changeLoaderInterpreter(LoaderInterpreter newInterp) Change the interpreter for the data coming back.
protected void	cleanupNative(ChangeSet changes)
void	clearFrameAsset(com.mousebird.maply.QIFFrameAsset frameAsset)
Point3d	displayCenterForTile(TileID tileID) Return the center of the tile in display coordinates.
protected void	displayCenterForTileNative(int x, int y, int level, Point3d pt)
void	finalize()
Mbr	geoBoundsForTile(TileID tileID) Calculate the bounding box for a single tile in geographic.
protected void	geoBoundsForTileNative(int x, int y, int level, Point2d ll, Point2d ur)
BaseController	getController() Controller associated with this quad loader.
boolean	getFlipY() Control how tiles are indexed, either from the lower left or the upper left.
long	getFrameID(int frame) Each frame has a 64 bit frame ID (other than just 0 through whatever)
int	getGeneration() When you refresh the loader, we get a new generation.
protected LoaderReturn	makeLoaderReturn() The subclasses fill this in with the loaderReturn that they need.
protected void	mergeLoaderReturn(LoaderReturn loadReturn, ChangeSet changes)
void	processBatchOps(com.mousebird.maply.QIFBatchOps batchOps)
void	reload() Forces a reload of all currently loaded tiles.
protected void	reloadNative(ChangeSet changes)
void	samplingLayerConnect(QuadSamplingLayer layer, ChangeSet changes)
void	samplingLayerDisconnect(QuadSamplingLayer layer, ChangeSet changes)
void	setDebugMode(boolean debugMode) Set for a lot of debugging output.
void	setFlipY(boolean newVal) Control how tiles are indexed, either from the lower left or the upper left.
void	setLoaderInterpreter(LoaderInterpreter newInterp) Set the interpreter for the data coming back.
void	setTileFetcher(TileFetcher newFetcher) Use a specific tile fetcher rather than the one shared by everyone else.
void	shutdown() Turn off the loader and shut things down.
void	startTileFetch(com.mousebird.maply.QIFBatchOps batchOps, com.mousebird.maply.QIFFrameAsset[] inFrameAssets, int tileX, int tileY, int tileLevel, int priority, double importance)

Methods inherited from class java.lang.Object

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

Field Detail

samplingLayer

protected java.lang.ref.WeakReference<QuadSamplingLayer> samplingLayer

tileFetcher

protected TileFetcher tileFetcher

loadInterp

protected LoaderInterpreter loadInterp

Constructor Detail

QuadLoaderBase

protected QuadLoaderBase()

QuadLoaderBase

protected QuadLoaderBase(BaseController inControl)

QuadLoaderBase

protected QuadLoaderBase(BaseController inControl,
                         SamplingParams params,
                         int numFrames,
                         QuadLoaderBase.Mode mode)

Method Detail

setFlipY

public void setFlipY(boolean newVal)

Control how tiles are indexed, either from the lower left or the upper left. If set, we'll use the OSM approach (also Google Maps) to y indexing. That's that default and it's normally what you're run into. Strictly speaking, TMS addressing (the standard) is flipped the other way. So if your tile source looks odd, try setting this to false. Default value is true.

getFlipY

public boolean getFlipY()

Control how tiles are indexed, either from the lower left or the upper left. If set, we'll use the OSM approach (also Google Maps) to y indexing. That's that default and it's normally what you're run into. Strictly speaking, TMS addressing (the standard) is flipped the other way. So if your tile source looks odd, try setting this to false. Default value is true.

setDebugMode

public void setDebugMode(boolean debugMode)

Set for a lot of debugging output.

getController

public BaseController getController()

Controller associated with this quad loader. This is where you send geometry and such.

geoBoundsForTile

public Mbr geoBoundsForTile(TileID tileID)

Calculate the bounding box for a single tile in geographic.
This is a utility method for calculating the extents of a given tile in geographic (e.g. lon/lat).

Parameters:

tileID - The ID for the tile we're interested in.

Returns:

The lower left and upper right corner of the tile in geographic coordinates. Returns null in case of error.

geoBoundsForTileNative

protected void geoBoundsForTileNative(int x,
                                      int y,
                                      int level,
                                      Point2d ll,
                                      Point2d ur)

boundsForTile

public Mbr boundsForTile(TileID tileID)

Calculate the bounding box for a single tile in the local coordinate system. This utility method calculates the bounding box for a tile in the coordinate system used for the layer.

Parameters:

tileID - The ID for the tile we're interested in.

Returns:

The lower left and upper right corner of the tile in local coordinates.

boundsForTileNative

protected void boundsForTileNative(int x,
                                   int y,
                                   int level,
                                   Point2d ll,
                                   Point2d ur)

displayCenterForTile

public Point3d displayCenterForTile(TileID tileID)

Return the center of the tile in display coordinates.

Parameters:

tileID - The ID for the tile we're interested in.

Returns:

Return the center in display space for the given tile.

displayCenterForTileNative

protected void displayCenterForTileNative(int x,
                                          int y,
                                          int level,
                                          Point3d pt)

setTileFetcher

public void setTileFetcher(TileFetcher newFetcher)

Use a specific tile fetcher rather than the one shared by everyone else.

setLoaderInterpreter

public void setLoaderInterpreter(LoaderInterpreter newInterp)

Set the interpreter for the data coming back. If you're just getting images, don't set this. Only call this at startup. If you need to change the interpreter, call changeLoaderInterpreter()

changeLoaderInterpreter

public void changeLoaderInterpreter(LoaderInterpreter newInterp)

Change the interpreter for the data coming back. This will force a reload.

Parameters:

newInterp -

makeLoaderReturn

protected LoaderReturn makeLoaderReturn()

The subclasses fill this in with the loaderReturn that they need.

shutdown

public void shutdown()

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

cleanupNative

protected void cleanupNative(ChangeSet changes)

mergeLoaderReturn

protected void mergeLoaderReturn(LoaderReturn loadReturn,
                                 ChangeSet changes)

samplingLayerConnect

public void samplingLayerConnect(QuadSamplingLayer layer,
                                 ChangeSet changes)

Specified by:

samplingLayerConnect in interface QuadSamplingLayer.ClientInterface

samplingLayerDisconnect

public void samplingLayerDisconnect(QuadSamplingLayer layer,
                                    ChangeSet changes)

Specified by:

samplingLayerDisconnect in interface QuadSamplingLayer.ClientInterface

processBatchOps

public void processBatchOps(com.mousebird.maply.QIFBatchOps batchOps)

clearFrameAsset

public void clearFrameAsset(com.mousebird.maply.QIFFrameAsset frameAsset)

startTileFetch

public void startTileFetch(com.mousebird.maply.QIFBatchOps batchOps,
                           com.mousebird.maply.QIFFrameAsset[] inFrameAssets,
                           int tileX,
                           int tileY,
                           int tileLevel,
                           int priority,
                           double importance)

getFrameID

public long getFrameID(int frame)

Each frame has a 64 bit frame ID (other than just 0 through whatever)

getGeneration

public int getGeneration()

When you refresh the loader, we get a new generation. This is how we track data in transit.

reload

public void reload()

Forces a reload of all currently loaded tiles.

reloadNative

protected void reloadNative(ChangeSet changes)

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object