com.mousebird.maply

Class LoaderReturn

java.lang.Object

com.mousebird.maply.LoaderReturn

Direct Known Subclasses:

ImageLoaderReturn, ObjectLoaderReturn

public class LoaderReturn
extends java.lang.Object

Passed in to and returned by the Loader Interpreter. We pass this into the interpreter with the unparsed data. It parses it and passes that data back, possibly with an error.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	errorString If set, some part of the parser is letting us know about an error.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LoaderReturn()

Method Summary

Modifier and Type	Method and Description
void	addComponentObject(ComponentObject compObj) Add a single component object to the tile
void	addComponentObjects(ComponentObject[] compObjs) If any component objects are associated with the tile, these are them.
void	addOverlayComponentObjects(ComponentObject[] compObjs) These component objects are assumed to be overlaid and so only one set will be displayed at a time.
void	addTileData(byte[] data) Data returned from a tile request.
void	clearComponentObjects() Clear out the component objects, presumably to replace them.
void	clearOverlayComponentObjects()
void	deleteComponentObjects(RenderController control, ComponentManager compManage, ChangeSet changes)
void	dispose()
void	finalize()
byte[]	getFirstData() Return the first data object.
int	getFrame() If we're loading multi-frame data, which frame this is.
int	getGeneration() Return the generation this LoaderReturn has been given.
byte[][]	getTileData() Return the tile data objects as an array
TileID	getTileID() Tile this data belongs to.
void	mergeChanges(ChangeSet changes) Merge in the given changes requests to be handled upstream.
void	setFrame(long frameID, int frameIndex) Frames have unique 64 bit IDs as well as their location in the frame array.
void	setGeneration(int generation) Don't call this yourself.
void	setTileID(int tileX, int tileY, int tileLevel) Set the tile ID at creation.

Methods inherited from class java.lang.Object

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

Field Detail

errorString

public java.lang.String errorString

If set, some part of the parser is letting us know about an error.

Constructor Detail

LoaderReturn

protected LoaderReturn()

Method Detail

setTileID

public void setTileID(int tileX,
                      int tileY,
                      int tileLevel)

Set the tile ID at creation.

setFrame

public void setFrame(long frameID,
                     int frameIndex)

Frames have unique 64 bit IDs as well as their location in the frame array.

getTileID

public TileID getTileID()

Tile this data belongs to.

getFrame

public int getFrame()

If we're loading multi-frame data, which frame this is. Otherwise -1.

addTileData

public void addTileData(byte[] data)

Data returned from a tile request. Unparsed. You can add multiple of these, but the interpreter should be expecting that.

getTileData

public byte[][] getTileData()

Return the tile data objects as an array

getFirstData

public byte[] getFirstData()

Return the first data object. You're probably only expecting the one.

setGeneration

public void setGeneration(int generation)

Don't call this yourself.

getGeneration

public int getGeneration()

Return the generation this LoaderReturn has been given.

mergeChanges

public void mergeChanges(ChangeSet changes)

Merge in the given changes requests to be handled upstream.

addComponentObjects

public void addComponentObjects(ComponentObject[] compObjs)

If any component objects are associated with the tile, these are them. They need to start disabled. The system will enable and delete them when it is time.

clearComponentObjects

public void clearComponentObjects()

Clear out the component objects, presumably to replace them.

addComponentObject

public void addComponentObject(ComponentObject compObj)

Add a single component object to the tile

addOverlayComponentObjects

public void addOverlayComponentObjects(ComponentObject[] compObjs)

These component objects are assumed to be overlaid and so only one set will be displayed at a time.

clearOverlayComponentObjects

public void clearOverlayComponentObjects()

deleteComponentObjects

public void deleteComponentObjects(RenderController control,
                                   ComponentManager compManage,
                                   ChangeSet changes)

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

dispose

public void dispose()