StateValuePainter2D

java.lang.Object
- burlap.behavior.singleagent.auxiliary.valuefunctionvis.StateValuePainter
- - burlap.behavior.singleagent.auxiliary.valuefunctionvis.common.StateValuePainter2D

```
public class StateValuePainter2D
extends StateValuePainter
```
A class for rendering the value of states as colored 2D cells on the canvas.

Author:

James MacGlashan

Field Summary

Fields
Modifier and Type	Field and Description
`protected ColorBlend`	`colorBlend` The object to use for returning the color with which to fill the state cell given its value.
`protected int`	`numXCells` Option used for specifying the number of possible states that will be rendered in a row (i.e., across the x-axis).
`protected int`	`numYCells` Option used for specifying the number of possible states that will be rendered in a column (i.e., across the y-axis).
`protected boolean`	`renderValueString` Whether the numeric string for the value of the state should be rendered in its cell or not.
`protected java.awt.Color`	`vsFontColor` The font color of the value strings
`protected int`	`vsFontSize` The font point size of the value string
`protected float`	`vsOffsetFromLeft` A value between 0 and 1 indicating how far from the left of a value cell the value string should start being rendered.
`protected float`	`vsOffsetFromTop` A value between 0 and 1 indicating how from from the top of a value cell the value string should start be rendered.
`protected int`	`vsPrecision` The precision (number of decimals) shown in the value string.
`protected java.lang.Object`	`xKey` variable key for the x variable
`protected VariableDomain`	`xRange` Range of the x key
`protected double`	`xWidth` Width of x cells
`protected java.lang.Object`	`yKey` variable key for the y variable
`protected VariableDomain`	`yRange` Range of the y key
`protected double`	`yWidth` width of y cells

Fields inherited from class burlap.behavior.singleagent.auxiliary.valuefunctionvis.StateValuePainter
shouldRescaleValues

Constructor Summary

Constructors
Constructor and Description
`StateValuePainter2D()` Initializes using a `LandmarkColorBlendInterpolation` object that mixes from red (lowest value) to blue (highest value).
`StateValuePainter2D(ColorBlend colorBlend)` Initializes the value painter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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`	`setColorBlend(ColorBlend colorBlend)` Sets the color blending used for the value function.
`void`	`setNumXCells(int numXCells)` Sets the number of states that will be rendered along a row
`void`	`setNumYCells(int numYCells)` Sets the number of states that will be rendered along a row
`void`	`setValueStringRenderingFormat(int fontSize, java.awt.Color fontColor, int precision, float offsetFromLeft, float offsetFromTop)` Sets the rendering format of the string displaying the value of each state.
`void`	`setXYKeys(java.lang.Object xKey, java.lang.Object yKey, VariableDomain xRange, VariableDomain yRange, double xWidth, double yWidth)` Sets the variable keys for the x and y variables in the state and the width of cells along those domains.
`void`	`toggleValueStringRendering(boolean renderValueString)` Enables or disables the rendering the text specifying the value of a state in its cell.

Methods inherited from class burlap.behavior.singleagent.auxiliary.valuefunctionvis.StateValuePainter
useValueRescaling

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - xKey
```
protected java.lang.Object xKey
```
    variable key for the x variable
  - yKey
```
protected java.lang.Object yKey
```
    variable key for the y variable
  - xRange
```
protected VariableDomain xRange
```
    Range of the x key
  - yRange
```
protected VariableDomain yRange
```
    Range of the y key
  - xWidth
```
protected double xWidth
```
    Width of x cells
  - yWidth
```
protected double yWidth
```
    width of y cells
  - colorBlend
```
protected ColorBlend colorBlend
```
    The object to use for returning the color with which to fill the state cell given its value.
  - numXCells
```
protected int numXCells
```
    Option used for specifying the number of possible states that will be rendered in a row (i.e., across the x-axis). -1 causes the attribute categorical size to be used instead.
  - numYCells
```
protected int numYCells
```
    Option used for specifying the number of possible states that will be rendered in a column (i.e., across the y-axis). -1 causes the attribute categorical size to be used instead.
  - renderValueString
```
protected boolean renderValueString
```
    Whether the numeric string for the value of the state should be rendered in its cell or not.
  - vsFontSize
```
protected int vsFontSize
```
    The font point size of the value string
  - vsFontColor
```
protected java.awt.Color vsFontColor
```
    The font color of the value strings
  - vsOffsetFromLeft
```
protected float vsOffsetFromLeft
```
    A value between 0 and 1 indicating how far from the left of a value cell the value string should start being rendered. 0 indicates stating at the left of the cell; 1 the right;
  - vsOffsetFromTop
```
protected float vsOffsetFromTop
```
    A value between 0 and 1 indicating how from from the top of a value cell the value string should start be rendered. 0 indicates stating at the top of the cell; 1 the bottom;
  - vsPrecision
```
protected int vsPrecision
```
    The precision (number of decimals) shown in the value string.
- Constructor Detail
  - StateValuePainter2D
```
public StateValuePainter2D()
```
    Initializes using a LandmarkColorBlendInterpolation object that mixes from red (lowest value) to blue (highest value).
  - StateValuePainter2D
```
public StateValuePainter2D(ColorBlend colorBlend)
```
    Initializes the value painter.
    
    Parameters:
    
    colorBlend - the object to use for returning the color with which to fill the state cell given its value.
- Method Detail
  - setColorBlend
```
public void setColorBlend(ColorBlend colorBlend)
```
    Sets the color blending used for the value function.
    
    Parameters:
    
    colorBlend - the color blending used for the value function.
  - setXYKeys
```
public void setXYKeys(java.lang.Object xKey,
                      java.lang.Object yKey,
                      VariableDomain xRange,
                      VariableDomain yRange,
                      double xWidth,
                      double yWidth)
```
    Sets the variable keys for the x and y variables in the state and the width of cells along those domains. The widths along the x dimension are how much of the variable space each rendered state will take.
    
    Parameters:
    
    xKey - the x variable key
    
    yKey - the y variable key
    
    xRange - the range of the x values
    
    yRange - the range of the y values
    
    xWidth - the width of a state along the x domain
    
    yWidth - the width of a state alone the y domain
  - toggleValueStringRendering
```
public void toggleValueStringRendering(boolean renderValueString)
```
    Enables or disables the rendering the text specifying the value of a state in its cell.
    
    Parameters:
    
    renderValueString - if true, then text specifying the value of the state will be rendered; if false then it will not be rendered.
  - setValueStringRenderingFormat
```
public void setValueStringRenderingFormat(int fontSize,
                                          java.awt.Color fontColor,
                                          int precision,
                                          float offsetFromLeft,
                                          float offsetFromTop)
```
    Sets the rendering format of the string displaying the value of each state.
    
    Parameters:
    
    fontSize - the font size of the string
    
    fontColor - the color of the font
    
    precision - the precision of the value text printed (e.g., 2 means displaying 2 decimal places)
    
    offsetFromLeft - the offset from the left side of a state's cell that the text will begin being rendered. 0 means starting on the left boundary, 1 on the right boundary.
    
    offsetFromTop - the offset from the top side of a state's cell that the text will begin being rendered. 0 means starting on the top boundary, 1 on the bottom boundary.
  - setNumXCells
```
public void setNumXCells(int numXCells)
```
    Sets the number of states that will be rendered along a row
    
    Parameters:
    
    numXCells - the number of states that will be rendered along a row
  - setNumYCells
```
public void setNumYCells(int numYCells)
```
    Sets the number of states that will be rendered along a row
    
    Parameters:
    
    numYCells - the number of states that will be rendered along a column
  - rescale
```
public void rescale(double lowerValue,
                    double upperValue)
```
    Description copied from class: StateValuePainter
    
    Used to tell this painter that it should render state values so that the minimum possible value is lowerValue and the maximum is upperValue.
    
    Specified by:
    
    rescale in class StateValuePainter
    
    Parameters:
    
    lowerValue - the minimum value of state values
    
    upperValue - the maximium value of state values
  - paintStateValue
```
public void paintStateValue(java.awt.Graphics2D g2,
                            State s,
                            double value,
                            float cWidth,
                            float cHeight)
```
    Description copied from class: StateValuePainter
    
    Paints the representation of a value function for a specific state.
    
    Specified by:
    
    paintStateValue in class StateValuePainter
    
    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

Class StateValuePainter2D

Field Summary

Fields inherited from class burlap.behavior.singleagent.auxiliary.valuefunctionvis.StateValuePainter

Constructor Summary

Method Summary

Methods inherited from class burlap.behavior.singleagent.auxiliary.valuefunctionvis.StateValuePainter

Methods inherited from class java.lang.Object

Field Detail

xKey

yKey

xRange

yRange

xWidth

yWidth

colorBlend

numXCells

numYCells

renderValueString

vsFontSize

vsFontColor

vsOffsetFromLeft

vsOffsetFromTop

vsPrecision

Constructor Detail

StateValuePainter2D

StateValuePainter2D

Method Detail

setColorBlend

setXYKeys

toggleValueStringRendering

setValueStringRenderingFormat

setNumXCells

setNumYCells

rescale

paintStateValue