burlap.oomdp.visualizer

Class StateRenderLayer

java.lang.Object

burlap.oomdp.visualizer.StateRenderLayer

All Implemented Interfaces:

RenderLayer

public class StateRenderLayer
extends java.lang.Object
implements RenderLayer

This class provides 2D visualization of states by being provided a set of classes that can paint ObjectInstnaces to the canvas as well as classes that can paint general domain information. Painters for object classes as well as specific object instances can be provided. If there is a painter for an object class and a painter for a specific object instance of that same class, then the specific object instance painter will be used to pain that object instead of the painter for that instnace's OO-MDP class.

The order of painting is first the static painters, in the order they were added; then the object class painters in the order they were painted (except for objects that have specific object painter); finally, the object instances that have specific painter associated with them, in the order that they appear in the state object list.

Author:

James MacGlashan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateRenderLayer.ObjectPainterAndClassNamePair A pair of the name of an object class to paint, and the ObjectPainter to use to paint it.

Field Summary

Fields

Modifier and Type	Field and Description
protected State	curState the current state to be painted next
protected java.util.List<StateRenderLayer.ObjectPainterAndClassNamePair>	objectClassPainterList Ordered list of painters for each object class
protected java.util.Map<java.lang.String,ObjectPainter>	specificObjectPainters Map of painters that define how to paint specific objects; if an object it appears in both specific and general lists, the specific painter is used
protected java.util.List<StaticPainter>	staticPainters list of static painters that pain static non-object defined properties of the domain

Constructor Summary

Constructors

Constructor and Description
StateRenderLayer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectClassPainter(java.lang.String className, ObjectPainter op) Adds a class that will paint objects that belong to a given OO-MDPclass.
void	addSpecificObjectPainter(java.lang.String objectName, ObjectPainter op) Adds a painter that will be used to paint a specific object in states
void	addStaticPainter(StaticPainter sp) Adds a static painter for the domain.
State	getCurState()
java.util.List<StateRenderLayer.ObjectPainterAndClassNamePair>	getObjectClassPainterList()
java.util.Map<java.lang.String,ObjectPainter>	getSpecificObjectPainters()
java.util.List<StaticPainter>	getStaticPainters()
void	render(java.awt.Graphics2D g2, float width, float height)
void	updateState(State s) Updates the state that needs to be painted

Methods inherited from class java.lang.Object

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

Field Detail

curState

protected State curState

the current state to be painted next

staticPainters

protected java.util.List<StaticPainter> staticPainters

list of static painters that pain static non-object defined properties of the domain

objectClassPainterList

protected java.util.List<StateRenderLayer.ObjectPainterAndClassNamePair> objectClassPainterList

Ordered list of painters for each object class

specificObjectPainters

protected java.util.Map<java.lang.String,ObjectPainter> specificObjectPainters

Map of painters that define how to paint specific objects; if an object it appears in both specific and general lists, the specific painter is used

Constructor Detail

StateRenderLayer

public StateRenderLayer()

Method Detail

addStaticPainter

public void addStaticPainter(StaticPainter sp)

Adds a static painter for the domain.

Parameters:

sp - the static painter to add.

addObjectClassPainter

public void addObjectClassPainter(java.lang.String className,
                         ObjectPainter op)

Adds a class that will paint objects that belong to a given OO-MDPclass.

Parameters:

className - the name of the class that the provided painter can paint

op - the painter

addSpecificObjectPainter

public void addSpecificObjectPainter(java.lang.String objectName,
                            ObjectPainter op)

Adds a painter that will be used to paint a specific object in states

Parameters:

objectName - the name of the object this painter is used to paint

op - the painter

updateState

public void updateState(State s)

Updates the state that needs to be painted

Parameters:

s - the state to paint

getCurState

public State getCurState()

getStaticPainters

public java.util.List<StaticPainter> getStaticPainters()

getObjectClassPainterList

public java.util.List<StateRenderLayer.ObjectPainterAndClassNamePair> getObjectClassPainterList()

getSpecificObjectPainters

public java.util.Map<java.lang.String,ObjectPainter> getSpecificObjectPainters()

render

public void render(java.awt.Graphics2D g2,
          float width,
          float height)

Specified by:

render in interface RenderLayer