Gridarta Editor
SelectedSquareModel.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.panel.selectedsquare;
21 
22 import java.util.Collection;
23 import java.util.concurrent.CopyOnWriteArrayList;
28 import org.jetbrains.annotations.NotNull;
29 import org.jetbrains.annotations.Nullable;
30 
35 public class SelectedSquareModel<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
36 
40  @NotNull
41  private final Collection<SelectedSquareModelListener<G, A, R>> listenerList = new CopyOnWriteArrayList<>();
42 
46  @Nullable
48 
52  @Nullable
53  private G selectedGameObject;
54 
60  @Nullable
62  return selectedMapSquare;
63  }
64 
70  @Nullable
71  public G getSelectedGameObject() {
72  return selectedGameObject;
73  }
74 
79  public void addSelectedSquareListener(@NotNull final SelectedSquareModelListener<G, A, R> listener) {
80  listenerList.add(listener);
81  }
82 
88  listenerList.remove(listener);
89  }
90 
94  private void fireSelectionChangedEvent() {
95  final G gameObject = selectedGameObject;
96  final G head = gameObject == null ? null : gameObject.getHead();
97  for (final SelectedSquareModelListener<G, A, R> listener : listenerList) {
98  listener.selectionChanged(selectedMapSquare, head);
99  }
100  }
101 
102  public boolean isSelectedMapSquares(@NotNull final Iterable<MapSquare<G, A, R>> mapSquares) {
104  if (selectedMapSquare == null) {
105  return false;
106  }
107 
108  for (final MapSquare<G, A, R> mapSquare : mapSquares) {
109  if (selectedMapSquare == mapSquare) {
110  return true;
111  }
112  }
113 
114  return false;
115  }
116 
117  public boolean isSelectedGameObjects(@NotNull final Iterable<G> gameObjects) {
119  if (selectedMapSquare == null) {
120  return false;
121  }
122 
123  for (final GameObject<G, A, R> gameObject : gameObjects) {
124  for (GameObject<G, A, R> gameObjectPart = gameObject; gameObjectPart != null; gameObjectPart = gameObjectPart.getMultiNext()) {
125  if (selectedMapSquare == gameObjectPart.getMapSquareOptional()) {
126  return true;
127  }
128  }
129  }
130 
131  return false;
132  }
133 
141  public boolean setSelectedMapSquare(@Nullable final MapSquare<G, A, R> mapSquare, @Nullable final G gameObject) {
142  if (selectedMapSquare == mapSquare && selectedGameObject == gameObject) {
143  return false;
144  }
145 
146  selectedMapSquare = mapSquare;
147  selectedGameObject = gameObject;
149  return true;
150  }
151 
156  public void setSelectedGameObject(@Nullable final G gameObject) {
157  if (selectedMapSquare != null && selectedGameObject != gameObject) {
158  selectedGameObject = gameObject;
160  }
161  }
162 
163 }
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.listenerList
final Collection< SelectedSquareModelListener< G, A, R > > listenerList
The listeners to inform of changes.
Definition: SelectedSquareModel.java:41
net.sf.gridarta.model.mapmodel.MapSquare.getMapSquareOptional
MapSquare< G, A, R > getMapSquareOptional()
Returns the MapSquare this game object is part of.
Definition: MapSquare.java:156
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.fireSelectionChangedEvent
void fireSelectionChangedEvent()
Notifies all listeners that the selected map square has changed.
Definition: SelectedSquareModel.java:94
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.gui.panel.selectedsquare.SelectedSquareModel.selectedGameObject
G selectedGameObject
The currently selected GameObject.
Definition: SelectedSquareModel.java:53
net.sf
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.panel.selectedsquare.SelectedSquareModel.removeSelectedSquareListener
void removeSelectedSquareListener(@NotNull final SelectedSquareModelListener< G, A, R > listener)
Removes a SelectedSquareModelListener to be notified.
Definition: SelectedSquareModel.java:87
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.isSelectedGameObjects
boolean isSelectedGameObjects(@NotNull final Iterable< G > gameObjects)
Definition: SelectedSquareModel.java:117
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.setSelectedMapSquare
boolean setSelectedMapSquare(@Nullable final MapSquare< G, A, R > mapSquare, @Nullable final G gameObject)
Sets the currently selected map square.
Definition: SelectedSquareModel.java:141
net
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.selectedMapSquare
MapSquare< G, A, R > selectedMapSquare
The currently selected MapSquare.
Definition: SelectedSquareModel.java:47
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModelListener< G, A, R >
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel
The model component of the selected square control.
Definition: SelectedSquareModel.java:35
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.setSelectedGameObject
void setSelectedGameObject(@Nullable final G gameObject)
Sets the currently selected GameObject.
Definition: SelectedSquareModel.java:156
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.addSelectedSquareListener
void addSelectedSquareListener(@NotNull final SelectedSquareModelListener< G, A, R > listener)
Adds a SelectedSquareModelListener to be notified.
Definition: SelectedSquareModel.java:79
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.isSelectedMapSquares
boolean isSelectedMapSquares(@NotNull final Iterable< MapSquare< G, A, R >> mapSquares)
Definition: SelectedSquareModel.java:102
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.getSelectedGameObject
G getSelectedGameObject()
Returns the currently selected GameObject within this list (currently selected MapSquare).
Definition: SelectedSquareModel.java:71
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.baseobject.BaseObject.getMultiNext
T getMultiNext()
Returns the next of this multi-part object.
net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareModel.getSelectedMapSquare
MapSquare< G, A, R > getSelectedMapSquare()
Returns the currently selected map square.
Definition: SelectedSquareModel.java:61