Gridarta Editor
ShrinkSelectionAction.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.action;
21 
22 import java.awt.Point;
23 import java.util.IdentityHashMap;
24 import java.util.List;
25 import java.util.Map;
26 import javax.swing.Action;
39 import net.sf.japi.swing.action.ActionMethod;
40 import org.jetbrains.annotations.NotNull;
41 import org.jetbrains.annotations.Nullable;
42 
48 public class ShrinkSelectionAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction, MapViewManagerListener<G, A, R> {
49 
53  @Nullable
55 
60  @Nullable
61  private Action action;
62 
66  @NotNull
68 
69  @Override
70  public void mapGridChanged(@NotNull final MapGridEvent e) {
71  updateAction();
72  }
73 
74  @Override
75  public void mapGridResized(@NotNull final MapGridEvent e) {
76  updateAction();
77  }
78 
79  };
80 
84  @ActionMethod
85  public void shrinkSelection() {
86  doShrinkSelection(true);
87  }
88 
89  @Override
90  public void setAction(@NotNull final Action action, @NotNull final String name) {
91  this.action = action;
92  updateAction();
93  }
94 
98  private void updateAction() {
99  if (action != null) {
100  action.setEnabled(doShrinkSelection(false));
101  }
102  }
103 
109  private boolean doShrinkSelection(final boolean performAction) {
110  final MapView<G, A, R> mapView = currentMapView;
111  if (currentMapView == null) {
112  return false;
113  }
114 
115  final MapGrid mapGrid = mapView.getMapGrid();
116  if (mapGrid.getSelectedRec() == null) {
117  return false;
118  }
119 
120  final List<MapSquare<G, A, R>> selectedSquares = mapView.getSelectedSquares();
121  if (selectedSquares.isEmpty()) {
122  return false;
123  }
124 
125  if (performAction) {
126  final MapModel<G, A, R> mapModel = mapView.getMapControl().getMapModel();
127  final MapArchObject<A> mapArchObject = mapModel.getMapArchObject();
128  final Point point = new Point();
129  mapGrid.beginTransaction();
130  try {
131  final Map<MapSquare<G, A, R>, Void> mapSquaresToShrink = new IdentityHashMap<>();
132  for (final MapSquare<G, A, R> mapSquare : selectedSquares) {
133 LOOP:
134  for (int dy = -1; dy <= 1; dy++) {
135  for (int dx = -1; dx <= 1; dx++) {
136  if (dx != 0 || dy != 0) {
137  mapSquare.getMapLocation(point, dx, dy);
138  if (mapArchObject.isPointValid(point) && (mapGrid.getFlags(point) & MapGrid.GRID_FLAG_SELECTION) == 0) {
139  mapSquaresToShrink.put(mapSquare, null);
140  break LOOP;
141  }
142  }
143  }
144  }
145  }
146  for (final MapSquare<G, A, R> mapSquare : mapSquaresToShrink.keySet()) {
147  mapSquare.getMapLocation(point);
148  mapGrid.select(point, SelectionMode.SUB);
149  }
150  } finally {
151  mapGrid.endTransaction();
152  }
153  }
154 
155  return true;
156  }
157 
158  @Override
159  public void activeMapViewChanged(@Nullable final MapView<G, A, R> mapView) {
160  if (currentMapView != null) {
162  }
163  currentMapView = mapView;
164  if (currentMapView != null) {
166  }
167  updateAction();
168  }
169 
170  @Override
171  public void mapViewCreated(@NotNull final MapView<G, A, R> mapView) {
172  // ignore
173  }
174 
175  @Override
176  public void mapViewClosing(@NotNull final MapView<G, A, R> mapView) {
177  // ignore
178  }
179 
180 }
net.sf.gridarta.model.mapgrid.MapGrid.addMapGridListener
void addMapGridListener(@NotNull final MapGridListener listener)
Registers a MapGridListener.
Definition: MapGrid.java:190
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.model.mapmodel.MapModel
A MapModel reflects the data of a map.
Definition: MapModel.java:75
net.sf.gridarta.model.mapgrid.MapGrid.getFlags
int getFlags(final int x, final int y)
Returns the flags of a square.
Definition: MapGrid.java:476
net.sf.gridarta.model.mapgrid.MapGrid.endTransaction
void endTransaction()
Ends a transaction.
Definition: MapGrid.java:776
net.sf.gridarta.gui.map.mapview.MapView.getMapGrid
MapGrid getMapGrid()
Returns the MapGrid of this view.
net.sf.gridarta.model.mapmodel.MapModel.getMapArchObject
A getMapArchObject()
Returns the Map Arch Object with the meta information about the map.
net.sf.gridarta.gui.map.mapview.MapView.getMapControl
MapControl< G, A, R > getMapControl()
Return the controller of this view.
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.action.ShrinkSelectionAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: ShrinkSelectionAction.java:90
net.sf.gridarta.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.model.mapgrid.MapGrid.GRID_FLAG_SELECTION
static final int GRID_FLAG_SELECTION
Selection - marks all selected squares.
Definition: MapGrid.java:98
net.sf.gridarta.model.maparchobject.MapArchObject.isPointValid
boolean isPointValid(@Nullable Point pos)
Checks whether the given coordinate is within map bounds.
net.sf
net.sf.gridarta.action.ShrinkSelectionAction.mapViewCreated
void mapViewCreated(@NotNull final MapView< G, A, R > mapView)
This event handler is called when a map view was created.
Definition: ShrinkSelectionAction.java:171
net.sf.gridarta.model.mapmodel
Definition: AboveFloorInsertionMode.java:20
net.sf.gridarta.gui.map.mapview.MapViewManagerListener
Interface for listeners interested in events related to {} instances.
Definition: MapViewManagerListener.java:33
net.sf.gridarta.model.mapgrid.SelectionMode.SUB
SUB
All squares that are preselected get unselected.
Definition: SelectionMode.java:36
net.sf.gridarta.model.mapgrid.MapGrid.getSelectedRec
Rectangle getSelectedRec()
Returns the smallest rectangle containing selection.
Definition: MapGrid.java:514
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.action.ShrinkSelectionAction.mapGridListener
final MapGridListener mapGridListener
The MapGridListener attached to currentMapView.
Definition: ShrinkSelectionAction.java:67
net.sf.gridarta.action.ShrinkSelectionAction.updateAction
void updateAction()
Updates the action's enabled state.
Definition: ShrinkSelectionAction.java:98
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.action.ShrinkSelectionAction.activeMapViewChanged
void activeMapViewChanged(@Nullable final MapView< G, A, R > mapView)
This event handler is called when the current map view has changed.
Definition: ShrinkSelectionAction.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.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.action.ShrinkSelectionAction.currentMapView
MapView< G, A, R > currentMapView
The active map view, or.
Definition: ShrinkSelectionAction.java:54
net.sf.gridarta.gui.map.mapview
Definition: AbstractMapView.java:20
net.sf.gridarta.gui.map.mapview.MapView
A map view consists of a map grid and a map cursor, and is attached to a map control.
Definition: MapView.java:43
net.sf.gridarta.model.mapgrid.SelectionMode
Modes that describe how squares get selected.
Definition: SelectionMode.java:26
net.sf.gridarta.action.ShrinkSelectionAction.action
Action action
The action associated with this editor action.
Definition: ShrinkSelectionAction.java:61
net.sf.gridarta.model.mapgrid.MapGrid.removeMapGridListener
void removeMapGridListener(@NotNull final MapGridListener listener)
Removes a MapGridListener.
Definition: MapGrid.java:198
net.sf.gridarta.model.mapgrid.MapGrid.select
void select(@NotNull final Point pos, @NotNull final SelectionMode selectionMode)
Selects or deselects a single square.
Definition: MapGrid.java:408
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
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.model.mapgrid.MapGridListener
Interface for listeners listening to MapGridEvents.
Definition: MapGridListener.java:29
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.mapview.MapView.getSelectedSquares
List< MapSquare< G, A, R > > getSelectedSquares()
Returns the selected squares.
net.sf.gridarta.model.mapgrid.MapGridEvent
This event is created by MapGrid.
Definition: MapGridEvent.java:29
net.sf.gridarta.action.ShrinkSelectionAction.mapViewClosing
void mapViewClosing(@NotNull final MapView< G, A, R > mapView)
This event handler is called when a map view is to be closed.
Definition: ShrinkSelectionAction.java:176
net.sf.gridarta.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.action.ShrinkSelectionAction.doShrinkSelection
boolean doShrinkSelection(final boolean performAction)
Shrinks the current map selection by one map square.
Definition: ShrinkSelectionAction.java:109
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.action.ShrinkSelectionAction
An EditorAction that shrinks the current selection by one map square.
Definition: ShrinkSelectionAction.java:48
net.sf.gridarta.action.ShrinkSelectionAction.shrinkSelection
void shrinkSelection()
Grows the current map selection by one map square.
Definition: ShrinkSelectionAction.java:85