Implements map models. More...

Inheritance diagram for net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	acquire ()

void	addMapControlListener (@NotNull final MapControlListener< G, A, R > listener)

	DefaultMapControl (@NotNull final MapModel< G, A, R > mapModel, final boolean isPickmap, @NotNull final MapWriter< G, A, R > mapWriter, @NotNull final ProjectSettings projectSettings)
	Creates a new instance. More...

MapModel< G, A, R >	getMapModel ()

int	getUseCounter ()

boolean	isPickmap ()

void	release ()

void	removeMapControlListener (@NotNull final MapControlListener< G, A, R > listener)

void	save () throws IOException

void	saveAs (@NotNull final MapFile mapFile) throws IOException

Public Member Functions inherited from net.sf.gridarta.model.mapcontrol.MapControl< G, A, R >
void	acquire ()
	Increases the use counter. More...

void	addMapControlListener ( @NotNull MapControlListener< G, A, R > listener)
	Registers a MapControlListener. More...

MapModel< G, A, R >	getMapModel ()
	Returns the map model. More...

int	getUseCounter ()
	Returns the use counter. More...

boolean	isPickmap ()
	Return flag that indicates whether this is a pickmap or not. More...

void	release ()
	Decreases the use counter and possibly frees the map control. More...

void	removeMapControlListener ( @NotNull MapControlListener< G, A, R > listener)
	Unregisters a MapControlListener. More...

void	save () throws IOException
	Saves the map to a file. More...

void	saveAs ( @NotNull MapFile mapFile) throws IOException
	Saves the file with the given map file. More...

Private Member Functions
void	encodeMapFile (@NotNull final File file) throws IOException
	Saves the map. More...

void	save (@NotNull final MapFile mapFile) throws IOException
	Updates the maps "Updated:" flag, saves it into the given MapFile, resets its modified and notifies all listeners about the save. More...

Private Attributes
final boolean	isPickmap
	Flag that indicates whether this is a pickmap or not. More...

final EventListenerList2< MapControlListener< G, A, R > >	listenerList = new EventListenerList2<>(MapControlListener.class)
	The registered event listeners. More...

final MapModel< G, A, R >	mapModel
	The MapModel. More...

final MapWriter< G, A, R >	mapWriter
	The MapWriter for saving this map. More...

final ProjectSettings	projectSettings
	The ProjectSettings to use. More...

int	useCounter = 1
	The use counter. More...

Detailed Description

Implements map models.

Author: Andreas Kirschbaum

Definition at line 43 of file DefaultMapControl.java.

Constructor & Destructor Documentation

◆ DefaultMapControl()

net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.DefaultMapControl	(	@NotNull final MapModel< G, A, R >	mapModel,
		final boolean	isPickmap,
		@NotNull final MapWriter< G, A, R >	mapWriter,
		@NotNull final ProjectSettings	projectSettings
	)

Creates a new instance.

Parameters

mapModel	the map model to use
isPickmap	true if this is a pickmap
mapWriter	the map writer for saving map control instances
projectSettings	the project settings to use

Definition at line 87 of file DefaultMapControl.java.

References net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isPickmap(), net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapModel, net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapWriter, and net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.projectSettings.

Here is the call graph for this function:

Member Function Documentation

◆ acquire()

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.acquire ( )

Definition at line 105 of file DefaultMapControl.java.

◆ addMapControlListener()

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addMapControlListener ( @NotNull final MapControlListener< G, A, R > listener )

Definition at line 95 of file DefaultMapControl.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.add().

Here is the call graph for this function:

◆ encodeMapFile()

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.encodeMapFile ( @NotNull final File file ) throws IOException

private

Saves the map.

Parameters

file	the file to save to

Exceptions

IOException if encoding fails

Definition at line 130 of file DefaultMapControl.java.

References net.sf.gridarta.model.io.MapWriter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.encodeMapFile(), and net.sf.gridarta.utils.IOUtils.MAP_ENCODING.

Referenced by net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMapModel()

MapModel<G, A, R> net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapModel ( )

Definition at line 176 of file DefaultMapControl.java.

References net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapModel.

◆ getUseCounter()

int net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getUseCounter ( )

Definition at line 116 of file DefaultMapControl.java.

References net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.useCounter.

◆ isPickmap()

boolean net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isPickmap ( )

Definition at line 121 of file DefaultMapControl.java.

Referenced by net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.DefaultMapControl().

Here is the caller graph for this function:

◆ release()

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.release ( )

Definition at line 110 of file DefaultMapControl.java.

◆ removeMapControlListener()

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeMapControlListener ( @NotNull final MapControlListener< G, A, R > listener )

Definition at line 100 of file DefaultMapControl.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.remove().

Here is the call graph for this function:

◆ save() [1/2]

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save ( ) throws IOException

Definition at line 143 of file DefaultMapControl.java.

References net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapFile().

Referenced by net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.saveAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save() [2/2]

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save ( @NotNull final MapFile mapFile ) throws IOException

private

Updates the maps "Updated:" flag, saves it into the given MapFile, resets its modified and notifies all listeners about the save.

Parameters

mapFile the map file

Exceptions

IOException if an I/O error occurs

Definition at line 163 of file DefaultMapControl.java.

References net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.encodeMapFile(), net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.getListeners(), net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapArchObject(), net.sf.gridarta.model.settings.ProjectSettings.getUserName(), net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isModified(), and net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.resetModified().

Here is the call graph for this function:

◆ saveAs()

void net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.saveAs ( @NotNull final MapFile mapFile ) throws IOException