Class HexaValueGridPortrayal2D

All Implemented Interfaces:
Portrayal, Portrayal2D
Direct Known Subclasses:
FastHexaValueGridPortrayal2D

public class HexaValueGridPortrayal2D extends ValueGridPortrayal2D
Portrayal for hexagonal grids (each cell has six equally-distanced neighbors) with double-precision real values.
  • Constructor Details

    • HexaValueGridPortrayal2D

      public HexaValueGridPortrayal2D()
    • HexaValueGridPortrayal2D

      public HexaValueGridPortrayal2D(String valueName)
  • Method Details

    • getScale

      public Double2D getScale(DrawInfo2D info)
      Description copied from class: FieldPortrayal2D
      Returns the width and height, in pixels, of 1.0 x 1.0 units in the underlying field. Optionally overridable. The default version thows an error if called.
      Overrides:
      getScale in class ValueGridPortrayal2D
    • getPositionLocation

      public Object getPositionLocation(Point2D.Double position, DrawInfo2D info)
      Description copied from class: FieldPortrayal2D
      Returns the Location, in the parlance of the underlying Field, of the given position. If there is no such Location, then null is returned. Optionally overridable. By default null is returned.
      Overrides:
      getPositionLocation in class ValueGridPortrayal2D
    • getLocationPosition

      public Point2D.Double getLocationPosition(Object location, DrawInfo2D info)
      Description copied from class: FieldPortrayal2D
      Returns the position on-screen of the provided location in the underlying field. Negative positions are acceptable. If null is returned, then the portrayal is unable to perform the requested action on the given location. Optionally overridable. The default implementation returns null.
      Overrides:
      getLocationPosition in class ValueGridPortrayal2D
    • hitOrDraw

      protected void hitOrDraw(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 ValueGridPortrayal2D
    • setBorder

      public void setBorder(boolean on)
      This is not supported by hexagonal portrayals. Throws an exception.
      Overrides:
      setBorder in class ValueGridPortrayal2D
    • setGridLines

      public void setGridLines(boolean on)
      This is not supported by hexagonal portrayals. Throws an exception.
      Overrides:
      setGridLines in class ValueGridPortrayal2D