Gridarta Editor
FlatMapRenderer.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.var.crossfire.gui.map.renderer;
21 
22 import java.awt.Color;
23 import java.awt.Dimension;
24 import java.awt.Graphics;
25 import java.awt.Image;
26 import java.awt.Point;
27 import java.awt.Rectangle;
28 import java.awt.image.BufferedImage;
29 import java.awt.image.RenderedImage;
30 import java.lang.ref.SoftReference;
31 import javax.swing.Icon;
32 import javax.swing.ImageIcon;
47 import org.apache.log4j.Category;
48 import org.apache.log4j.Logger;
49 import org.jetbrains.annotations.NotNull;
50 import org.jetbrains.annotations.Nullable;
51 
57 
61  @NotNull
62  private static final Category LOG = Logger.getLogger(FlatMapRenderer.class);
63 
67  private static final long serialVersionUID = 1L;
68 
73  @NotNull
75 
79  @NotNull
81 
86  @NotNull
87  private final Color @NotNull [] highLightMask = { new Color(1.0f, 0.0f, 0.0f, 0.33f), new Color(0.0f, 1.0f, 0.0f, 0.33f), new Color(0.0f, 1.0f, 1.0f, 0.33f), };
88 
92  @NotNull
93  private final Icon emptySquareIcon;
94 
99  @NotNull
100  private final Point offset = new Point();
101 
107  @Nullable
108  private SoftReference<BufferedImage> backBufferRef;
109 
113  @NotNull
115 
119  @NotNull
120  private final FilterState filterState = new FilterState();
121 
125  @NotNull
127 
132  @NotNull
133  private final FilterConfigListener filterConfigListener = (filterConfigChangeType, filterConfig) -> forceRepaint();
134 
149  this.mapModel = mapModel;
150  emptySquareIcon = resourceIcons.getResourceIcon(ResourceIcons.SQUARE_EMPTY);
151  this.filterControl = filterControl;
152  this.mapViewSettings = mapViewSettings;
153  this.smoothingRenderer = smoothingRenderer;
154  init();
155  this.filterControl.addConfigListener(filterConfigListener);
156  }
157 
158  @Override
159  public void closeNotify() {
160  super.closeNotify();
161  filterControl.removeConfigListener(filterConfigListener);
162  }
163 
164  @Override
165  protected void updateSquare(@NotNull final Point point) {
166  if (!mapModel.getMapArchObject().isPointValid(point)) {
167  return;
168  }
169 
170  final Image backBuffer = getBackBufferImage();
171  if (backBuffer == null) {
172  return;
173  }
174 
175  final Graphics g = backBuffer.getGraphics();
176  try {
177  paintSquare(g, getBorderOffsetX() + point.x * IGUIConstants.SQUARE_WIDTH, getBorderOffsetY() + point.y * IGUIConstants.SQUARE_HEIGHT, mapModel.getMapSquare(point));
178  paintSquareGrid(g, point);
179  paintSquareSelection(g, point);
180  } finally {
181  g.dispose();
182  }
183  }
184 
185  @Override
186  protected void updateSquares(@NotNull final Rectangle rectangle) {
187  final Point point = new Point();
189  for (point.x = rectangle.x - 1; point.x < rectangle.x + rectangle.width + 1; point.x++) {
190  for (point.y = rectangle.y - 1; point.y < rectangle.y + rectangle.height + 1; point.y++) {
191  updateSquare(point);
192  }
193  }
194  } else {
195  for (point.x = rectangle.x; point.x < rectangle.x + rectangle.width; point.x++) {
196  for (point.y = rectangle.y; point.y < rectangle.y + rectangle.height; point.y++) {
197  updateSquare(point);
198  }
199  }
200  }
201  }
202 
203  @Override
204  protected void updateAll() {
205  final Image backBuffer = getBackBufferImage();
206  if (backBuffer == null) {
207  return;
208  }
209 
210  final Graphics graphics = backBuffer.getGraphics();
211  try {
212  paintComponent(graphics, false, false);
213  } finally {
214  graphics.dispose();
215  }
216  }
217 
218  @Override
219  public void paintComponent(@NotNull final Graphics g) {
220  final BufferedImage backBuffer = getBackBufferImage();
221  if (backBuffer == null) {
222  paintComponent(g, false, true);
223  } else {
224  final int w = backBuffer.getWidth();
225  final int h = backBuffer.getHeight();
226  g.drawImage(backBuffer, 0, 0, w, h, 0, 0, w, h, null);
227  }
228  }
229 
230  @Override
231  protected void resizeBackBuffer(@NotNull final Dimension size) {
232  final RenderedImage backBuffer = getBackBufferImage();
233  if (backBuffer != null && backBuffer.getWidth() == size.width && backBuffer.getHeight() == size.height) {
234  return;
235  }
236 
237  backBufferRef = null;
238 
239  if (LOG.isDebugEnabled()) {
240  LOG.debug("Creating a backbuffer of size " + size.width + "x" + size.height + ".");
241  }
242  final BufferedImage newBackBuffer;
243  //The backbuffer is optional
244  //noinspection ErrorNotRethrown
245  try {
246  newBackBuffer = new BufferedImage(size.width, size.height, BufferedImage.TYPE_INT_ARGB);
247  } catch (final OutOfMemoryError ignore) {
248  if (LOG.isDebugEnabled()) {
249  LOG.debug("out of memory creating new back buffer");
250  }
251  return;
252  }
253  final Graphics g = newBackBuffer.getGraphics();
254  try {
255  g.setColor(getBackground());
256  g.fillRect(0, 0, size.width, size.height);
257  } finally {
258  g.dispose();
259  }
260  backBufferRef = new SoftReference<>(newBackBuffer);
261  }
262 
263  @Override
264  protected void paintSquare(@NotNull final Graphics g, final int x, final int y, @NotNull final MapSquare<GameObject, MapArchObject, Archetype> square) {
265  filterControl.newSquare(filterState);
266  if (square.isEmpty()) {
267  emptySquareIcon.paintIcon(this, g, x, y);
268  } else {
271  final int borderOffsetX = getBorderOffsetX();
272  final int borderOffsetY = getBorderOffsetY();
273  int layer = -1;
274  for (final GameObject node : square) {
275  if (node.getAttributeInt(GameObject.INVISIBLE, true) == 0) {
276  layer++;
277  }
278  filterControl.objectInSquare(filterState, node);
279  if (filterControl.canShow(node) && mapViewSettings.isEditType(node)) {
280  paintGameObject(g, x, y, node);
281  if (node.getAttributeInt(GameObject.SMOOTHLEVEL, true) > 0) {
282  smoothingRenderer.paintSmooth(g, square.getMapLocation(), node.getAttributeInt(GameObject.SMOOTHLEVEL, true), layer, false, borderOffsetX, borderOffsetY);
283  }
284  }
285  }
286  if (layer > -1) {
287  smoothingRenderer.paintSmooth(g, square.getMapLocation(), 1, layer + 1, true, borderOffsetX, borderOffsetY);
288  }
289  } else {
290  for (final GameObject node : square) {
291  filterControl.objectInSquare(filterState, node);
292  if (filterControl.canShow(node) && mapViewSettings.isEditType(node)) {
293  paintGameObject(g, x, y, node);
294  }
295  }
296  }
297  }
298  for (int i = 0; i < FilterControl.MAX_HIGHLIGHT; i++) {
299  if (filterControl.isHighlightedSquare(filterState, i)) {
300  final Color color = g.getColor();
301  g.setColor(highLightMask[i]);
303  g.setColor(color);
304  }
305  }
306  }
307 
315  private void paintGameObject(@NotNull final Graphics g, final int x, final int y, @NotNull final net.sf.gridarta.model.gameobject.GameObject<GameObject, MapArchObject, Archetype> node) {
316  final ImageIcon img = node.getNormalImage();
317  if (!node.isMulti() || (img.getIconWidth() == IGUIConstants.SQUARE_WIDTH && img.getIconHeight() == IGUIConstants.SQUARE_HEIGHT)) {
318  offset.x = 0;
319  offset.y = 0;
320  } else {
321  // this is an oversized image, so it must be shifted
322  // XXX: it must also be clipped to not overwrite filter information
323  offset.x = IGUIConstants.SQUARE_WIDTH * (node.getArchetype().getMultiX() - node.getMinX());
324  offset.y = IGUIConstants.SQUARE_HEIGHT * (node.getArchetype().getMultiY() - node.getMinY());
325  }
326  g.drawImage(img.getImage(), x, y, x + IGUIConstants.SQUARE_WIDTH, y + IGUIConstants.SQUARE_HEIGHT, offset.x, offset.y, offset.x + IGUIConstants.SQUARE_WIDTH, offset.y + IGUIConstants.SQUARE_HEIGHT, this);
327  }
328 
336  @Nullable
337  private BufferedImage getBackBufferImage() {
338  if (backBufferRef == null) {
339  return null;
340  }
341 
342  final BufferedImage backBuffer = backBufferRef.get();
343  if (backBuffer == null) {
344  if (LOG.isDebugEnabled()) {
345  LOG.debug("lost back buffer");
346  }
347  backBufferRef = null;
348  return null;
349  }
350 
351  return backBuffer;
352  }
353 
354 }
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.paintGameObject
void paintGameObject(@NotNull final Graphics g, final int x, final int y, @NotNull final net.sf.gridarta.model.gameobject.GameObject< GameObject, MapArchObject, Archetype > node)
Paints one game object.
Definition: FlatMapRenderer.java:315
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.model.mapviewsettings.MapViewSettings.isSmoothing
boolean isSmoothing()
Returns the smoothing setting.
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.getBorderOffsetX
int getBorderOffsetX()
Returns the x offset to map borders.
Definition: AbstractFlatMapRenderer.java:552
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.smoothingRenderer
final SmoothingRenderer smoothingRenderer
The SmoothingRenderer for rendering smoothed faces.
Definition: FlatMapRenderer.java:126
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer
A AbstractFlatMapRenderer to render map files.
Definition: FlatMapRenderer.java:56
net.sf.gridarta.var.crossfire.model.archetype
Definition: Archetype.java:20
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.filter.FilterState
The highlighted state while using a FilterControl instance.
Definition: FilterState.java:29
net.sf.gridarta.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.model.mapviewsettings
Definition: AbstractMapViewSettings.java:20
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.paintSquare
void paintSquare(@NotNull final Graphics g, final int x, final int y, @NotNull final MapSquare< GameObject, MapArchObject, Archetype > square)
Paints one square.
Definition: FlatMapRenderer.java:264
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.FlatMapRenderer
FlatMapRenderer(@NotNull final MapViewSettings mapViewSettings, @NotNull final FilterControl< GameObject, MapArchObject, Archetype > filterControl, @NotNull final MapModel< GameObject, MapArchObject, Archetype > mapModel, @NotNull final MapGrid mapGrid, @NotNull final GridMapSquarePainter gridMapSquarePainter, @NotNull final GameObjectParser< GameObject, MapArchObject, Archetype > gameObjectParser, @NotNull final ResourceIcons resourceIcons, @NotNull final SmoothingRenderer smoothingRenderer)
Creates a new instance.
Definition: FlatMapRenderer.java:147
net.sf
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.gui.map.renderer
Definition: AbstractIsoMapRenderer.java:20
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.backBufferRef
SoftReference< BufferedImage > backBufferRef
The back buffer for this map.
Definition: FlatMapRenderer.java:108
net.sf.gridarta.utils.ResourceIcons.SQUARE_EMPTY
static final String SQUARE_EMPTY
Definition: ResourceIcons.java:80
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.mapviewsettings.MapViewSettings
Container for settings that affect the rendering of maps.
Definition: MapViewSettings.java:30
net.sf.gridarta.var
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.gridMapSquarePainter
final GridMapSquarePainter gridMapSquarePainter
The GridMapSquarePainter to use.
Definition: AbstractFlatMapRenderer.java:85
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer
This is the default renderer of a map.
Definition: AbstractFlatMapRenderer.java:59
net.sf.gridarta.gui.map.renderer.GridMapSquarePainter
Paints overlays for map grids.
Definition: GridMapSquarePainter.java:34
net.sf.gridarta.model.filter.FilterConfigListener
Interface for listeners interested in FilterConfig related changes.
Definition: FilterConfigListener.java:30
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.filter
Classes for Filters.
Definition: BtnPopup.java:20
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.gameObjectParser
final GameObjectParser< G, A, R > gameObjectParser
The GameObjectParser for creating tooltip information or.
Definition: AbstractMapRenderer.java:75
net.sf.gridarta.var.crossfire.IGUIConstants
Defines common UI constants used in different dialogs and all used icon files.
Definition: IGUIConstants.java:30
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.closeNotify
void closeNotify()
Must be called when this renderer is not used anymore.
Definition: FlatMapRenderer.java:159
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.var.crossfire.model.archetype.Archetype
Implements Crossfire archetypes.
Definition: Archetype.java:30
net.sf.gridarta.var.crossfire.model.maparchobject.MapArchObject
MapArchObject contains the specific meta data about a map that is stored in the map-arch,...
Definition: MapArchObject.java:39
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.mapGrid
final MapGrid mapGrid
The MapGrid to render.
Definition: AbstractFlatMapRenderer.java:98
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.paintComponent
void paintComponent(@NotNull final Graphics g)
@noinspection AbstractMethodOverridesConcreteMethod
Definition: FlatMapRenderer.java:219
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.emptySquareIcon
final Icon emptySquareIcon
The Icon for painting empty map squares.
Definition: FlatMapRenderer.java:93
net.sf.gridarta.var.crossfire
Main package of Gridarta4Crossfire, contains all classes specific to the Crossfire version of the Gri...
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.filterControl
final FilterControl< GameObject, MapArchObject, Archetype > filterControl
The FilterControl for filtering painted game objects.
Definition: FlatMapRenderer.java:80
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.updateSquare
void updateSquare(@NotNull final Point point)
Callback function that is called when a square may have changed.
Definition: FlatMapRenderer.java:165
net.sf.gridarta.model.mapviewsettings.MapViewSettings.isEditType
boolean isEditType(int editType)
Get information on the current state of edit type.
net.sf.gridarta.model.filter
Definition: AbstractFilterConfig.java:20
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.forceRepaint
void forceRepaint()
Repaint the view because some view parameters may have changed.
Definition: AbstractFlatMapRenderer.java:361
net.sf.gridarta.var.crossfire.model
net.sf.gridarta.var.crossfire.IGUIConstants.SQUARE_WIDTH
int SQUARE_WIDTH
The width of a square in pixels.
Definition: IGUIConstants.java:35
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.updateAll
void updateAll()
Callback function that is called when any square may have changed.
Definition: FlatMapRenderer.java:204
net.sf.gridarta.var.crossfire.gui.map.renderer.SmoothingRenderer.paintSmooth
void paintSmooth(@NotNull final Graphics graphics, @NotNull final Point pos, final int level, final int firstLayer, final boolean allLayers, final int borderOffsetX, final int borderOffsetY)
Draw the smoothing information at given position of map, for a given limit smoothlevel,...
Definition: SmoothingRenderer.java:110
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.highLightMask
final Color[] highLightMask
The colors for highlighting.
Definition: FlatMapRenderer.java:87
net.sf.gridarta.model.io
Reading and writing of maps, handling of paths.
Definition: AbstractAnimationObjectsReader.java:20
net.sf.gridarta.var.crossfire.model.gameobject.GameObject.SMOOTHLEVEL
static final String SMOOTHLEVEL
The name of the "smoothlevel" attribute.
Definition: GameObject.java:70
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.LOG
static final Category LOG
The Logger for printing log messages.
Definition: FlatMapRenderer.java:62
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.mapModel
final MapModel< GameObject, MapArchObject, Archetype > mapModel
The MapModel to render.
Definition: FlatMapRenderer.java:74
net.sf.gridarta.model.mapgrid.MapGrid
2D-Grid containing flags for selection, pre-selection, cursor, warnings and errors.
Definition: MapGrid.java:46
net.sf.gridarta.var.crossfire.model.gameobject.GameObject.INVISIBLE
static final String INVISIBLE
The name of the "invisible" attribute.
Definition: GameObject.java:64
net.sf.gridarta.model.mapgrid
Definition: MapGrid.java:20
net.sf.gridarta.gui.filter.FilterControl
Definition: FilterControl.java:33
net.sf.gridarta.model
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.mapViewSettings
final MapViewSettings mapViewSettings
The map view settings instance.
Definition: FlatMapRenderer.java:114
net.sf.gridarta.gui.filter.FilterControl.MAX_HIGHLIGHT
int MAX_HIGHLIGHT
Definition: FilterControl.java:35
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.resizeBackBuffer
void resizeBackBuffer(@NotNull final Dimension size)
Resizes the backing buffer to the new grid size.
Definition: FlatMapRenderer.java:231
net.sf.gridarta.var.crossfire.gui.map.renderer.SmoothingRenderer
Renderer for smoothed faces as used by Crossfire.
Definition: SmoothingRenderer.java:42
net.sf.gridarta.var.crossfire.model.maparchobject
Definition: DefaultMapArchObjectFactory.java:20
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.var.crossfire.model.gameobject
Handles the Crossfire variants of GameObjects and Archetypes.
Definition: DefaultGameObjectFactory.java:20
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.paintSquareSelection
void paintSquareSelection(@NotNull final Graphics graphics, @NotNull final Point point)
Paints the selection for one square.
Definition: AbstractFlatMapRenderer.java:422
net.sf.gridarta.var.crossfire.model.gameobject.GameObject
Handles the Crossfire GameObjects.
Definition: GameObject.java:41
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.updateSquares
void updateSquares(@NotNull final Rectangle rectangle)
Callback function that is called when multiple squares may have changed.
Definition: FlatMapRenderer.java:186
net.sf.gridarta.utils.ResourceIcons
Creates ImageIcon instances from resources.
Definition: ResourceIcons.java:46
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.init
void init()
Finishes initialization of this instance.
Definition: AbstractFlatMapRenderer.java:308
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.getBackBufferImage
BufferedImage getBackBufferImage()
Get the back buffer image for the map.
Definition: FlatMapRenderer.java:337
net.sf.gridarta.model.io.GameObjectParser
Interface for classes that read or write GameObject instances.
Definition: GameObjectParser.java:37
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.offset
final Point offset
The offset for painting the map contents.
Definition: FlatMapRenderer.java:100
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.serialVersionUID
static final long serialVersionUID
Serial Version UID.
Definition: FlatMapRenderer.java:67
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.filterConfigListener
final FilterConfigListener filterConfigListener
The FilterConfigListener attached to filterControl to repaint all after config changes.
Definition: FlatMapRenderer.java:133
net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.filterState
final FilterState filterState
The filter state instance for this map renderer.
Definition: FlatMapRenderer.java:120
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.getBorderOffsetY
int getBorderOffsetY()
Returns the y offset to map borders.
Definition: AbstractFlatMapRenderer.java:560
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.paintSquareGrid
void paintSquareGrid(@NotNull final Graphics graphics, @NotNull final Point point)
Paints the grid for one square.
Definition: AbstractFlatMapRenderer.java:410
net.sf.gridarta.var.crossfire.IGUIConstants.SQUARE_HEIGHT
int SQUARE_HEIGHT
The height of a square in pixels.
Definition: IGUIConstants.java:40