Gridarta Editor
AbstractMapRenderer.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.awt.Point;
23 import java.awt.event.MouseEvent;
24 import java.io.File;
25 import java.io.IOException;
26 import java.util.Collections;
27 import java.util.HashMap;
28 import java.util.Map;
29 import javax.imageio.ImageIO;
30 import javax.swing.JComponent;
38 import org.jetbrains.annotations.NotNull;
39 import org.jetbrains.annotations.Nullable;
40 
45 public abstract class AbstractMapRenderer<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends JComponent implements MapRenderer {
46 
50  private static final long serialVersionUID = 1L;
51 
55  @NotNull
56  private Map<MapSquare<G, A, R>, ValidationError<G, A, R>> erroneousMapSquares = Collections.emptyMap();
57 
61  @NotNull
62  private final Point tmpPoint = new Point();
63 
67  @NotNull
68  private final MapModel<G, A, R> mapModel;
69 
74  @Nullable
76 
80  private boolean lightVisible;
81 
89  this.mapModel = mapModel;
90  this.gameObjectParser = gameObjectParser;
91  }
92 
93  @Override
94  public void printFullImage(@NotNull final File file) throws IOException {
95  ImageIO.write(getFullImage(), "png", file);
96  }
97 
104  this.erroneousMapSquares = new HashMap<>(erroneousMapSquares);
105  }
106 
110  public abstract void closeNotify();
111 
115  @Nullable
116  @Override
117  public String getToolTipText(@NotNull final MouseEvent event) {
118  if (!getSquareLocationAt(event.getPoint(), tmpPoint)) {
119  return null;
120  }
121 
123 
124  final ToolTipAppender<G, A, R> toolTipAppender = new ToolTipAppender<>(gameObjectParser);
125  for (final G gameObject : mapSquare.reverse()) {
126  toolTipAppender.appendGameObject(gameObject, false, "");
127  }
128 
129  final ValidationError<G, A, R> error = erroneousMapSquares.get(mapSquare);
130  if (error != null) {
131  toolTipAppender.appendValidationError(error);
132  }
133  return toolTipAppender.finish();
134  }
135 
136  @Override
137  public void setLightVisible(final boolean lightVisible) {
138  if (this.lightVisible == lightVisible) {
139  return;
140  }
141 
142  this.lightVisible = lightVisible;
143  forceRepaint();
144  }
145 
150  protected boolean isLightVisible() {
151  return lightVisible;
152  }
153 
154 }
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.closeNotify
abstract void closeNotify()
Must be called when this renderer is not used anymore.
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.getToolTipText
String getToolTipText(@NotNull final MouseEvent event)
@noinspection RefusedBequest
Definition: AbstractMapRenderer.java:117
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.setLightVisible
void setLightVisible(final boolean lightVisible)
If set, inverts the setting of net.sf.gridarta.model.mapviewsettings.MapViewSettings#isLightVisible()...
Definition: AbstractMapRenderer.java:137
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.erroneousMapSquares
Map< MapSquare< G, A, R >, ValidationError< G, A, R > > erroneousMapSquares
The MapSquares that are known to contain errors.
Definition: AbstractMapRenderer.java:56
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.setErroneousMapSquares
void setErroneousMapSquares(@NotNull final Map< MapSquare< G, A, R >, ValidationError< G, A, R >> erroneousMapSquares)
Sets the MapSquares that are known to contain errors.
Definition: AbstractMapRenderer.java:103
net.sf.gridarta.model.validation.errors.ValidationError
Super class of all errors that could occur during map validation.
Definition: ValidationError.java:45
net.sf.gridarta.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.lightVisible
boolean lightVisible
Whether the setting for lighted map squares is inverted.
Definition: AbstractMapRenderer.java:80
net.sf
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.mapModel
final MapModel< G, A, R > mapModel
The rendered MapModel.
Definition: AbstractMapRenderer.java:68
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.gui.map.renderer.AbstractMapRenderer
Abstract base class for classes implementing MapRenderer.
Definition: AbstractMapRenderer.java:45
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.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.isLightVisible
boolean isLightVisible()
Returns whether the setting for lighted map squares should be inverted.
Definition: AbstractMapRenderer.java:150
net
net.sf.gridarta.gui.map.renderer.MapRenderer.forceRepaint
void forceRepaint()
Repaint the view because some view parameters may have changed.
net.sf.gridarta.model.baseobject.GameObjectContainer.reverse
transient Iterable< G > reverse
Iterable implementation for reverse traversal.
Definition: GameObjectContainer.java:75
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.printFullImage
void printFullImage(@NotNull final File file)
Saves an image of the entire view to a file.
Definition: AbstractMapRenderer.java:94
net.sf.gridarta.gui.map.renderer.ToolTipAppender.appendValidationError
void appendValidationError(@NotNull final ValidationError< G, ?, ?> error)
Definition: ToolTipAppender.java:84
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.gui.map.renderer.ToolTipAppender.finish
String finish()
Definition: ToolTipAppender.java:94
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.AbstractMapRenderer
AbstractMapRenderer(@NotNull final MapModel< G, A, R > mapModel, @Nullable final GameObjectParser< G, A, R > gameObjectParser)
Creates a new instance.
Definition: AbstractMapRenderer.java:88
net.sf.gridarta.model.io
Reading and writing of maps, handling of paths.
Definition: AbstractAnimationObjectsReader.java:20
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.tmpPoint
final Point tmpPoint
Used to avoid creation millions of points.
Definition: AbstractMapRenderer.java:62
net.sf.gridarta.gui.map.renderer.ToolTipAppender
Definition: ToolTipAppender.java:38
net.sf.gridarta.model.mapmodel.MapModel.getMapSquare
MapSquare< G, A, R > getMapSquare(@NotNull Point pos)
Get the square at a specified location.
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.map.renderer.ToolTipAppender.appendGameObject
void appendGameObject(@NotNull final G gameObject, final boolean alwaysInclude, @NotNull final String prefix)
Definition: ToolTipAppender.java:61
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer.serialVersionUID
static final long serialVersionUID
The serial version UID.
Definition: AbstractMapRenderer.java:50
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.map.renderer.MapRenderer.getFullImage
BufferedImage getFullImage()
Returns an image of the entire map view.
net.sf.gridarta.model.io.GameObjectParser
Interface for classes that read or write GameObject instances.
Definition: GameObjectParser.java:37
net.sf.gridarta.gui.map.renderer.MapRenderer
Common interface for renderers of map control instances.
Definition: MapRenderer.java:36
net.sf.gridarta.gui.map.renderer.MapRenderer.getSquareLocationAt
boolean getSquareLocationAt(@NotNull Point point, @NotNull Point retPoint)
Returns the map location at the given point.