Gridarta Editor
GrowSelectionAction.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.List;
24 import javax.swing.Action;
37 import net.sf.japi.swing.action.ActionMethod;
38 import org.jetbrains.annotations.NotNull;
39 import org.jetbrains.annotations.Nullable;
40 
45 public class GrowSelectionAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction, MapViewManagerListener<G, A, R> {
46 
50  @Nullable
52 
57  @Nullable
58  private Action action;
59 
63  @NotNull
65 
66  @Override
67  public void mapGridChanged(@NotNull final MapGridEvent e) {
68  updateAction();
69  }
70 
71  @Override
72  public void mapGridResized(@NotNull final MapGridEvent e) {
73  updateAction();
74  }
75 
76  };
77 
81  @ActionMethod
82  public void growSelection() {
83  doGrowSelection(true);
84  }
85 
86  @Override
87  public void setAction(@NotNull final Action action, @NotNull final String name) {
88  this.action = action;
89  updateAction();
90  }
91 
95  private void updateAction() {
96  if (action != null) {
97  action.setEnabled(doGrowSelection(false));
98  }
99  }
100 
106  private boolean doGrowSelection(final boolean performAction) {
107  final MapView<G, A, R> mapView = currentMapView;
108  if (mapView == null) {
109  return false;
110  }
111 
112  final MapGrid mapGrid = mapView.getMapGrid();
113  if (mapGrid.getSelectedRec() == null) {
114  return false;
115  }
116 
117  final List<MapSquare<G, A, R>> selectedSquares = mapView.getSelectedSquares();
118  if (selectedSquares.isEmpty()) {
119  return false;
120  }
121 
122  if (performAction) {
123  final MapModel<G, A, R> mapModel = mapView.getMapControl().getMapModel();
124  final MapArchObject<A> mapArchObject = mapModel.getMapArchObject();
125  final Point point = new Point();
126  mapGrid.beginTransaction();
127  try {
128  for (final MapSquare<G, A, R> mapSquare : selectedSquares) {
129  for (int dy = -1; dy <= 1; dy++) {
130  for (int dx = -1; dx <= 1; dx++) {
131  mapSquare.getMapLocation(point, dx, dy);
132  if (mapArchObject.isPointValid(point)) {
133  mapGrid.select(point, SelectionMode.ADD);
134  }
135  }
136  }
137  }
138  } finally {
139  mapGrid.endTransaction();
140  }
141  }
142 
143  return true;
144  }
145 
146  @Override
147  public void activeMapViewChanged(@Nullable final MapView<G, A, R> mapView) {
148  if (currentMapView != null) {
150  }
151  currentMapView = mapView;
152  if (currentMapView != null) {
154  }
155  updateAction();
156  }
157 
158  @Override
159  public void mapViewCreated(@NotNull final MapView<G, A, R> mapView) {
160  }
161 
162  @Override
163  public void mapViewClosing(@NotNull final MapView<G, A, R> mapView) {
164  }
165 
166 }
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.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.action.GrowSelectionAction.growSelection
void growSelection()
Grows the current map selection by one map square.
Definition: GrowSelectionAction.java:82
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.model.mapmodel.MapSquare
A single Map Square.
Definition: MapSquare.java:45
net.sf.gridarta.action.GrowSelectionAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: GrowSelectionAction.java:87
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.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.action.GrowSelectionAction.doGrowSelection
boolean doGrowSelection(final boolean performAction)
Grows the current map selection by one map square.
Definition: GrowSelectionAction.java:106
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.GrowSelectionAction.activeMapViewChanged
void activeMapViewChanged(@Nullable final MapView< G, A, R > mapView)
This event handler is called when the current map view has changed.
Definition: GrowSelectionAction.java:147
net.sf.gridarta.action.GrowSelectionAction.mapViewCreated
void mapViewCreated(@NotNull final MapView< G, A, R > mapView)
This event handler is called when a map view was created.
Definition: GrowSelectionAction.java:159
net.sf.gridarta.action.GrowSelectionAction.currentMapView
MapView< G, A, R > currentMapView
The active map view, or.
Definition: GrowSelectionAction.java:51
net.sf.gridarta.action.GrowSelectionAction
An EditorAction that grows the current selection by one map square.
Definition: GrowSelectionAction.java:45
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.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.action.GrowSelectionAction.mapViewClosing
void mapViewClosing(@NotNull final MapView< G, A, R > mapView)
This event handler is called when a map view is to be closed.
Definition: GrowSelectionAction.java:163
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.action.GrowSelectionAction.action
Action action
The action associated with this editor action.
Definition: GrowSelectionAction.java:58
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.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.SelectionMode.ADD
ADD
All squares that are preselected get selected.
Definition: SelectionMode.java:31
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.action.GrowSelectionAction.updateAction
void updateAction()
Updates the action's enabled state.
Definition: GrowSelectionAction.java:95
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.action.GrowSelectionAction.mapGridListener
final MapGridListener mapGridListener
The MapGridListener attached to currentMapView.
Definition: GrowSelectionAction.java:64
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.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20