de.lathanda.eos.robot.World Klassenreferenz

Klassendiagramm für de.lathanda.eos.robot.World:

Klassen
class	IntRange

Öffentliche Methoden
	World ()
	World (JFrame wf)
void	load (String filename) throws WorldLoadFailedException, WorldNotFoundException, UnknownWorldVersionException
void	load (InputStream worldStream) throws WorldLoadFailedException
void	save (OutputStream targetStream) throws ParserConfigurationException, TransformerException, RobotException
Camera	getCamera ()
void	fillRandom (int left, int top, int right, int bottom, double density) throws RobotException
void	enter (Robot r) throws RobotException
void	toggleEntrance (int x, int y, int z, Direction d)
void	setEntranceCursor ()
void	setStone (int x, int y, int z) throws RobotException
void	setStone (int x, int y, int z, MutableColor c) throws RobotException
void	setStoneCursor () throws RobotException
void	setRock (int x, int y, int z) throws RobotException
void	setRockCursor () throws RobotException
void	toggleMarkCursor () throws RobotException
void	setMark (int x, int y, MutableColor c) throws RobotException
void	setStoneColor (MutableColor c)
MutableColor	getStoneColor ()
void	setMarkColor (MutableColor c)
MutableColor	getMarkColor ()
void	dropStone (int x, int y) throws RobotException
void	dropStone (int x, int y, MutableColor c) throws RobotException
void	removeStone (int x, int y, int z) throws RobotException
void	remove (int x, int y, int z) throws RobotException
void	removeCursor () throws RobotException
void	pickupStone (int x, int y) throws RobotException
TreeMap< Coordinate, Column >	getColumns ()
LinkedList< Entrance >	getEntrances ()
LinkedList< Robot >	getRobots ()
IntRange	getxRange ()
IntRange	getyRange ()
void	setShowCursor (boolean showCursor)
int	getCursorX ()
int	getCursorY ()
int	getCursorZ ()
void	setCursor (int x, int y, int z)
boolean	isShowCursor ()
void	moveCursorNorth ()
void	moveCursorSouth ()
void	moveCursorWest ()
void	moveCursorEast ()
void	moveCursorUp ()
void	moveCursorDown ()
void	terminate ()
int	getRobotCount ()
int	getEntranceCount ()
void	setRange (Integer minX, Integer maxX, Integer minY, Integer maxY)

Geschützte Methoden
Column	getColumn (int x, int y)
Column	getColumn (Coordinate co)

Ausführliche Beschreibung

Eine Welt (World) ist die Grundlage, um mit einem Roboter (Robot) zu arbeiten. Sie erzeugt das 3D Fenster und verwaltet alle Inhalte der Welt.

Autor

Peter (Lathanda) Schneider

Definiert in Zeile 51 der Datei World.java.

Beschreibung der Konstruktoren und Destruktoren

World() [1/2]

de.lathanda.eos.robot.World.World

(

)

Erzeugt eine neue Welt inklusive eines Fensters.

Definiert in Zeile 99 der Datei World.java.

World() [2/2]

de.lathanda.eos.robot.World.World

(

JFrame

wf

)

Erzeugt eine neue Welt ohne eigenes Fenster.

Definiert in Zeile 108 der Datei World.java.

Dokumentation der Elementfunktionen

dropStone() [1/2]

void de.lathanda.eos.robot.World.dropStone	(	int	x,
		int	y
	)		throws RobotException

Lässt einen Stein von ganz oben Fallen.

Parameter

x
y

Definiert in Zeile 636 der Datei World.java.

dropStone() [2/2]

void de.lathanda.eos.robot.World.dropStone	(	int	x,
		int	y,
		MutableColor	c
	)		throws RobotException

Lässt einen farbigen Stein von ganz oben Fallen.

Parameter

x
y
c	Farbe des Steins

Definiert in Zeile 645 der Datei World.java.

enter()

void de.lathanda.eos.robot.World.enter

(

Robot

r

)

throws RobotException

Roboter betritt die Welt beim ersten freien Eingang.

Parameter

r

Ausnahmebehandlung

RobotException

Definiert in Zeile 502 der Datei World.java.

fillRandom()

void de.lathanda.eos.robot.World.fillRandom	(	int	left,
		int	top,
		int	right,
		int	bottom,
		double	density
	)		throws RobotException

Füllt den Bereich der Welt zufällig mit Steinen.

Parameter

left	Linke Grenze
top	Obere Grenze
right	Rechte Grenze
bottom	Untere Grenze
density	Wahrscheinlichkeit einen Stein zu setzen. 0 Nie 1 Immer

Ausnahmebehandlung

RobotException

Definiert in Zeile 437 der Datei World.java.

getCamera()

Camera de.lathanda.eos.robot.World.getCamera

(

)

Liefert ein geteiltes Cameraobjekt

Rückgabe

Definiert in Zeile 425 der Datei World.java.

getColumn() [1/2]

Column de.lathanda.eos.robot.World.getColumn ( Coordinate  co )

protected

Liefert die Säule

Parameter

co

Rückgabe

Definiert in Zeile 471 der Datei World.java.

getColumn() [2/2]

Column de.lathanda.eos.robot.World.getColumn ( int  x, int  y  )

protected

Liefert die Säule.

Parameter

x
y

Rückgabe

Definiert in Zeile 462 der Datei World.java.

getColumns()

TreeMap<Coordinate, Column> de.lathanda.eos.robot.World.getColumns

(

)

Definiert in Zeile 693 der Datei World.java.

getCursorX()

int de.lathanda.eos.robot.World.getCursorX

(

)

Definiert in Zeile 831 der Datei World.java.

getCursorY()

int de.lathanda.eos.robot.World.getCursorY

(

)

Definiert in Zeile 835 der Datei World.java.

getCursorZ()

int de.lathanda.eos.robot.World.getCursorZ

(

)

Definiert in Zeile 839 der Datei World.java.

getEntranceCount()

int de.lathanda.eos.robot.World.getEntranceCount

(

)

Definiert in Zeile 890 der Datei World.java.

getEntrances()

LinkedList<Entrance> de.lathanda.eos.robot.World.getEntrances

(

)

Definiert in Zeile 697 der Datei World.java.

getMarkColor()

MutableColor de.lathanda.eos.robot.World.getMarkColor

(

)

Liefert die Farbe für neue Markierungen.

Rückgabe

Definiert in Zeile 628 der Datei World.java.

getRobotCount()

int de.lathanda.eos.robot.World.getRobotCount

(

)

Definiert in Zeile 887 der Datei World.java.

getRobots()

LinkedList<Robot> de.lathanda.eos.robot.World.getRobots

(

)

Definiert in Zeile 701 der Datei World.java.

getStoneColor()

MutableColor de.lathanda.eos.robot.World.getStoneColor

(

)

Liefert die Farbe für neue Steine.

Rückgabe

Definiert in Zeile 614 der Datei World.java.

getxRange()

IntRange de.lathanda.eos.robot.World.getxRange

(

)

Definiert in Zeile 705 der Datei World.java.

getyRange()

IntRange de.lathanda.eos.robot.World.getyRange

(

)

Definiert in Zeile 720 der Datei World.java.

isShowCursor()

boolean de.lathanda.eos.robot.World.isShowCursor

(

)

Definiert in Zeile 847 der Datei World.java.

load() [1/2]

void de.lathanda.eos.robot.World.load

(

InputStream

worldStream

)

throws WorldLoadFailedException

Lädt eine Welt aus einem Datenstrom.

Parameter

worldStream

Ausnahmebehandlung

WorldLoadFailedException
RobotException
ParserConfigurationException
SAXException
IOException

Definiert in Zeile 137 der Datei World.java.

load() [2/2]

void de.lathanda.eos.robot.World.load

(

String

filename

)

throws WorldLoadFailedException, WorldNotFoundException, UnknownWorldVersionException

Lädt eine Welt aus einer Datei

Parameter

filename

Ausnahmebehandlung

WorldLoadFailedException
WorldNotFoundException

Definiert in Zeile 119 der Datei World.java.

moveCursorDown()

void de.lathanda.eos.robot.World.moveCursorDown

(

)

Definiert in Zeile 866 der Datei World.java.

moveCursorEast()

void de.lathanda.eos.robot.World.moveCursorEast

(

)

Definiert in Zeile 860 der Datei World.java.

moveCursorNorth()

void de.lathanda.eos.robot.World.moveCursorNorth

(

)

Definiert in Zeile 851 der Datei World.java.

moveCursorSouth()

void de.lathanda.eos.robot.World.moveCursorSouth

(

)

Definiert in Zeile 854 der Datei World.java.

moveCursorUp()

void de.lathanda.eos.robot.World.moveCursorUp

(

)

Definiert in Zeile 863 der Datei World.java.

moveCursorWest()

void de.lathanda.eos.robot.World.moveCursorWest

(

)

Definiert in Zeile 857 der Datei World.java.

pickupStone()

void de.lathanda.eos.robot.World.pickupStone	(	int	x,
		int	y
	)		throws RobotException

Hebt den obersten Stein auf.

Parameter

x
y

Ausnahmebehandlung

RobotException

Definiert in Zeile 689 der Datei World.java.

remove()

void de.lathanda.eos.robot.World.remove	(	int	x,
		int	y,
		int	z
	)		throws RobotException

Entfernt alles von dieser Position.

Parameter

x
y
z

Ausnahmebehandlung

RobotException

Definiert in Zeile 666 der Datei World.java.

removeCursor()

void de.lathanda.eos.robot.World.removeCursor

(

)

throws RobotException

Definiert in Zeile 669 der Datei World.java.

removeStone()

void de.lathanda.eos.robot.World.removeStone	(	int	x,
		int	y,
		int	z
	)		throws RobotException

Entfernt den Stein von dieser Position.

Parameter

x
y
z

Ausnahmebehandlung

CubeImmutableException

Definiert in Zeile 655 der Datei World.java.

save()

void de.lathanda.eos.robot.World.save

(

OutputStream

targetStream

)

throws ParserConfigurationException, TransformerException, RobotException

Speichert eine Welt als XML Strom

Parameter

targetStream

Ausnahmebehandlung

ParserConfigurationException
TransformerException
RobotException
DOMException

Definiert in Zeile 335 der Datei World.java.

setCursor()

void de.lathanda.eos.robot.World.setCursor	(	int	x,
		int	y,
		int	z
	)

Definiert in Zeile 842 der Datei World.java.

setEntranceCursor()

void de.lathanda.eos.robot.World.setEntranceCursor

(

)

Erschafft einen neuen Eingang an der Cursorposition

Definiert in Zeile 543 der Datei World.java.

setMark()

void de.lathanda.eos.robot.World.setMark	(	int	x,
		int	y,
		MutableColor	c
	)		throws RobotException

Definiert in Zeile 599 der Datei World.java.

setMarkColor()

void de.lathanda.eos.robot.World.setMarkColor

(

MutableColor

c

)

Setzt die Farbe für neue Markierungen

Parameter

c

Definiert in Zeile 621 der Datei World.java.

setRange()

void de.lathanda.eos.robot.World.setRange	(	Integer	minX,
		Integer	maxX,
		Integer	minY,
		Integer	maxY
	)

Definiert in Zeile 894 der Datei World.java.

setRock()

void de.lathanda.eos.robot.World.setRock	(	int	x,
		int	y,
		int	z
	)		throws RobotException

Setzt einen unveränderlichen Stein bei diesen Koordinaten ohne Rücksicht darauf was sich in diesem Feld befindet.

Parameter

x
y
z

Ausnahmebehandlung

RobotException

Definiert in Zeile 588 der Datei World.java.

setRockCursor()

void de.lathanda.eos.robot.World.setRockCursor

(

)

throws RobotException

Definiert in Zeile 592 der Datei World.java.

setShowCursor()

void de.lathanda.eos.robot.World.setShowCursor

(

boolean

showCursor

)

Definiert in Zeile 826 der Datei World.java.

setStone() [1/2]

void de.lathanda.eos.robot.World.setStone	(	int	x,
		int	y,
		int	z
	)		throws RobotException

Setzt einen Stein bei diesen Koordinaten ohne Rücksicht darauf was sich in diesem Feld befindet.

Parameter

x
y
z

Ausnahmebehandlung

RobotException

Definiert in Zeile 564 der Datei World.java.

setStone() [2/2]

void de.lathanda.eos.robot.World.setStone	(	int	x,
		int	y,
		int	z,
		MutableColor	c
	)		throws RobotException

Setzt einen farbigen Stein bei diesen Koordinaten ohne Rücksicht darauf was sich in diesem Feld befindet.

Parameter

x
y
z
c	Farbe des Steins

Ausnahmebehandlung

RobotException

Definiert in Zeile 575 der Datei World.java.

setStoneColor()

void de.lathanda.eos.robot.World.setStoneColor

(

MutableColor

c

)

Setzt die Farbe für neue Steine

Parameter

c

Definiert in Zeile 606 der Datei World.java.

setStoneCursor()

void de.lathanda.eos.robot.World.setStoneCursor

(

)

throws RobotException

Definiert in Zeile 578 der Datei World.java.

terminate()

void de.lathanda.eos.robot.World.terminate

(

)

Aufräumarbeiten am Ende der Ausführung.

Implementiert de.lathanda.eos.base.event.CleanupListener.

Definiert in Zeile 872 der Datei World.java.

toggleEntrance()

void de.lathanda.eos.robot.World.toggleEntrance	(	int	x,
		int	y,
		int	z,
		Direction	d
	)

Erschafft einen neuen Eingang

Parameter

x
y
z
d

Definiert in Zeile 526 der Datei World.java.

toggleMarkCursor()

void de.lathanda.eos.robot.World.toggleMarkCursor

(

)

throws RobotException

Definiert in Zeile 596 der Datei World.java.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• C:/Users/schneidp/iCloudDrive/Eos2_1.1.x/EosRobotLib/src/de/lathanda/eos/robot/World.java