burlap.behavior.singleagent.auxiliary.valuefunctionvis

Class StateValuePainter

java.lang.Object

burlap.behavior.singleagent.auxiliary.valuefunctionvis.StateValuePainter

Direct Known Subclasses:

StateValuePainter2D

public abstract class StateValuePainter
extends java.lang.Object

An abstract class for defining the interface and common methods to paint the representation of the value function for a specific state onto a 2D graphics context.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	shouldRescaleValues Indicates whether this painter should scale its rendering of values to whatever it is told the minimum and maximum values are.

Constructor Summary

Constructors

Constructor and Description
StateValuePainter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	paintStateValue(java.awt.Graphics2D g2, State s, double value, float cWidth, float cHeight) Paints the representation of a value function for a specific state.
abstract void	rescale(double lowerValue, double upperValue) Used to tell this painter that it should render state values so that the minimum possible value is lowerValue and the maximum is upperValue.
void	useValueRescaling(boolean rescale) Enabling value rescaling allows the painter to adjust to the minimum and maximum values passed to it.

Methods inherited from class java.lang.Object

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

Field Detail

shouldRescaleValues

protected boolean shouldRescaleValues

Indicates whether this painter should scale its rendering of values to whatever it is told the minimum and maximum values are.

Constructor Detail

StateValuePainter

public StateValuePainter()

Method Detail

paintStateValue

public abstract void paintStateValue(java.awt.Graphics2D g2,
                   State s,
                   double value,
                   float cWidth,
                   float cHeight)

Paints the representation of a value function for a specific state.

Parameters:

g2 - graphics context to which the object should be painted

s - the state of the object to be painted

value - the value function evaluation of state s

cWidth - width of the canvas size

cHeight - height of the canvas size

rescale

public abstract void rescale(double lowerValue,
           double upperValue)

Used to tell this painter that it should render state values so that the minimum possible value is lowerValue and the maximum is upperValue.

Parameters:

lowerValue - the minimum value of state values

upperValue - the maximium value of state values

useValueRescaling

public void useValueRescaling(boolean rescale)

Enabling value rescaling allows the painter to adjust to the minimum and maximum values passed to it.

Parameters:

rescale - whether this painter should rescale to the minimum and maximum value of the value function.