pt.lsts.neptus.plugins

Annotation Type MapTileProvider

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface MapTileProvider

This annotation will flag the WorldRenderPainter that is a map provider. The provider may use one of the two options. One option is to extend Tile and the tiles will be managed by the WorldRenderPainter. The second option is to implement MapPainterProvider and will be essentially a Renderer2DPainter with no managed by the WorldRenderPainter except if it should paint or not.

If no public static method getMaxLevelOfDetail() returning the max level of detail to use the WorldRenderPainter.MAX_LEVEL_OF_DETAIL will be used.

For Tiles a public static method getTilesMap() returning Map<String, Tile> is needed.

Also for Tiles a
public static void clearDiskCache() {
Tile.clearDiskCache(tileClassId);
} MUST be created.

Optionally a public static method isFetchableOrGenerated returning a boolean. true if the tiles are fetch outside and allow all tiles to be fetch at ounce for the current level of detail (StateRenderer2D.getLevelOfDetail()) plus 2 more levels up.

Additionally if you use NeptusProperty and usePropertiesOrCustomOptionsDialog() to true the WorldRenderPainter will try to call a public static method staticPropertiesChanged() in order for you to save the properties to disc or adjust the tile behavior. In the case of usePropertiesOrCustomOptionsDialog() equals to false, that is because the map provider will be using a custom options dialog. In this case a method with signature public JDialog getOptionsDialog(JDialog parent) or public JDialog getOptionsDialog(JDialog parent, StateRenderer2D renderer) will need to be implemented. This will be only called once and reused. The dispose will be called at the end when the WorldRenderPainter dies.

Author:

Paulo Dias

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	isBaseMapOrLayer
short	layerPriority
boolean	makeCustomOptionsDialogIndependent If true will not use Dialog.ModalityType.DOCUMENT_MODAL.
boolean	usePropertiesOrCustomOptionsDialog This will make the properties NeptusProperty to be automatically gathered into a dialog for user edition or it will call for getOptionsDialog(JDialog parent) (expecting a JDialog in return).

Element Detail

name

public abstract java.lang.String name

Returns:

the unique name identifier.

usePropertiesOrCustomOptionsDialog

public abstract boolean usePropertiesOrCustomOptionsDialog

This will make the properties NeptusProperty to be automatically gathered into a dialog for user edition or it will call for getOptionsDialog(JDialog parent) (expecting a JDialog in return).

Returns:

Default:

true

makeCustomOptionsDialogIndependent

public abstract boolean makeCustomOptionsDialogIndependent

If true will not use Dialog.ModalityType.DOCUMENT_MODAL.

Default:

false

isBaseMapOrLayer

public abstract boolean isBaseMapOrLayer

Returns:

true if is a base map and false for a layer. Base map is opaque and paints all the canvas while layers have a transparent background and may be used on top of base maps.

Default:

true

layerPriority

public abstract short layerPriority

Returns:

the layer priority. The higher the more on top it will be. This is only valid for layer maps, not base maps.

Default:

0