burlap.oomdp.singleagent.common

Class VisualActionObserver

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

burlap.oomdp.singleagent.common.VisualActionObserver

All Implemented Interfaces:

ActionObserver, EnvironmentObserver, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class VisualActionObserver
extends javax.swing.JFrame
implements ActionObserver, EnvironmentObserver

This class enables the live rendering of action calls or environment interactions, by implementing the ActionObserver and EnvironmentObserver interfaces. It updates the visualizer to show the resulting state of an action call. After rendering, the client thread is blocked for a specified interval of time to allow the state to be observed (by default the value is set to 17ms, which is about 60FPS). This class will also render the new state of an Environment after a Environment.resetEnvironment() message is observed and block for the same interval of time. This class is especially useful for watching learning algorithms or Monte Carlo-like planning algorithms in action.

Optionally, this class may also render state-action events in an Environment (so that the action is also rendered) so long as the input Visualizer has a set StateActionRenderLayer. To enable this support, pass the setRepaintOnActionInitiation(boolean) true. If you would then like to disable rendering the post-state from the observeEnvironmentInteraction(burlap.oomdp.singleagent.environment.EnvironmentOutcome) method, pass the setRepaintStateOnEnvironmentInteraction(boolean) false.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected long	actionRenderDelay How long to wait in ms for a state to be rendered before returning control to the agent.
protected int	cHeight The height of the painter
protected int	cWidth The width of the painter
protected Domain	domain The domain this visualizer is rendering
protected Visualizer	painter The visualizer that will render states
protected boolean	repaintOnActionInitiation If true, then a a state-action pair is rendered on calls to observeEnvironmentActionInitiation(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) so long as the input Visualizer has a set StateActionRenderLayer.
protected boolean	repaintStateOnEnvironmentInteraction If true (which is default), then the post-state in an observeEnvironmentInteraction(burlap.oomdp.singleagent.environment.EnvironmentOutcome) is rendered.

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
VisualActionObserver(Domain domain, Visualizer painter) Initializes with a visualizer size of 800x800
VisualActionObserver(Domain domain, Visualizer painter, int cWidth, int cHeight) Initializes with a visualizer

Method Summary

Methods

Modifier and Type	Method and Description
void	actionEvent(State s, GroundedAction ga, State sp)
Visualizer	getPainter()
void	initGUI() Initializes the visual explorer GUI and presents it to the user.
void	observeEnvironmentActionInitiation(State o, GroundedAction action) This method is called when an Environment receives an action to execute, but before the Environment has completed execution.
void	observeEnvironmentInteraction(EnvironmentOutcome eo) This method is called every time an Environment is interacted with.
void	observeEnvironmentReset(Environment resetEnvironment) This method is called every time an Environment is reset (has the Environment.resetEnvironment() method called).
void	replayEpisode(EpisodeAnalysis ea) Causes the visualizer to replay through the provided EpisodeAnalysis object.
void	setFrameDelay(long delay) Sets how long to wait in ms for a state to be rendered before returning control the agent.
void	setPainter(Visualizer painter)
void	setRepaintOnActionInitiation(boolean repaintOnActionInitiation) Sets whether the state-action should be updated when an action is initiated in an Environment via the observeEnvironmentActionInitiation(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method.
void	setRepaintStateOnEnvironmentInteraction(boolean repaintStateOnEnvironmentInteraction) Sets whether the state should be updated on environment interactions events (the observeEnvironmentInteraction(burlap.oomdp.singleagent.environment.EnvironmentOutcome) or only with state-actions in the observeEnvironmentActionInitiation(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction).

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 Domain domain

The domain this visualizer is rendering

painter

protected Visualizer painter

The visualizer that will render states

cWidth

protected int cWidth

The width of the painter

cHeight

protected int cHeight

The height of the painter

actionRenderDelay

protected long actionRenderDelay

How long to wait in ms for a state to be rendered before returning control to the agent. Default is 17ms (about 60fps)

repaintStateOnEnvironmentInteraction

protected boolean repaintStateOnEnvironmentInteraction

If true (which is default), then the post-state in an observeEnvironmentInteraction(burlap.oomdp.singleagent.environment.EnvironmentOutcome) is rendered.

repaintOnActionInitiation

protected boolean repaintOnActionInitiation

If true, then a a state-action pair is rendered on calls to observeEnvironmentActionInitiation(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) so long as the input Visualizer has a set StateActionRenderLayer. Default value is false.

Constructor Detail

VisualActionObserver

public VisualActionObserver(Domain domain,
                    Visualizer painter)

Initializes with a visualizer size of 800x800

Parameters:

domain - the domain that is being visualized

painter - the painter for rendering states

VisualActionObserver

public VisualActionObserver(Domain domain,
                    Visualizer painter,
                    int cWidth,
                    int cHeight)

Initializes with a visualizer

Parameters:

domain - the domain that is being visualized

painter - the painter for rendering states

cWidth - the width of the state visualization area

cHeight - the height of the state visualization area

Method Detail

setFrameDelay

public void setFrameDelay(long delay)

Sets how long to wait in ms for a state to be rendered before returning control the agent. The default value is 17, which is about 60FPS.

Parameters:

delay - how long to wait in ms for a state to be rendered before returning control the agent.

getPainter

public Visualizer getPainter()

setPainter

public void setPainter(Visualizer painter)

setRepaintStateOnEnvironmentInteraction

public void setRepaintStateOnEnvironmentInteraction(boolean repaintStateOnEnvironmentInteraction)

Sets whether the state should be updated on environment interactions events (the observeEnvironmentInteraction(burlap.oomdp.singleagent.environment.EnvironmentOutcome) or only with state-actions in the observeEnvironmentActionInitiation(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction).

Parameters:

repaintStateOnEnvironmentInteraction - if true, then update states with environment interactions; if false then only with environment action initiation.

setRepaintOnActionInitiation

public void setRepaintOnActionInitiation(boolean repaintOnActionInitiation)

Sets whether the state-action should be updated when an action is initiated in an Environment via the observeEnvironmentActionInitiation(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method.

Parameters:

repaintOnActionInitiation - if true, then state-action's are painted on action initiation; if false, they are not.

initGUI

public void initGUI()

Initializes the visual explorer GUI and presents it to the user.

actionEvent

public void actionEvent(State s,
               GroundedAction ga,
               State sp)

Specified by:

actionEvent in interface ActionObserver

observeEnvironmentActionInitiation

public void observeEnvironmentActionInitiation(State o,
                                      GroundedAction action)

Description copied from interface: EnvironmentObserver

This method is called when an Environment receives an action to execute, but before the Environment has completed execution.

Specified by:

observeEnvironmentActionInitiation in interface EnvironmentObserver

Parameters:

o - the current Environment observation in which the the action begins execution.

action - the GroundedAction which will be executed in the Environment.

observeEnvironmentInteraction

public void observeEnvironmentInteraction(EnvironmentOutcome eo)

Description copied from interface: EnvironmentObserver

This method is called every time an Environment is interacted with.

Specified by:

observeEnvironmentInteraction in interface EnvironmentObserver

Parameters:

eo - the resulting EnvironmentOutcome

observeEnvironmentReset

public void observeEnvironmentReset(Environment resetEnvironment)

Description copied from interface: EnvironmentObserver

This method is called every time an Environment is reset (has the Environment.resetEnvironment() method called).

Specified by:

observeEnvironmentReset in interface EnvironmentObserver

Parameters:

resetEnvironment - the Environment that was reset.

replayEpisode

public void replayEpisode(EpisodeAnalysis ea)

Causes the visualizer to replay through the provided EpisodeAnalysis object. The initial state of the provided episode is first rendered for the given refresh delay of this object, and then each action and resulting state in the episode is feed through the actionEvent(State, GroundedAction, State) method of this object.

Parameters:

ea - the episode to be replayed.