Gridarta Editor
EditorFactory.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.maincontrol;
21 
22 import java.awt.Component;
23 import javax.swing.filechooser.FileFilter;
61 import net.sf.japi.swing.prefs.PreferencesGroup;
62 import org.jetbrains.annotations.NotNull;
63 import org.jetbrains.annotations.Nullable;
64 
69 public interface EditorFactory<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends ProjectFactory<G, A, R> {
70 
76  @NotNull
77  ProjectSettings newProjectSettings(@NotNull EditorSettings editorSettings);
78 
84  @NotNull
86 
96  @NotNull
97  ScriptedEventFactory<G, A, R> newScriptedEventFactory(@NotNull ScriptArchUtils scriptArchUtils, @NotNull GameObjectFactory<G, A, R> gameObjectFactory, @NotNull ScriptedEventEditor<G, A, R> scriptedEventEditor, @NotNull ArchetypeSet<G, A, R> archetypeSet);
98 
103  @NotNull
105 
113  @NotNull
114  ScriptArchDataUtils<G, A, R> newScriptArchDataUtils(@NotNull ScriptArchUtils scriptArchUtils, @NotNull ScriptedEventFactory<G, A, R> scriptedEventFactory, @NotNull ScriptedEventEditor<G, A, R> scriptedEventEditor);
115 
128  @NotNull
129  RendererFactory<G, A, R> newRendererFactory(@NotNull MapViewSettings mapViewSettings, @NotNull FilterControl<G, A, R> filterControl, @NotNull GameObjectParser<G, A, R> gameObjectParser, @NotNull FaceObjectProviders faceObjectProviders, @NotNull ResourceIcons resourceIcons, @NotNull SmoothFaces smoothFaces);
130 
138  @NotNull
139  MapViewFactory<G, A, R> newMapViewFactory(@NotNull RendererFactory<G, A, R> rendererFactory, @NotNull PathManager pathManager);
140 
147  @NotNull
149 
159  @NotNull
160  NewMapDialogFactory<G, A, R> newNewMapDialogFactory(@NotNull MapViewsManager<G, A, R> mapViewsManager, @NotNull MapArchObjectFactory<A> mapArchObjectFactory, @NotNull PickmapChooserView<G, A, R> pickmapChooserView, @NotNull Component parent);
161 
172  @NotNull
173  PreferencesGroup createPreferencesGroup(@NotNull ProjectSettings projectSettings, @NotNull EditorSettings editorSettings, @NotNull DelegatingMapValidator<G, A, R> validators, @NotNull AppPreferencesModel appPreferencesModel, @NotNull ExitConnectorModel exitConnectorModel, @NotNull ConfigSourceFactory configSourceFactory);
174 
181  @Nullable
182  EditorAction newServerActions(@NotNull FileControl<G, A, R> fileControl);
183 
188  @NotNull
189  FileFilter getScriptFileFilter();
190 
195  @NotNull
196  String getScriptExtension();
197 
202  @NotNull
203  String getScriptName();
204 
209  boolean isCreateDirectionPane();
210 
216 
221  @NotNull
223 
228  @NotNull
229  Direction @NotNull [] getDirectionMap();
230 
235  boolean isAllowRandomMapParameters();
236 
241  @Nullable
242  String getCompassIconName();
243 
248  @NotNull
249  String getGridartaJarFilename();
250 
255  @NotNull
256  FileFilter getMapFileFilter();
257 
262  int @NotNull [] getLockedItemsTypeNumbers();
263 
268  boolean isAutoValidatorDefault();
269 
270 }
net.sf.gridarta.model.direction.Direction
A direction.
Definition: Direction.java:28
net.sf.gridarta.model.mapmanager
Definition: AbstractMapManager.java:20
net.sf.gridarta.model.archetypetype
Defines types of GameObjects with corresponding attributes.
Definition: AbstractArchetypeAttributeInvSpell.java:20
net.sf.gridarta.maincontrol.EditorFactory.getScriptFileFilter
FileFilter getScriptFileFilter()
Returns the FileFilter for script files.
net.sf.gridarta.gui.panel
net.sf.gridarta.model.scripts.ScriptedEventFactory
Factory for creating ScriptedEvent instances.
Definition: ScriptedEventFactory.java:31
net.sf.gridarta.utils.AppPreferencesModel
Maintains the application preferences state.
Definition: AppPreferencesModel.java:32
net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView
A View for choosing pickmaps.
Definition: PickmapChooserView.java:58
net.sf.gridarta.model.gameobject.GameObjectFactory
Abstract factory for creating GameObject instances.
Definition: GameObjectFactory.java:31
net.sf.gridarta.model.mapmanager.MapManager
A MapManager manages all opened maps.
Definition: MapManager.java:37
net.sf.gridarta.gui.panel.pickmapchooser
Classes implementing the pickmap chooser.
Definition: package-info.java:24
net.sf.gridarta.maincontrol.EditorFactory.newScriptArchUtils
ScriptArchUtils newScriptArchUtils(@NotNull ArchetypeTypeList eventTypes)
Creates a new ScriptArchUtils instance.
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.maincontrol.EditorFactory.isCreateDirectionPane
boolean isCreateDirectionPane()
Returns whether the direction panel should be created.
net.sf.gridarta.maincontrol.EditorFactory.newNewMapDialogFactory
NewMapDialogFactory< G, A, R > newNewMapDialogFactory(@NotNull MapViewsManager< G, A, R > mapViewsManager, @NotNull MapArchObjectFactory< A > mapArchObjectFactory, @NotNull PickmapChooserView< G, A, R > pickmapChooserView, @NotNull Component parent)
Creates a new NewMapDialogFactory instance.
net.sf.gridarta.maincontrol.EditorFactory.newMapViewFactory
MapViewFactory< G, A, R > newMapViewFactory(@NotNull RendererFactory< G, A, R > rendererFactory, @NotNull PathManager pathManager)
Creates a new MapViewFactory instance.
net.sf.gridarta.model.mapviewsettings
Definition: AbstractMapViewSettings.java:20
net.sf.gridarta.maincontrol.EditorFactory.newProjectSettings
ProjectSettings newProjectSettings(@NotNull EditorSettings editorSettings)
Creates a new ProjectSettings instance.
net.sf
net.sf.gridarta.model.mapmanager.FileControl
Definition: FileControl.java:30
net.sf.gridarta.model.io.PathManager
This class contains methods for converting relative map paths to absolute map paths and vice versa.
Definition: PathManager.java:39
net.sf.gridarta.model.scripts
Common types for event archetypes.
Definition: AbstractScriptedEvent.java:20
net.sf.gridarta.model.smoothface
Definition: DuplicateSmoothFaceException.java:20
net.sf.gridarta.maincontrol.EditorFactory.newMapPropertiesDialogFactory
MapPropertiesDialogFactory< G, A, R > newMapPropertiesDialogFactory(@NotNull ProjectSettings projectSettings, @NotNull MapManager< G, A, R > mapManager)
Creates a new MapPropertiesDialogFactory instance.
net.sf.gridarta.gui.map.renderer
Definition: AbstractIsoMapRenderer.java:20
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.face.FaceObjectProviders
Provider for faces of GameObjects and Archetypes.
Definition: FaceObjectProviders.java:46
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.maincontrol.EditorFactory.getMapFileFilter
FileFilter getMapFileFilter()
Returns the file filter for map files.
net.sf.gridarta.model.mapviewsettings.MapViewSettings
Container for settings that affect the rendering of maps.
Definition: MapViewSettings.java:30
net.sf.gridarta.project.ProjectFactory
A factory to create project-dependent objects.
Definition: ProjectFactory.java:56
net.sf.gridarta.maincontrol.EditorFactory.isAutoValidatorDefault
boolean isAutoValidatorDefault()
Returns whether the auto validator is enabled by default.
net.sf.gridarta.model.scripts.ScriptArchUtils
Definition: ScriptArchUtils.java:26
net.sf.gridarta.maincontrol.EditorFactory.getUndefinedSpellIndex
int getUndefinedSpellIndex()
Returns the index for "no spell".
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.filter
Classes for Filters.
Definition: BtnPopup.java:20
net.sf.gridarta.model.archetypetype.ArchetypeTypeList
A list definition.
Definition: ArchetypeTypeList.java:33
net.sf.gridarta.model.settings.EditorSettings
Settings that apply to the editor.
Definition: EditorSettings.java:29
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.gui.scripts.ScriptedEventEditor
Dialog to edit events linked to item scripting.
Definition: ScriptedEventEditor.java:54
net.sf.gridarta.maincontrol.EditorFactory
A factory to create editor-dependent objects.
Definition: EditorFactory.java:69
net.sf.gridarta.maincontrol.EditorFactory.getLockedItemsTypeNumbers
int[] getLockedItemsTypeNumbers()
Returns the type numbers of game objects being locked items.
net.sf.gridarta.maincontrol.EditorFactory.newRendererFactory
RendererFactory< G, A, R > newRendererFactory(@NotNull MapViewSettings mapViewSettings, @NotNull FilterControl< G, A, R > filterControl, @NotNull GameObjectParser< G, A, R > gameObjectParser, @NotNull FaceObjectProviders faceObjectProviders, @NotNull ResourceIcons resourceIcons, @NotNull SmoothFaces smoothFaces)
Creates a new RendererFactory instance.
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.gui.map.mapview
Definition: AbstractMapView.java:20
net.sf.gridarta.gui.dialog.mapproperties
Definition: MapPropertiesDialogFactory.java:20
net.sf.gridarta.gui.dialog.newmap
Definition: AbstractMapsizeNewMapDialog.java:20
net.sf.gridarta.model.configsource
Definition: AbstractConfigSource.java:20
net.sf.gridarta.gui.dialog.newmap.NewMapDialogFactory
Utility class to create NewMapDialog instances.
Definition: NewMapDialogFactory.java:39
net.sf.gridarta.model.archetypeset.ArchetypeSet
Interface that captures similarities between different ArchetypeSet implementations.
Definition: ArchetypeSet.java:37
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.maincontrol.EditorFactory.getScriptExtension
String getScriptExtension()
Returns the extension for script files.
net.sf.gridarta.maincontrol.EditorFactory.createPreferencesGroup
PreferencesGroup createPreferencesGroup(@NotNull ProjectSettings projectSettings, @NotNull EditorSettings editorSettings, @NotNull DelegatingMapValidator< G, A, R > validators, @NotNull AppPreferencesModel appPreferencesModel, @NotNull ExitConnectorModel exitConnectorModel, @NotNull ConfigSourceFactory configSourceFactory)
Creates a new PreferencesGroup instance.
net.sf.gridarta.gui.scripts
Definition: AbstractScriptArchUtils.java:20
net.sf.gridarta.gui.dialog
net.sf.gridarta.model.exitconnector
Definition: AbstractExitConnectorModel.java:20
net.sf.gridarta.model.io
Reading and writing of maps, handling of paths.
Definition: AbstractAnimationObjectsReader.java:20
net.sf.gridarta.model.settings.ProjectSettings
Settings that apply to a project.
Definition: ProjectSettings.java:29
net.sf.gridarta.maincontrol.EditorFactory.newScriptArchDataUtils
ScriptArchDataUtils< G, A, R > newScriptArchDataUtils(@NotNull ScriptArchUtils scriptArchUtils, @NotNull ScriptedEventFactory< G, A, R > scriptedEventFactory, @NotNull ScriptedEventEditor< G, A, R > scriptedEventEditor)
Creates a new ScriptArchDataUtils instance.
net.sf.gridarta.gui.filter.FilterControl
Definition: FilterControl.java:33
net.sf.gridarta.maincontrol.EditorFactory.isAllowRandomMapParameters
boolean isAllowRandomMapParameters()
Returns whether exit paths may point to random map parameters.
net.sf.gridarta.maincontrol.EditorFactory.newServerActions
EditorAction newServerActions(@NotNull FileControl< G, A, R > fileControl)
Creates the "open in client" action.
net.sf.gridarta.maincontrol.EditorFactory.getDirectionMap
Direction[] getDirectionMap()
Returns a map of relative direction to map window direction.
net.sf.gridarta.model.configsource.ConfigSourceFactory
A factory for creating ConfigSources.
Definition: ConfigSourceFactory.java:28
net.sf.gridarta.maincontrol.EditorFactory.getScriptName
String getScriptName()
Returns the display name for script files.
net.sf.gridarta.maincontrol.EditorFactory.newScriptedEventFactory
ScriptedEventFactory< G, A, R > newScriptedEventFactory(@NotNull ScriptArchUtils scriptArchUtils, @NotNull GameObjectFactory< G, A, R > gameObjectFactory, @NotNull ScriptedEventEditor< G, A, R > scriptedEventEditor, @NotNull ArchetypeSet< G, A, R > archetypeSet)
Creates a new ScriptedEventFactory instance.
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.maincontrol.EditorFactory.getCompassIconName
String getCompassIconName()
Returns the icon name to display in the selected square view.
net.sf.gridarta.model.smoothface.SmoothFaces
Collection of all smoothing information.
Definition: SmoothFaces.java:37
net.sf.gridarta.gui.map.renderer.RendererFactory
Factory for creating MapRenderer instances.
Definition: RendererFactory.java:33
net.sf.gridarta.maincontrol.EditorFactory.getGridartaJarFilename
String getGridartaJarFilename()
Returns the filename of the editor's .jar file.
net.sf.gridarta.gui.map
Base classes for rendering maps.
Definition: AbstractPerMapDialogManager.java:20
net.sf.gridarta.gui.map.mapview.MapViewFactory
A factory for creating MapView instances.
Definition: MapViewFactory.java:32
net.sf.gridarta.maincontrol.EditorFactory.newScriptArchData
ScriptArchData< G, A, R > newScriptArchData()
Creates a new ScriptArchData instance.
net.sf.gridarta.model.face
The face is the appearance of an object.
Definition: AbstractFaceObjects.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.utils.ResourceIcons
Creates ImageIcon instances from resources.
Definition: ResourceIcons.java:46
net.sf.gridarta.model.validation.DelegatingMapValidator
A Map Validator that delegates to other MapValidators.
Definition: DelegatingMapValidator.java:36
net.sf.gridarta.model.io.CacheFiles
Creates derived files for caching files.
Definition: CacheFiles.java:30
net.sf.gridarta.maincontrol.EditorFactory.getCacheFiles
CacheFiles getCacheFiles()
Returns the cache files for icon and preview images.
net.sf.gridarta.model.io.GameObjectParser
Interface for classes that read or write GameObject instances.
Definition: GameObjectParser.java:37
net.sf.gridarta.model.exitconnector.ExitConnectorModel
Stores information needed by the exit connector.
Definition: ExitConnectorModel.java:29
net.sf.gridarta.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.project
Definition: ProjectFactory.java:20
net.sf.gridarta.model.archetypeset
Definition: ArchetypeSet.java:20
net.sf.gridarta.gui.map.mapview.MapViewsManager
Stores all existing MapViews.
Definition: MapViewsManager.java:47
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.gui.dialog.mapproperties.MapPropertiesDialogFactory
Factory for creating map property dialog instances.
Definition: MapPropertiesDialogFactory.java:35
net.sf.gridarta.model.direction
Definition: Direction.java:20
net.sf.gridarta.model.settings
Definition: AbstractDefaultProjectSettings.java:20
net.sf.gridarta.gui.scripts.ScriptArchDataUtils
net.sf.gridarta.model.scripts.ScriptArchData related functions.
Definition: ScriptArchDataUtils.java:41
net.sf.gridarta.model.maparchobject.MapArchObjectFactory
Factory for creating MapArchObject instances.
Definition: MapArchObjectFactory.java:28
net.sf.gridarta.model.scripts.ScriptArchData
Stores and manages information about scripted events.
Definition: ScriptArchData.java:35