sim.portrayal.grid
Class HexaObjectGrid2DPortrayal

java.lang.Object
  extended bysim.portrayal.FieldPortrayal
      extended bysim.portrayal.FieldPortrayal2D
          extended bysim.portrayal.grid.ObjectGrid2DPortrayal
              extended bysim.portrayal.grid.HexaObjectGrid2DPortrayal
All Implemented Interfaces:
Portrayal, Portrayal2D, java.io.Serializable

public class HexaObjectGrid2DPortrayal
extends ObjectGrid2DPortrayal

Portrayal for hexagonal grids (each cell has six equally-distanced neighbors) containing objects.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class sim.portrayal.FieldPortrayal
FieldPortrayal.CustomInspector
 
Field Summary
static double HEXAGONAL_RATIO
          The ratio of the width of a hexagon to its height: 1 / Sin(60 degrees), otherwise known as 2 / Sqrt(3)
 
Fields inherited from class sim.portrayal.grid.ObjectGrid2DPortrayal
field
 
Fields inherited from class sim.portrayal.FieldPortrayal
classPortrayals, portrayalForAll, portrayalForNull, portrayalForRemainder, portrayals
 
Constructor Summary
HexaObjectGrid2DPortrayal()
           
 
Method Summary
protected  void hitOrDraw(java.awt.Graphics2D graphics, DrawInfo2D info, Bag putInHere)
          Instead of overriding the draw and hitObjects methods, you can optionally override this method to provide both the draw(...) and hitObjects(...) functionality in a single method, as it's common that these two methods have nearly identical code.
 
Methods inherited from class sim.portrayal.grid.ObjectGrid2DPortrayal
getDefaultPortrayal, getField, getWrapper, setField
 
Methods inherited from class sim.portrayal.FieldPortrayal2D
draw, hitObjects
 
Methods inherited from class sim.portrayal.FieldPortrayal
getDefaultNullPortrayal, getInspector, getName, getPortrayalForAll, getPortrayalForNull, getPortrayalForObject, getPortrayalForRemainder, setPortrayalForAll, setPortrayalForClass, setPortrayalForNull, setPortrayalForObject, setPortrayalForRemainder, setSelected
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface sim.portrayal.Portrayal
getInspector, getName, setSelected
 

Field Detail

HEXAGONAL_RATIO

public static final double HEXAGONAL_RATIO
The ratio of the width of a hexagon to its height: 1 / Sin(60 degrees), otherwise known as 2 / Sqrt(3)

Constructor Detail

HexaObjectGrid2DPortrayal

public HexaObjectGrid2DPortrayal()
Method Detail

hitOrDraw

protected void hitOrDraw(java.awt.Graphics2D graphics,
                         DrawInfo2D info,
                         Bag putInHere)
Description copied from class: FieldPortrayal2D
Instead of overriding the draw and hitObjects methods, you can optionally override this method to provide both the draw(...) and hitObjects(...) functionality in a single method, as it's common that these two methods have nearly identical code. You should test which operation to do based on whether or not graphics is null (if it is, you're hitting, else you're drawing).

Overrides:
hitOrDraw in class ObjectGrid2DPortrayal