A MapModel reflects the data of a map. More...

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

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

Public Member Functions
void	addActiveEditType (int editType)
	Add edit type to the bitmask of active types. More...

void	addGameObjectToMap (@NotNull G gameObject, @NotNull Point pos, @NotNull InsertionMode< G, A, R > insertionMode)
	Add a gameObject to the map. More...

void	addMapModelListener (@NotNull MapModelListener< G, A, R > listener)
	Register a map listener. More...

void	addMapTransactionListener (@NotNull MapTransactionListener< G, A, R > listener)
	Registers a map transaction listener. More...

void	addObjectListToMap (@NotNull Iterable< G > objects)
	Adds a list of GameObjects to this map. More...

void	beginGameObjectChange (@NotNull G gameObject)
	Method to notify the model that a game object is about to change. More...

void	beginSquareChange (@NotNull MapSquare< G, A, R > mapSquare)
	Method to notify the model that a map square is about to change. More...

void	beginTransaction (@NotNull String name)
	Starts a new transaction. More...

void	clearMap ()
	Clears this map completely. More...

void	endAllTransactions ()
	Ends all transaction. More...

void	endGameObjectChange (@NotNull G gameObject)
	Method to notify the model that a game object was changed. More...

void	endSquareChange (@NotNull MapSquare< G, A, R > mapSquare)
	Method to notify the model that a map square was changed. More...

void	endTransaction ()
	End a transaction. More...

void	endTransaction (boolean fireEvent)
	End a transaction. More...

void	facesReloaded ()
	Will be called whenever the archetype faces have been reloaded. More...

List< G >	getAllGameObjects ()
	Returns all game objects. More...

ErrorCollector< G, A, R >	getErrors ()
	Gets the errors in this map. More...

A	getMapArchObject ()
	Returns the Map Arch Object with the meta information about the map. More...

MapFile	getMapFile ()
	Returns the map file. More...

MapFile	getMapFile (@NotNull MapPath mapPath) throws SameMapException, UnsavedMapException
	Returns the map file for a map that can be reached by following a MapPath from this map. More...

MapSquare< G, A, R >	getMapSquare (@NotNull Point pos)
	Get the square at a specified location. More...

int	getTransactionDepth ()
	Get the transaction depth, which is the number of beginTransaction(String) invocations without matching endTransaction() invocations. More...

G	insertArchToMap (@NotNull BaseObject< G, A, R, ?> templateBaseObject, @Nullable G nextGameObject, @NotNull Point pos, boolean join)
	Insert a game object to the map at a specified position. More...

G	insertBaseObject (@NotNull BaseObject< G, A, R, ?> baseObject, @NotNull Point pos, boolean allowMany, boolean join, @NotNull InsertionMode< G, A, R > insertionMode)
	Inserts a BaseObject to a map. More...

boolean	isAnyTransactionActive ()
	Returns whether a transaction is currently active. More...

boolean	isAreaEmpty (int left, int top, int width, int height)
	Checks whether an area of a map is completely empty. More...

boolean	isEmpty ()
	Returns whether the map is empty. More...

boolean	isModified ()
	Return whether the map has been modified from the on-disk state. More...

boolean	isMultiArchFittingToMap (@NotNull Archetype< G, A, R > archetype, @NotNull Point pos, boolean allowDouble)
	Checks whether an GameObject (multi-arch) would still fit on this map. More...

void	mapClosed ()
	This function must be called if this instance is freed. More...

void	moveEnv (@NotNull G gameObject, @NotNull Point pos, @NotNull G nextGameObject)
	Moves a GameObject to its environment. More...

void	moveInv (@NotNull G gameObject, @NotNull GameObject< G, A, R > prevGameObject)
	Moves a GameObject to the inventory of another game object. More...

void	nextPoint (Point point, int direction)
	Moves the given point forward or backward one map square. More...

void	removeGameObject (@NotNull G gameObject, boolean join)
	Delete an existing GameObject from the map. More...

void	removeMapModelListener (@NotNull MapModelListener< G, A, R > listener)
	Unregister a map listener. More...

void	removeMapTransactionListener (@NotNull MapTransactionListener< G, A, R > listener)
	Unregisters a map transaction listener. More...

void	resetModified ()
	Resets the modified flag to false. More...

void	setErrors (@NotNull ErrorCollector< G, A, R > errors)
	Sets the errors in this map. More...

void	setMapFile (@Nullable MapFile mapFile)
	Sets the map file. More...

void	transientGameObjectChange (@NotNull G gameObject)
	Method to notify the model that a game object was changed but need not be restored by undo/redo. More...

Detailed Description

A MapModel reflects the data of a map.

This MapModel interface covers the similarities between the current CFEditor and DaiEditor implementations.

Transaction System

The purpose of the transaction system in MapModel is to allow several subsequent changes to the model to be collected as a single big change before the registered listeners (usually the user interface) gets notified. This prevents the user interface from performing hundreds of updates when a single one would be enough. The transaction system will also be used for implementing undo / redo.

Concurrency

It's not purpose of the transaction system to provide concurrent transactions for concurrent threads. A MapModel will protect itself against concurrent modification.

Performance

The transaction system is efficient-safe. The following operations are very cheap:

Beginning a nested transaction
Ending a nested transaction
Ending an outermost transaction without having changed something

Whether beginning the outermost transaction will be a cheap operation is not yet decided.

Transactions are recorded.

It is not (yet?) the purpose of the transaction system to provide real transactions (ACID). Queries to the MapModel during an ongoing transaction will reflect the intermediate state. And there is no rollback yet, but this is planned for future as it's required for undo anyway.

Future

The following features are not yet implemented but planned.

Undo System

The transaction system will serve as a base for an undo / redo system. Beginning the outermost transaction stores a new undo record in the undo buffer. An undo record consists of the transaction's name plus the current map state.

Author: Christian Hujer

Invariant: !isAnyTransactionActive() || getTransactionDepth() > 0

Definition at line 75 of file MapModel.java.

Member Function Documentation

◆ addActiveEditType()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addActiveEditType ( int editType )

Add edit type to the bitmask of active types.

If this is a new type, it gets calculated for every arch on the map. Once it is calculated, we save that state in 'activeEditType' so we don't need to do it again.

Parameters

editType new edit type

Referenced by net.sf.gridarta.model.mapmodel.DefaultMapModelTest.testEditType1().

Here is the caller graph for this function:

◆ addGameObjectToMap()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addGameObjectToMap	(	@NotNull G	gameObject,
		@NotNull Point	pos,
		@NotNull InsertionMode< G, A, R >	insertionMode
	)

Add a gameObject to the map.

Including multi square objects. This function allows to insert any given GameObject. Make sure that the given

gameObject

is a new and unlinked object.

Parameters

gameObject	The new GameObject with set destination coordinates to be linked onto the map.
pos	the insert location
insertionMode	the insertion mode to use

Here is the caller graph for this function:

◆ addMapModelListener()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addMapModelListener ( @NotNull MapModelListener< G, A, R > listener )

Register a map listener.

Parameters

listener the listener to register

Here is the caller graph for this function:

◆ addMapTransactionListener()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addMapTransactionListener ( @NotNull MapTransactionListener< G, A, R > listener )

Registers a map transaction listener.

Parameters

listener the the listener to register

Referenced by net.sf.gridarta.gui.panel.gameobjectattributes.GameObjectAttributesControl< G, A, R >.GameObjectAttributesControl(), net.sf.gridarta.gui.mainwindow.GameObjectTextEditorTab< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.GameObjectTextEditorTab(), and net.sf.gridarta.gui.undo.UndoControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.UndoControl().

Here is the caller graph for this function:

◆ addObjectListToMap()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.addObjectListToMap ( @NotNull Iterable< G > objects )

Adds a list of GameObjects to this map.

Parameters

objects the game objects to add

Referenced by net.sf.gridarta.model.mapcontrol.TestMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), and net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newPickmapControl().

Here is the caller graph for this function:

◆ beginGameObjectChange()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.beginGameObjectChange ( @NotNull G gameObject )

Method to notify the model that a game object is about to change.

Parameters

gameObject the game object that is about to change

Referenced by net.sf.gridarta.model.gameobject.AbstractGameObject< GameObject, MapArchObject, Archetype >.notifyBeginChange().

Here is the caller graph for this function:

◆ beginSquareChange()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.beginSquareChange ( @NotNull MapSquare< G, A, R > mapSquare )

Method to notify the model that a map square is about to change.

Parameters

mapSquare the map square that is about to change

Referenced by net.sf.gridarta.model.mapmodel.MapSquare< G, A, R >.beginSquareChange(), and net.sf.gridarta.model.mapmodel.MapSquare< G, A, R >.notifyBeginChange().

Here is the caller graph for this function:

◆ beginTransaction()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.beginTransaction ( @NotNull String name )

Starts a new transaction.

Transactions may be nested. Transactions serve the purpose of firing events to the views when more changes are known to come before the view is really required to update. Each invocation of this function requires its own invocation of endTransaction().

A transaction has a name. The name of the outermost transaction is used as a String presented to the user for undoing the operation enclosed by that transaction.

Beginning a nested transaction is a cheap operation.

Parameters

name	the name of the transaction

See also: endTransaction(); endTransaction(boolean); endAllTransactions(); getTransactionDepth(); isAnyTransactionActive()

◆ clearMap()

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

Clears this map completely.

After invoking this method, no objects will remain on this map.

◆ endAllTransactions()

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

Ends all transaction.

Invoking this method will reduce set the transaction depth to 0. You shouldn't invoke this method regularly. It is meant as a fallback in high level methods / exception handlers to prevent errors from causing unclosed transactions.

See also: #beginTransaction(String); endTransaction(); endTransaction(boolean); getTransactionDepth(); isAnyTransactionActive()

◆ endGameObjectChange()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.endGameObjectChange ( @NotNull G gameObject )

Method to notify the model that a game object was changed.

A change to a game object is atomic if getTransactionDepth() returns 0, otherwise it is transactional. The model then notifies the registered listeners of the changes.

Parameters

gameObject the game object that has changed

Referenced by net.sf.gridarta.model.gameobject.AbstractGameObject< GameObject, MapArchObject, Archetype >.notifyEndChange().

Here is the caller graph for this function:

◆ endSquareChange()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.endSquareChange ( @NotNull MapSquare< G, A, R > mapSquare )

Method to notify the model that a map square was changed.

A change to a square is atomic if getTransactionDepth() returns 0, otherwise it is transactional. The model then notifies the registered listeners of the changes.

Parameters

mapSquare the map square that has changed

Referenced by net.sf.gridarta.model.mapmodel.MapSquare< G, A, R >.endSquareChange(), and net.sf.gridarta.model.mapmodel.MapSquare< G, A, R >.notifyEndChange().

Here is the caller graph for this function:

◆ endTransaction() [1/2]

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

End a transaction.

Invoking this method will reduce the transaction depth by only 1.

Ending a nested operation is a cheap operation. Ending a transaction without changes also is a cheap operation.

If the last transaction is ended, the changes are committed.

Same as endTransaction(false).

See also: #beginTransaction(String); endTransaction(boolean); endAllTransactions(); getTransactionDepth(); isAnyTransactionActive()

◆ endTransaction() [2/2]

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.endTransaction ( boolean fireEvent )

End a transaction.

Invoking this method will reduce the transaction depth by only 1.

Ending a nested operation is a cheap operation. Ending a transaction without changes also is a cheap operation.

If the last transaction is ended, the changes are committed.

An example where setting

fireEvent

to

true

is useful even though the outermost transaction is not ended is when during painting the UI should be updated though painting is not finished.

Parameters

fireEvent

◆ facesReloaded()

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

Will be called whenever the archetype faces have been reloaded.

◆ getAllGameObjects()

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

Returns all game objects.

Only top-level head parts are returned; tail parts are ignored as are objects in inventories.

Returns: all game objects

Referenced by net.sf.gridarta.gui.copybuffer.CopyBuffer< G, A, R >.getAllGameObjects(), net.sf.gridarta.gui.map.mapview.AbstractMapView< TestGameObject, TestMapArchObject, TestArchetype >.getSelectedGameObjects(), and net.sf.gridarta.model.mapmodel.DefaultMapModelTest.testGetAllGameObjects1().

Here is the caller graph for this function:

◆ getErrors()

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

Gets the errors in this map.

Returns: the errors

Referenced by net.sf.gridarta.gui.panel.gameobjectattributes.ErrorListView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateErrors().

Here is the caller graph for this function:

◆ getMapArchObject()

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

Returns the Map Arch Object with the meta information about the map.

Returns: the map arch object with the meta information about the map

◆ getMapFile() [1/2]

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

Returns the map file.

Returns: the map file or
null
if the map has not yet been saved

Here is the caller graph for this function:

◆ getMapFile() [2/2]

MapFile net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapFile ( @NotNull MapPath mapPath ) throws SameMapException, UnsavedMapException

Returns the map file for a map that can be reached by following a MapPath from this map.

Parameters

mapPath the map path to follow

Returns: the map file

Exceptions

SameMapException	of the destination map file is the same as this map file
UnsavedMapException	if this map is not saved and therefore its map file is unknown

◆ getMapSquare()

MapSquare<G, A, R> net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMapSquare ( @NotNull Point pos )

Get the square at a specified location.

Parameters

pos	location to get square at

Returns: square at
p

Exceptions

IndexOutOfBoundsException in case p specifies a location that's not valid within this map model

◆ getTransactionDepth()

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

Get the transaction depth, which is the number of beginTransaction(String) invocations without matching endTransaction() invocations.

A transaction depth of 0 means there is no ongoing transaction.

Returns: transaction depth

See also: #beginTransaction(String); endTransaction(); endTransaction(boolean); endAllTransactions(); isAnyTransactionActive()

◆ insertArchToMap()

G net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertArchToMap	(	@NotNull BaseObject< G, A, R, ?>	templateBaseObject,
		@Nullable G	nextGameObject,
		@NotNull Point	pos,
		boolean	join
	)

Insert a game object to the map at a specified position.

This function allows either to choose from the archetypes or to insert a copy from an existing game object. It also works for container-inventory.

Parameters

templateBaseObject	a clone copy of this game object gets inserted to the map; it can be an archetype of a game object
nextGameObject	the new game object gets inserted before this; if null , the game object gets inserted at bottom
pos	the map position to insert the new game object
join	if set, auto-joining is supported

Returns: the inserted game object, or
null
if an error occurred

Referenced by net.sf.gridarta.gui.dialog.replace.ReplaceDialog< G, A, R >.doReplace(), net.sf.gridarta.model.mapcursor.MapCursor< G, A, R >.insertGameObject(), net.sf.gridarta.gui.panel.gameobjectattributes.GameObjectAttributesControl< G, A, R >.mapArchAddEnv(), and net.sf.gridarta.model.io.DefaultMapReaderTest.testReorderMultiSquares().

Here is the caller graph for this function:

◆ insertBaseObject()

G net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertBaseObject	(	@NotNull BaseObject< G, A, R, ?>	baseObject,
		@NotNull Point	pos,
		boolean	allowMany,
		boolean	join,
		@NotNull InsertionMode< G, A, R >	insertionMode
	)

Inserts a BaseObject to a map.

Archetypes are instantiated, game objects are cloned. The direction of the inserted game object is set to the direction of the archetype chooser. This function allows multi-square game objects.

Parameters

baseObject	the base object
pos	the insert-location on this map
allowMany	whether duplicates are allowed
join	whether to auto-join the inserted game object
insertionMode	the insertion mode to use

Returns: the inserted game object or
null
if nothing was inserted

Referenced by net.sf.gridarta.gui.panel.tools.InsertionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsert(), net.sf.gridarta.gui.dialog.replace.ReplaceDialog< G, A, R >.doReplace(), net.sf.gridarta.gui.misc.ShiftProcessor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertAllAndClear(), net.sf.gridarta.gui.copybuffer.CopyBuffer< G, A, R >.paste(), net.sf.gridarta.gui.copybuffer.CopyBuffer< G, A, R >.pasteTiled(), net.sf.gridarta.model.mapmodel.DefaultMapModelTest.testEditType1(), net.sf.gridarta.model.mapmodel.DefaultMapModelTest.testGetAllGameObjects1(), and net.sf.gridarta.model.mapmodel.DefaultMapModelTest.testUpdateDirectionOnInsert().

Here is the caller graph for this function:

◆ isAnyTransactionActive()

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

Returns whether a transaction is currently active.

This method will return

true

if and only if getTransactionDepth() returns a value greater than zero.

Returns: true
if there's a transaction going on, otherwise
false
.

See also: #beginTransaction(String); endTransaction(); endTransaction(boolean); endAllTransactions(); getTransactionDepth()

◆ isAreaEmpty()

boolean net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isAreaEmpty	(	int	left,
		int	top,
		int	width,
		int	height
	)

Checks whether an area of a map is completely empty.

Parameters

left	the left border of the area
top	the top border of the area
width	the with of the area
height	the height of the area

Returns: whether the area is completely empty

◆ isEmpty()

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

Returns whether the map is empty.

Returns: true
if the map is empty, or
false
if the map is not empty

Referenced by net.sf.gridarta.gui.copybuffer.CopyBuffer< G, A, R >.isEmpty().

Here is the caller graph for this function:

◆ isModified()

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

Return whether the map has been modified from the on-disk state.

Returns: true
if the map has been modified from the on-disk state

Referenced by net.sf.gridarta.actions.ExitConnectorActions< G, A, R >.doExitConnect(), net.sf.gridarta.actions.AbstractServerActions< GameObject, MapArchObject, Archetype >.doOpenInClient(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.doRevertPickmap(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doSaveMap(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.doSavePickmap(), net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserView< G, A, R >.getTitle(), net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.getUnsavedPickmaps(), net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save(), net.sf.gridarta.gui.mapfiles.PickmapState< G, A, R >.save(), net.sf.gridarta.model.mapcontrol.DefaultMapControlTest.testSaveAs1(), and net.sf.gridarta.model.baseobject.AbstractBaseObjectTest.testSetObjectTextAttributeOrdering().

Here is the caller graph for this function:

◆ isMultiArchFittingToMap()

boolean net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isMultiArchFittingToMap	(	@NotNull Archetype< G, A, R >	archetype,
		@NotNull Point	pos,
		boolean	allowDouble
	)

Checks whether an GameObject (multi-arch) would still fit on this map.

Parameters

archetype	the archetype to check
pos	position of multi-square head
allowDouble	whether overlapping multi-square arches should be allowed (check is done using the archetype name)

Returns: whether the multi-arch would still fit on this map

Return values

Referenced by net.sf.gridarta.action.MoveSquareEnvAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doAction().

Here is the caller graph for this function:

◆ mapClosed()

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

This function must be called if this instance is freed.

◆ moveEnv()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveEnv	(	@NotNull G	gameObject,
		@NotNull Point	pos,
		@NotNull G	nextGameObject
	)

Moves a GameObject to its environment.

Parameters

gameObject	the game object to move
pos	the insertion position
nextGameObject	the next game object

Referenced by net.sf.gridarta.action.MoveSquareEnvAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doAction().

Here is the caller graph for this function:

◆ moveInv()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveInv	(	@NotNull G	gameObject,
		@NotNull GameObject< G, A, R >	prevGameObject
	)

Moves a GameObject to the inventory of another game object.

Parameters

gameObject	the game object to move
prevGameObject	the previous game object

Referenced by net.sf.gridarta.action.MoveSquareInvAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doAction().

Here is the caller graph for this function:

◆ nextPoint()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.nextPoint	(	Point	point,
		int	direction
	)

Moves the given point forward or backward one map square.

Parameters

point	the point to start with and modify
direction	the direction ( -1 or +1 )

Referenced by net.sf.gridarta.gui.map.mapactions.ExitIterator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.findNext().

Here is the caller graph for this function:

◆ removeGameObject()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeGameObject	(	@NotNull G	gameObject,
		boolean	join
	)

Delete an existing GameObject from the map.

Parameters

gameObject	the game object to remove
join	if set, auto-joining is supported

Referenced by net.sf.gridarta.gui.panel.tools.DeletionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deleteArch(), net.sf.gridarta.model.mapcursor.MapCursor< G, A, R >.deleteSelectedGameObject(), net.sf.gridarta.gui.panel.gameobjectattributes.GameObjectAttributesControl< G, A, R >.mapArchAddEnv(), net.sf.gridarta.model.mapmodel.DefaultMapModelTest.testEditType1(), net.sf.gridarta.model.autojoin.AutojoinListsTest.testRemove1(), net.sf.gridarta.model.autojoin.AutojoinListsTest.testRemoveAlt1(), net.sf.gridarta.model.autojoin.AutojoinListsTest.testRemoveAlt2(), and net.sf.gridarta.model.autojoin.AutojoinListsTest.testRemoveAlt3().

Here is the caller graph for this function:

◆ removeMapModelListener()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeMapModelListener ( @NotNull MapModelListener< G, A, R > listener )

Unregister a map listener.

Parameters

listener the listener to unregister

Referenced by net.sf.gridarta.gui.map.mapview.ErroneousMapSquares< G, A, R >.closeNotify(), net.sf.gridarta.gui.map.MapFileActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.closeNotify(), net.sf.gridarta.gui.map.mapview.DefaultMapView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.closeNotify(), net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.closeNotify(), net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.closeNotify(), net.sf.gridarta.gui.copybuffer.CopyBuffer< G, A, R >.removeMapModelListener(), and net.sf.gridarta.gui.panel.pickmapchooser.PickmapChooserControl<?, ?, ?>.setCurrentPickmap().

Here is the caller graph for this function:

◆ removeMapTransactionListener()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.removeMapTransactionListener ( @NotNull MapTransactionListener< G, A, R > listener )

Unregisters a map transaction listener.

Parameters

listener the listener to unregister

◆ resetModified()

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

Resets the modified flag to false.

Referenced by net.sf.gridarta.model.mapcontrol.TestMapControlFactory.newMapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.save(), and net.sf.gridarta.model.baseobject.AbstractBaseObjectTest.testSetObjectTextAttributeOrdering().

Here is the caller graph for this function:

◆ setErrors()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setErrors ( @NotNull ErrorCollector< G, A, R > errors )

Sets the errors in this map.

Parameters

errors the errors

◆ setMapFile()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setMapFile ( @Nullable MapFile mapFile )

Sets the map file.

Parameters

mapFile

the map file or

null

if the map has not yet been saved

Referenced by net.sf.gridarta.model.mapcontrol.TestMapControlFactory.newMapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newMapControl(), net.sf.gridarta.var.crossfire.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.daimonin.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.var.atrinik.model.mapcontrol.DefaultMapControlFactory.newPickmapControl(), net.sf.gridarta.model.mapcontrol.DefaultMapControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.saveAs(), net.sf.gridarta.actions.ExitConnectorActionsTest.testExitCopy1(), and net.sf.gridarta.actions.ExitConnectorActionsTest.testExitPaste2().

Here is the caller graph for this function:

◆ transientGameObjectChange()

void net.sf.gridarta.model.mapmodel.MapModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.transientGameObjectChange ( @NotNull G gameObject )

Method to notify the model that a game object was changed but need not be restored by undo/redo.

A change to a game object is atomic if getTransactionDepth() returns 0, otherwise it is transactional. The model then notifies the registered listeners of the changes.

Parameters

gameObject the game object that has changed

Referenced by net.sf.gridarta.model.gameobject.AbstractGameObject< GameObject, MapArchObject, Archetype >.notifyTransientChange().

Here is the caller graph for this function:

The documentation for this interface was generated from the following file:

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/mapmodel/MapModel.java

Public Member Functions

Detailed Description

Transaction System

Concurrency

Performance

Future

Undo System

Member Function Documentation

◆ addActiveEditType()

◆ addGameObjectToMap()

◆ addMapModelListener()

◆ addMapTransactionListener()

◆ addObjectListToMap()

◆ beginGameObjectChange()

◆ beginSquareChange()

◆ beginTransaction()

◆ clearMap()

◆ endAllTransactions()

◆ endGameObjectChange()

◆ endSquareChange()

◆ endTransaction() [1/2]

◆ endTransaction() [2/2]

◆ facesReloaded()

◆ getAllGameObjects()

◆ getErrors()

◆ getMapArchObject()

◆ getMapFile() [1/2]

◆ getMapFile() [2/2]

◆ getMapSquare()

◆ getTransactionDepth()

◆ insertArchToMap()

◆ insertBaseObject()

◆ isAnyTransactionActive()

◆ isAreaEmpty()

◆ isEmpty()

◆ isModified()

◆ isMultiArchFittingToMap()

◆ mapClosed()

◆ moveEnv()

◆ moveInv()

◆ nextPoint()

◆ removeGameObject()

◆ removeMapModelListener()

◆ removeMapTransactionListener()

◆ resetModified()

◆ setErrors()

◆ setMapFile()

◆ transientGameObjectChange()