burlap.shell.visual

Class SGVisualExplorer

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

burlap.shell.visual.SGVisualExplorer

All Implemented Interfaces:

WorldObserver, ShellObserver, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class SGVisualExplorer
extends javax.swing.JFrame
implements ShellObserver, WorldObserver

This class allows you act as all of the agents in a stochastic game (controlled by a World object) by choosing actions for each of them to take in specific states. A game with registered agents in the world can also be played out (with some or all of the agents being manually controlled). States are conveyed to the user through a 2D visualization and the user specifies actions for each agent by pressing keys that are mapped to actions or by typing the actions into the action command field. After each action is specified, the corresponding joint action is taken by pressing a special finalizing key that by default is set to "c". The ` key causes the state to reset to the initial state provided to the explorer or the World's StateGenerator. This explorer also associates itself with a SGWorldShell so that additional commands can be given. Keys can also be mapped to execute specific shell commands. You can access the shell with the

Author:

James MacGlashan

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface burlap.shell.ShellObserver

ShellObserver.ShellCommandEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cHeight
protected javax.swing.JFrame	consoleFrame
protected int	cWidth
protected SGDomain	domain
protected java.util.Map<java.lang.String,Action>	keyActionMap
protected java.util.Map<java.lang.String,java.lang.Integer>	keyAgentMap
protected java.util.Map<java.lang.String,java.lang.String>	keyShellMap
protected Visualizer	painter
protected java.awt.TextArea	propViewer
protected SGWorldShell	shell
protected javax.swing.JTextArea	stateConsole
protected TextAreaStreams	tstreams
protected World	w

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
SGVisualExplorer(SGDomain domain, Visualizer painter, State baseState) Initializes the data members for the visual explorer.
SGVisualExplorer(SGDomain domain, Visualizer painter, State baseState, int w, int h) Initializes the data members for the visual explorer.
SGVisualExplorer(SGDomain domain, World world, Visualizer painter, int w, int h) Initializes the data members for the visual explorer.

Method Summary

Modifier and Type	Method and Description
void	addKeyAction(java.lang.String key, int actingAgent, Action action) Specifies the action to set for a given key press.
void	addKeyAction(java.lang.String key, int actingAgent, java.lang.String actionTypeName, java.lang.String paramStringRep) Adds a key action mapping.
void	addKeyShellCommand(java.lang.String key, java.lang.String shellCommand) Causes a shell command to be executed when a key is pressed with the visualizer in focus.
void	gameEnding(State s) This method is called whenever a game in a world ends.
void	gameStarting(State s) This method is called whenever a new game in a world is starting.
SGWorldShell	getShell() Returns the SGWorldShell associated with this visual explorer.
World	getW() Returns the World associated with this explorer.
protected void	init(SGDomain domain, World world, Visualizer painter, int w, int h) Initializes.
void	initGUI() Initializes the GUI and presents it to the user.
void	observe(State s, JointAction ja, double[] reward, State sp) This method is called whenever an interaction in the world occurs.
void	observeCommand(BurlapShell shell, ShellObserver.ShellCommandEvent event) Received whenever a ShellCommand completes execution.
void	setW(World w) Sets the World associated with this visual explorer and shell.
protected void	updatePropTextArea(State s)
void	updateState(State s) Updates the currently visualized state to the input state.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

domain

protected SGDomain domain

w

protected World w

keyActionMap

protected java.util.Map<java.lang.String,Action> keyActionMap

keyAgentMap

protected java.util.Map<java.lang.String,java.lang.Integer> keyAgentMap

keyShellMap

protected java.util.Map<java.lang.String,java.lang.String> keyShellMap

painter

protected Visualizer painter

propViewer

protected java.awt.TextArea propViewer

cWidth

protected int cWidth

cHeight

protected int cHeight

consoleFrame

protected javax.swing.JFrame consoleFrame

stateConsole

protected javax.swing.JTextArea stateConsole

shell

protected SGWorldShell shell

tstreams

protected TextAreaStreams tstreams

Constructor Detail

SGVisualExplorer

public SGVisualExplorer(SGDomain domain,
                        Visualizer painter,
                        State baseState)

Initializes the data members for the visual explorer.

Parameters:

domain - the stochastic game domain to be explored

painter - the 2D visualizer for states

baseState - the initial state from which to explore

SGVisualExplorer

public SGVisualExplorer(SGDomain domain,
                        Visualizer painter,
                        State baseState,
                        int w,
                        int h)

Initializes the data members for the visual explorer.

Parameters:

domain - the stochastic game domain to be explored

painter - the 2D visualizer for states

baseState - the initial state from which to explore

w - the width of the state visualizer

h - the height of the state visualizer

SGVisualExplorer

public SGVisualExplorer(SGDomain domain,
                        World world,
                        Visualizer painter,
                        int w,
                        int h)

Initializes the data members for the visual explorer.

Parameters:

domain - the stochastic game domain to be explored

world - the world with which to interact

painter - the 2D visualizer for states

w - the width of the state visualizer

h - the height of the state visualizer

Method Detail

init

protected void init(SGDomain domain,
                    World world,
                    Visualizer painter,
                    int w,
                    int h)

Initializes.

Parameters:

domain - the stochastic game domain

world - the World with which to interact

painter - the state Visualizer

w - the width of the state visualizer

h - the height of the state visualizer

addKeyAction

public void addKeyAction(java.lang.String key,
                         int actingAgent,
                         Action action)

Specifies the action to set for a given key press. Actions should be formatted to include the agent name as follows: "agentName::actionName" This means that different key presses will have to specified for different agents.

Parameters:

key - the key that will cause the action to be set

actingAgent - the id of the acting agent

action - the action to set when the specified key is pressed.

addKeyAction

public void addKeyAction(java.lang.String key,
                         int actingAgent,
                         java.lang.String actionTypeName,
                         java.lang.String paramStringRep)

Adds a key action mapping.

Parameters:

key - the key that is pressed by the user

actingAgent - the acting agent for this command

actionTypeName - the name of the ActionType

paramStringRep - the string representation of the action parameters

getShell

public SGWorldShell getShell()

Returns the SGWorldShell associated with this visual explorer.

Returns:

the SGWorldShell associated with this visual explorer.

getW

public World getW()

Returns the World associated with this explorer.

Returns:

the World associated with this explorer.

setW

public void setW(World w)

Sets the World associated with this visual explorer and shell.

Parameters:

w - the World associated with this visual explorer and shell.

addKeyShellCommand

public void addKeyShellCommand(java.lang.String key,
                               java.lang.String shellCommand)

Causes a shell command to be executed when a key is pressed with the visualizer in focus.

Parameters:

key - the key

shellCommand - the shell command to execute.

initGUI

public void initGUI()

Initializes the GUI and presents it to the user.

observeCommand

public void observeCommand(BurlapShell shell,
                           ShellObserver.ShellCommandEvent event)

Description copied from interface: ShellObserver

Received whenever a ShellCommand completes execution.

Specified by:

observeCommand in interface ShellObserver

Parameters:

shell - the calling BurlapShell

event - the command event, stored as a ShellObserver.ShellCommandEvent

gameStarting

public void gameStarting(State s)

Description copied from interface: WorldObserver

This method is called whenever a new game in a world is starting.

Specified by:

gameStarting in interface WorldObserver

Parameters:

s - the state in which the world is starting.

observe

public void observe(State s,
                    JointAction ja,
                    double[] reward,
                    State sp)

Description copied from interface: WorldObserver

This method is called whenever an interaction in the world occurs.

Specified by:

observe in interface WorldObserver

Parameters:

s - the previous state of the world

ja - the joint action taken in the world

reward - the joint reward received by the agents

sp - the next state of the world

gameEnding

public void gameEnding(State s)

Description copied from interface: WorldObserver

This method is called whenever a game in a world ends.

Specified by:

gameEnding in interface WorldObserver

Parameters:

s - the final state of the world when it ends.

updateState

public void updateState(State s)

Updates the currently visualized state to the input state.

Parameters:

s - the state to visualize.

updatePropTextArea

protected void updatePropTextArea(State s)