A direction. More...

Collaboration diagram for net.sf.gridarta.model.direction.Direction:

Public Member Functions
	Direction (final int dx, final int dy, final int dz, @NotNull final String id)
	Creates a new instance. More...

int	getDx ()
	Returns the relative x direction. More...

int	getDy ()
	Returns the relative y direction. More...

int	getDz ()
	Returns the relative z direction. More...

String	getId ()
	Returns the identification string. More...

Public Attributes
	DOWN =(0, 0, -1, "Down")
	Down. More...

	EAST =(1, 0, 0, "East")
	East. More...

	NORTH =(0, -1, 0, "North")
	North. More...

	NORTH_EAST =(1, -1, 0, "NorthEast")
	North east. More...

	NORTH_WEST =(-1, -1, 0, "NorthWest")
	North west. More...

	SOUTH =(0, 1, 0, "South")
	South. More...

	SOUTH_EAST =(1, 1, 0, "SouthEast")
	South east. More...

	SOUTH_WEST =(-1, 1, 0, "SouthWest")
	South west. More...

	UP =(0, 0, 1, "Up")
	Up. More...

	WEST =(-1, 0, 0, "West")
	West. More...

Private Attributes
final int	dx
	The relative x direction. More...

final int	dy
	The relative y direction. More...

final int	dz
	The relative z direction. More...

final String	id
	The identification string. More...

Detailed Description

A direction.

Author: Andreas Kirschbaum

Definition at line 28 of file Direction.java.

Constructor & Destructor Documentation

◆ Direction()

net.sf.gridarta.model.direction.Direction.Direction	(	final int	dx,
		final int	dy,
		final int	dz,
		@NotNull final String	id
	)

Creates a new instance.

Parameters

dx	the relative x direction
dy	the relative y direction
dz	the relative z direction
id	the identification string

Definition at line 108 of file Direction.java.

Member Function Documentation

◆ getDx()

int net.sf.gridarta.model.direction.Direction.getDx ( )

Returns the relative x direction.

Returns: the relative x direction

Definition at line 119 of file Direction.java.

◆ getDy()

int net.sf.gridarta.model.direction.Direction.getDy ( )

Returns the relative y direction.

Returns: the relative y direction

Definition at line 127 of file Direction.java.

◆ getDz()

int net.sf.gridarta.model.direction.Direction.getDz ( )

Returns the relative z direction.

Returns: the relative z direction

Definition at line 135 of file Direction.java.

◆ getId()

String net.sf.gridarta.model.direction.Direction.getId ( )

Returns the identification string.

Returns: the identification string

Definition at line 144 of file Direction.java.

Member Data Documentation

◆ DOWN

net.sf.gridarta.model.direction.Direction.DOWN =(0, 0, -1, "Down")

Down.

Definition at line 78 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileDown(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterDownMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), and net.sf.gridarta.model.mapcursor.MapCursorTest.testGoTo().

◆ dx

final int net.sf.gridarta.model.direction.Direction.dx

private

The relative x direction.

Definition at line 83 of file Direction.java.

◆ dy

final int net.sf.gridarta.model.direction.Direction.dy

private

The relative y direction.

Definition at line 88 of file Direction.java.

◆ dz

final int net.sf.gridarta.model.direction.Direction.dz

private

The relative z direction.

Definition at line 93 of file Direction.java.

◆ EAST

net.sf.gridarta.model.direction.Direction.EAST =(1, 0, 0, "East")

East.

Definition at line 38 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.model.maparchobject.AbstractMapArchObjectTest.calculateTilePath_noCoordinates1_returnsEmptyPath(), net.sf.gridarta.model.maparchobject.AbstractMapArchObjectTest.calculateTilePath_noCoordinates2_returnsEmptyPath(), net.sf.gridarta.model.maparchobject.AbstractMapArchObjectTest.calculateTilePath_noCurrentPath_returnsEmptyPath(), net.sf.gridarta.model.maparchobject.AbstractMapArchObjectTest.calculateTilePath_withCoordinates_returnsPath(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileEast(), net.sf.gridarta.model.mapcursor.MapCursorTest.dragging(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterEastMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorEast(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftEast(), and net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateWarnings().

◆ id

final String net.sf.gridarta.model.direction.Direction.id

private

The identification string.

Definition at line 99 of file Direction.java.

◆ NORTH

net.sf.gridarta.model.direction.Direction.NORTH =(0, -1, 0, "North")

North.

Definition at line 33 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileNorth(), net.sf.gridarta.gui.map.mapactions.EnterMap< G, A, R >.enterExit(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterMap(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterNorthMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorNorth(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftNorth(), and net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateWarnings().

◆ NORTH_EAST

net.sf.gridarta.model.direction.Direction.NORTH_EAST =(1, -1, 0, "NorthEast")

North east.

Definition at line 53 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileNorthEast(), net.sf.gridarta.model.mapcursor.MapCursorTest.dragging(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterNorthEastMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorNorthEast(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), and net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftNorthEast().

◆ NORTH_WEST

net.sf.gridarta.model.direction.Direction.NORTH_WEST =(-1, -1, 0, "NorthWest")

North west.

Definition at line 68 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileNorthWest(), net.sf.gridarta.model.mapcursor.MapCursorTest.dragging(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterNorthWestMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorNorthWest(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), and net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftNorthWest().

◆ SOUTH

net.sf.gridarta.model.direction.Direction.SOUTH =(0, 1, 0, "South")

South.

Definition at line 43 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileSouth(), net.sf.gridarta.model.mapcursor.MapCursorTest.dragging(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterSouthMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorSouth(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftSouth(), and net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateWarnings().

◆ SOUTH_EAST

net.sf.gridarta.model.direction.Direction.SOUTH_EAST =(1, 1, 0, "SouthEast")

South east.

Definition at line 58 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileSouthEast(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterSouthEastMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorSouthEast(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), and net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftSouthEast().

◆ SOUTH_WEST

net.sf.gridarta.model.direction.Direction.SOUTH_WEST =(-1, 1, 0, "SouthWest")

South west.

Definition at line 63 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileSouthWest(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterSouthWestMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorSouthWest(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), and net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftSouthWest().

◆ UP

net.sf.gridarta.model.direction.Direction.UP =(0, 0, 1, "Up")

Up.

Definition at line 73 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.action.exportmap.MapImageCreator< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createImage(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileUp(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterUpMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), and net.sf.gridarta.model.mapcursor.MapCursorTest.testGoTo().

◆ WEST

net.sf.gridarta.model.direction.Direction.WEST =(-1, 0, 0, "West")

West.

Definition at line 48 of file Direction.java.

Referenced by net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.AbstractMapTilePane(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_inCorner_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.EnterMapTest.calculateNewCursorLocation_onSide_returnsNewCoordinate(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.createTileWest(), net.sf.gridarta.model.mapcursor.MapCursorTest.dragging(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.enterWestMap(), net.sf.gridarta.var.crossfire.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.daimonin.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.var.atrinik.maincontrol.DefaultEditorFactory.getDirectionMap(), net.sf.gridarta.gui.mapcursor.MapCursorActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.moveCursorWest(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refreshMenus(), net.sf.gridarta.mainactions.MainActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shiftWest(), and net.sf.gridarta.gui.dialog.shrinkmapsize.ShrinkMapSizeDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.updateWarnings().

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

src/model/src/main/java/net/sf/gridarta/model/direction/Direction.java

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Direction()

Member Function Documentation

◆ getDx()

◆ getDy()

◆ getDz()

◆ getId()

Member Data Documentation

◆ DOWN

◆ dx

◆ dy

◆ dz

◆ EAST

◆ id

◆ NORTH

◆ NORTH_EAST

◆ NORTH_WEST

◆ SOUTH

◆ SOUTH_EAST

◆ SOUTH_WEST

◆ UP

◆ WEST