net.sf.gridarta.action.exportmap

Class MapImageCreator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.action.exportmap.MapImageCreator<G,A,R>

public class MapImageCreator<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object

Creates images from maps.

Constructor Summary

Constructors

Constructor and Description
MapImageCreator(@NotNull MapManager<G,A,R> mapManager, @NotNull RendererFactory<G,A,R> rendererFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@Nullable java.awt.image.BufferedImage	createImage(@NotNull MapFile mapFile, boolean includeTiledMaps, @NotNull ExportMapProgress progress) Creates an image from a map file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapImageCreator

public MapImageCreator(@NotNull
                       @NotNull MapManager<G,A,R> mapManager,
                       @NotNull
                       @NotNull RendererFactory<G,A,R> rendererFactory)

Creates a new instance.

Parameters:

mapManager - the map manager for loading maps

rendererFactory - the renderer factory for creating images from maps

Method Detail

createImage

@Nullable
public @Nullable java.awt.image.BufferedImage createImage(@NotNull
                                                                    @NotNull MapFile mapFile,
                                                                    boolean includeTiledMaps,
                                                                    @NotNull
                                                                    @NotNull ExportMapProgress progress)

Creates an image from a map file.

Parameters:

mapFile - the map file

includeTiledMaps - whether to include tiled maps

progress - the progress instance to notify

Returns:

the image or null if the user has cancelled the process