Gridarta Editor
ErroneousMapSquares.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.mapview;
21 
22 import java.util.HashMap;
23 import java.util.Map;
24 import java.util.Set;
37 import net.sf.gridarta.utils.Size2D;
38 import org.jetbrains.annotations.NotNull;
39 import org.jetbrains.annotations.Nullable;
40 
47 public class ErroneousMapSquares<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
48 
52  @NotNull
53  private final MapModel<G, A, R> mapModel;
54 
58  @NotNull
59  private final MapGrid mapGrid;
60 
64  @NotNull
66 
70  @NotNull
71  private final Map<MapSquare<G, A, R>, ValidationError<G, A, R>> erroneousMapSquares = new HashMap<>();
72 
76  @NotNull
78 
79  @Override
80  public void mapSizeChanged(@NotNull final Size2D newSize) {
81  mapGrid.resize(newSize);
82  }
83 
84  @Override
85  public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
86  // ignore
87  }
88 
89  @Override
90  public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
91  // ignore
92  }
93 
94  @Override
95  public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
97  }
98 
99  @Override
100  public void mapFileChanged(@Nullable final MapFile oldMapFile) {
101  // ignore
102  }
103 
104  @Override
105  public void modifiedChanged() {
106  // ignore
107  }
108 
109  };
110 
117  public ErroneousMapSquares(@NotNull final MapModel<G, A, R> mapModel, @NotNull final MapGrid mapGrid, @NotNull final AbstractMapRenderer<G, A, R> renderer) {
118  this.mapModel = mapModel;
119  this.mapGrid = mapGrid;
120  this.renderer = renderer;
122  this.mapModel.addMapModelListener(mapModelListener);
123  }
124 
129  public void closeNotify() {
131  }
132 
137  protected void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
138  erroneousMapSquares.clear();
140  try {
142  for (final ValidationError<G, A, R> validationError : errors.getErrors()) {
143  for (final MapSquare<G, A, R> mapSquare : validationError.getMapSquares()) {
144  erroneousMapSquares.put(mapSquare, validationError);
145  mapGrid.setError(mapSquare.getMapX(), mapSquare.getMapY());
146  }
147  for (final G gameObject : validationError.getGameObjects()) {
148  final BaseObject<G, A, R, ?> topContainer = gameObject.getTopContainer();
149  mapGrid.setError(topContainer.getMapX(), topContainer.getMapY());
150  }
151  }
152  } finally {
154  }
156  }
157 
158 }
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.model.mapgrid.MapGrid.endTransaction
void endTransaction()
Ends a transaction.
Definition: MapGrid.java:776
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares
Tracks a MapModel for changed erroneous map squares and updates a MapGrid and an AbstractMapRenderer ...
Definition: ErroneousMapSquares.java:47
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.baseobject.BaseObject.getMapX
int getMapX()
Returns the X coordinate of this GameObject on its map.
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
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.mapGrid
final MapGrid mapGrid
The MapGrid to mark.
Definition: ErroneousMapSquares.java:59
net.sf.gridarta.model.mapgrid.MapGrid.clearErrors
void clearErrors()
Clears all error flags.
Definition: MapGrid.java:631
net.sf.gridarta.gui.map.renderer
Definition: AbstractIsoMapRenderer.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.mapview.ErroneousMapSquares.ErroneousMapSquares
ErroneousMapSquares(@NotNull final MapModel< G, A, R > mapModel, @NotNull final MapGrid mapGrid, @NotNull final AbstractMapRenderer< G, A, R > renderer)
Creates a new instance.
Definition: ErroneousMapSquares.java:117
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.model.mapgrid.MapGrid.beginTransaction
void beginTransaction()
Starts a new transaction.
Definition: MapGrid.java:756
net.sf.gridarta.gui.map.renderer.AbstractMapRenderer
Abstract base class for classes implementing MapRenderer.
Definition: AbstractMapRenderer.java:45
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
errors
errors
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:1
net.sf.gridarta.model.mapmodel.MapModel.removeMapModelListener
void removeMapModelListener(@NotNull MapModelListener< G, A, R > listener)
Unregister a map listener.
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.ErrorCollector
An interface for classes that collect errors.
Definition: ErrorCollector.java:33
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.renderer
final AbstractMapRenderer< G, A, R > renderer
The AbstractMapRenderer to notify.
Definition: ErroneousMapSquares.java:65
net.sf.gridarta.model.baseobject.BaseObject
Definition: BaseObject.java:34
net.sf.gridarta.model.mapmodel.MapFile
The location of a map file with a map directory.
Definition: MapFile.java:31
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.mapModelListener
final MapModelListener< G, A, R > mapModelListener
The MapModelListener attached to mapModel.
Definition: ErroneousMapSquares.java:77
net.sf.gridarta.model.mapmodel.MapModelListener
Interface for listeners listening on MapModel events.
Definition: MapModelListener.java:36
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.model.mapgrid
Definition: MapGrid.java:20
net.sf.gridarta.model.baseobject.BaseObject.getMapY
int getMapY()
Returns the Y coordinate of this GameObject on its map.
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.baseobject
Definition: AbstractBaseObject.java:20
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.model.mapgrid.MapGrid.resize
void resize(@NotNull final Size2D newSize)
Resizes the MapGrid.
Definition: MapGrid.java:215
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.closeNotify
void closeNotify()
Must be called when this instance is not used anymore.
Definition: ErroneousMapSquares.java:129
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.mapgrid.MapGrid.setError
void setError(final int x, final int y)
Sets the error flag at given coordinates.
Definition: MapGrid.java:619
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.erroneousMapSquares
final Map< MapSquare< G, A, R >, ValidationError< G, A, R > > erroneousMapSquares
The erroneous MapSquares.
Definition: ErroneousMapSquares.java:71
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.errorsChanged
void errorsChanged(@NotNull final ErrorCollector< G, A, R > errors)
Updates the erroneous map squares.
Definition: ErroneousMapSquares.java:137
net.sf.gridarta.gui.map.mapview.ErroneousMapSquares.mapModel
final MapModel< G, A, R > mapModel
The MapModel to track.
Definition: ErroneousMapSquares.java:53
net.sf.gridarta.utils.Size2D
The class Size2D represents a 2d rectangular area.
Definition: Size2D.java:30
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20