Gridarta Editor
ImageCreator.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.gui.map.renderer;
21 
22 import java.io.File;
23 import java.io.IOException;
30 import net.sf.japi.swing.action.ActionBuilder;
31 import net.sf.japi.swing.action.ActionBuilderFactory;
32 import org.apache.log4j.Category;
33 import org.apache.log4j.Logger;
34 import org.jetbrains.annotations.NotNull;
35 
41 public class ImageCreator<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
42 
46  @NotNull
47  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
48 
52  @NotNull
53  private static final Category LOG = Logger.getLogger(ImageCreator.class);
54 
58  @NotNull
60 
64  @NotNull
66 
73  this.mapManager = mapManager;
74  this.rendererFactory = rendererFactory;
75  }
76 
77  public void createImage(@NotNull final MapModel<G, A, R> mapModel, @NotNull final File file) throws IOException {
78  final File tmpFile = new File(file.getPath() + ".tmp");
80  if (!tmpFile.renameTo(file)) {
81  if (!file.exists() || !file.delete() || !tmpFile.renameTo(file)) {
82  throw new IOException("cannot rename " + tmpFile + " to " + file);
83  }
84  }
85  if (LOG.isInfoEnabled()) {
86  LOG.info(ACTION_BUILDER.format("logImageCreated", file, mapModel.getMapArchObject().getMapName()));
87  }
88  }
89 
90  public void makeImage(@NotNull final File in, @NotNull final File out) throws IOException {
91  if (LOG.isInfoEnabled()) {
92  LOG.info("converting " + in + " to " + out);
93  }
94 
95  if (in.canRead()) {
96  final MapControl<G, A, R> mapControl = mapManager.openMapFile(in, false);
97  try {
98  createImage(mapControl.getMapModel(), out);
99  } finally {
100  mapManager.release(mapControl);
101  }
102  }
103  }
104 
105 }
net.sf.gridarta.gui.map.renderer.ImageCreator.LOG
static final Category LOG
The Logger for printing log messages.
Definition: ImageCreator.java:53
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.gui.map.renderer.ImageCreator.ImageCreator
ImageCreator(@NotNull final MapManager< G, A, R > mapManager, @NotNull final RendererFactory< G, A, R > rendererFactory)
Creates a new instance.
Definition: ImageCreator.java:72
net.sf.gridarta.model.mapmanager.MapManager
A MapManager manages all opened maps.
Definition: MapManager.java:37
net.sf.gridarta.gui.map.renderer.ImageCreator.createImage
void createImage(@NotNull final MapModel< G, A, R > mapModel, @NotNull final File file)
Definition: ImageCreator.java:77
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.gui.map.renderer.RendererFactory.newSimpleMapRenderer
MapRenderer newSimpleMapRenderer(@NotNull MapModel< G, A, R > mapModel)
Creates a new map renderer instance which paints only squares but no grid, cursor,...
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.mapcontrol
Definition: DefaultMapControl.java:20
net.sf.gridarta.gui.map.renderer.ImageCreator.mapManager
final MapManager< G, A, R > mapManager
The MapManager for loading map instances.
Definition: ImageCreator.java:59
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.gui.map.renderer.ImageCreator.rendererFactory
final RendererFactory< G, A, R > rendererFactory
The RendererFactory for creating images.
Definition: ImageCreator.java:65
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.mapmanager.MapManager.openMapFile
MapControl< G, A, R > openMapFile(@NotNull MapFile mapFile, boolean interactive)
Loads a map file.
net.sf.gridarta.gui.map.renderer.ImageCreator.makeImage
void makeImage(@NotNull final File in, @NotNull final File out)
Definition: ImageCreator.java:90
net.sf.gridarta.model.mapmanager.MapManager.release
void release(@NotNull MapControl< G, A, R > mapControl)
Releases a MapControl instance.
net.sf.gridarta.gui.map.renderer.ImageCreator
Creates images from map instances.
Definition: ImageCreator.java:41
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.map.renderer.RendererFactory< G, A, R >
net.sf.gridarta.gui.map.renderer.ImageCreator.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder.
Definition: ImageCreator.java:47
net.sf.gridarta.model.mapcontrol.MapControl
Currently nothing more than a marker interface for unification.
Definition: MapControl.java:35
net.sf.gridarta.model.mapcontrol.MapControl.getMapModel
MapModel< G, A, R > getMapModel()
Returns the map model.
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.map.renderer.MapRenderer.printFullImage
void printFullImage(@NotNull File file)
Saves an image of the entire view to a file.