An EditorAction that inserts a new game object into the current map. More...

Inheritance diagram for net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Collaboration diagram for net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
void	insertArch ()
	Action method for "insert arch". More...

	InsertArchAction (@NotNull final ObjectChooser< G, A, R > objectChooser, @NotNull final MapViewSettings mapViewSettings)
	Creates a new instance. More...

void	setAction (@NotNull final Action action, @NotNull final String name)
	Sets the Action instance for this editor action. More...

Public Member Functions inherited from net.sf.gridarta.action.AbstractMapCursorAction< G, A, R >
void	activeMapViewChanged ( @Nullable final MapView< G, A, R > mapView)
	This event handler is called when the current map view has changed. More...

void	mapCursorChangedGameObject ( @Nullable final MapSquare< G, A, R > mapSquare, @Nullable final G gameObject)
	NoopMethodInAbstractClass More...

void	mapCursorChangedMode ()
	This event handler is called when MapCursor changes mode (drag, select). More...

void	mapCursorChangedPos ( @NotNull final Point location)
	This event handler is called when MapCursor has moved. More...

void	mapCursorChangedSize ()
	NoopMethodInAbstractClass More...

void	mapViewClosing ( @NotNull final MapView< G, A, R > mapView)
	NoopMethodInAbstractClass More...

void	mapViewCreated ( @NotNull final MapView< G, A, R > mapView)
	NoopMethodInAbstractClass More...

Protected Member Functions
void	updateAction ()

Protected Member Functions inherited from net.sf.gridarta.action.AbstractMapCursorAction< G, A, R >
MapCursor< G, A, R >	getActiveMapCursor ()
	Return the map cursor of the current map view if it is active. More...

MapView< G, A, R >	getActiveMapView ()
	Return the current map view. More...

abstract void	updateAction ()
	Called whenever the current map cursor has changed. More...

Private Member Functions
boolean	doInsertArch (final boolean performAction)
	Executes the "insert arch" action. More...

Private Attributes
Action	action
	The Action associated with this editor action. More...

final MapViewSettings	mapViewSettings
	The MapViewSettings instance for looking up options. More...

final ObjectChooser< G, A, R >	objectChooser
	The object chooser. More...

Detailed Description

An EditorAction that inserts a new game object into the current map.

Author: Andreas Kirschbaum

Definition at line 39 of file InsertArchAction.java.

Constructor & Destructor Documentation

◆ InsertArchAction()

net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.InsertArchAction	(	@NotNull final ObjectChooser< G, A, R >	objectChooser,
		@NotNull final MapViewSettings	mapViewSettings
	)

Creates a new instance.

Parameters

objectChooser	the object chooser
mapViewSettings	the map view settings instance for looking up options

Definition at line 66 of file InsertArchAction.java.

References net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettings, and net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.objectChooser.

Member Function Documentation

◆ doInsertArch()

boolean net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsertArch ( final boolean performAction )

private

Executes the "insert arch" action.

Parameters

performAction whether the action should be performed

Returns: whether the action was or can be performed

Definition at line 89 of file InsertArchAction.java.

References net.sf.gridarta.action.AbstractMapCursorAction< G, A, R >.getActiveMapCursor(), net.sf.gridarta.gui.panel.objectchooser.ObjectChooser< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getSelection(), net.sf.gridarta.model.mapcursor.MapCursor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertGameObject(), and net.sf.gridarta.model.mapviewsettings.MapViewSettings.isAutojoin().

Referenced by net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertArch(), and net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertArch()

void net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertArch ( )

Action method for "insert arch".

Definition at line 80 of file InsertArchAction.java.

References net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsertArch().

Here is the call graph for this function:

◆ setAction()

void net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.setAction	(	@NotNull final Action	action,
		@NotNull final String	name
	)

Sets the Action instance for this editor action.

Parameters

action	the action instance
name	the name of the action

Implements net.sf.gridarta.utils.EditorAction.

Definition at line 72 of file InsertArchAction.java.

References net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action.

◆ updateAction()

void net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateAction ( )

protected

Definition at line 96 of file InsertArchAction.java.

References net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsertArch().

Here is the call graph for this function:

Member Data Documentation

◆ action

Action net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.action

private

The Action associated with this editor action.

Set to

null

if no action is associated.

Definition at line 58 of file InsertArchAction.java.

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

◆ mapViewSettings

final MapViewSettings net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.mapViewSettings

private

The MapViewSettings instance for looking up options.

Definition at line 51 of file InsertArchAction.java.

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

◆ objectChooser

final ObjectChooser<G, A, R> net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.objectChooser

private

The object chooser.

Definition at line 45 of file InsertArchAction.java.

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

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

gridarta-gridarta/src/gridarta/src/main/java/net/sf/gridarta/action/InsertArchAction.java

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InsertArchAction()

Member Function Documentation

◆ doInsertArch()

◆ insertArch()

◆ setAction()

◆ updateAction()

Member Data Documentation

◆ action

◆ mapViewSettings

◆ objectChooser