Package sim.portrayal.grid

Class SparseGridPortrayal2D

java.lang.Object
sim.portrayal.FieldPortrayal
sim.portrayal.FieldPortrayal2D
sim.portrayal.grid.SparseGridPortrayal2D
All Implemented Interfaces:
Portrayal, Portrayal2D
Direct Known Subclasses:
HexaSparseGridPortrayal2D, SparseGrid3DPortrayal2D
public class SparseGridPortrayal2D extends FieldPortrayal2D
Can be used to draw both continuous and discrete sparse fields. The 'location' passed into the DrawInfo2D handed to the SimplePortryal2D is an Int2D.

  • Field Details

  • Constructor Details

    • SparseGridPortrayal2D

      public SparseGridPortrayal2D()

    • SparseGridPortrayal2D

      public SparseGridPortrayal2D(DrawPolicy policy)
      Deprecated.
      Use setDrawPolicy.

  • Method Details

    • setDrawPolicy

      public void setDrawPolicy(DrawPolicy policy)

    • getDrawPolicy

      public DrawPolicy getDrawPolicy()

    • getDefaultPortrayal

      public Portrayal getDefaultPortrayal()
      Description copied from class: FieldPortrayal
      Should return a portrayal which can portray any object regardless of whether it's valid or not
      Overrides:
      getDefaultPortrayal in class FieldPortrayal2D

    • setField

      public void setField(Object field)
      Description copied from class: FieldPortrayal
      Sets the field, and sets the dirtyField flag to true. May throw an exception if the field is inappropriate. The default version just sets the field and sets the dirtyField flag.
      Overrides:
      setField in class FieldPortrayal

    • 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 FieldPortrayal2D

    • 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 FieldPortrayal2D

    • setObjectLocation

      public void setObjectLocation(Object object, Object location, GUIState gui)
      Description copied from class: FieldPortrayal
      Sets location in the underlying field of the given object, if such a thing is reasonable. Largely used for setObjectPosition(...), and in the Inspector's LocationWrapper via the Stable classes. Optionally overridable. The default implementation does nothing.
      Overrides:
      setObjectLocation in class FieldPortrayal

    • getObjectLocation

      public Object getObjectLocation(Object object, GUIState gui)
      Description copied from class: FieldPortrayal
      Returns the first location in the underlying field of the given object, if such a thing is reasonable. Largely used for getObjectPosition(...). If null is returned, then the portrayal is unable to determine the position of the field location. Optionally overridable. The default implementation returns null.
      Overrides:
      getObjectLocation in class FieldPortrayal

    • 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 FieldPortrayal2D

    • 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 FieldPortrayal2D

    • getWrapper

      public LocationWrapper getWrapper(Object object, GUIState gui)

    • setSelected

      public boolean setSelected(LocationWrapper wrapper, boolean selected)
      Description copied from class: FieldPortrayal
      Selects or deselects all of the provided objects.
      Specified by:
      setSelected in interface Portrayal
      Overrides:
      setSelected in class FieldPortrayal

    • setGridLines

      public void setGridLines(boolean on)
      Turns grid lines on or off. By default the grid is off.

    • setGridColor

      public void setGridColor(Color val)
      Sets the grid color. By default the grid is blue.

    • setGridModulus

      public void setGridModulus(int val)
      Sets the grid modulus. This is the minimum number of grid cells skipped before another grid line is drawn. By default the modulus is 10.

    • setGridMinSpacing

      public void setGridMinSpacing(double val)
      Sets the grid min spacing. This is the minimum number of pixels skipped before another grid line is drawn. The grid modulus is doubled until the grid spacing equals or exceeds the minimum spacing. By default the min spacing is 2.0.

    • setGridLineFraction

      public void setGridLineFraction(double val)
      Sets the grid line fraction. This is the width of a stroked line as a fraction of the width (or height) of a grid cell. Grid lines are drawn centered on the borders between cells. By default the fraction is 1/8.0.

    • setGridLineMinMaxWidth

      public void setGridLineMinMaxWidth(double min, double max)
      Sets the minimum and maximum width of a grid line in pixels. By default, the minimum is 1.0 and the maximum is positive infinity.

    • setBorder

      public void setBorder(boolean on)
      Turns border lines on or off. By default the border is off.

    • setBorderColor

      public void setBorderColor(Color val)
      Sets the border color. By default the border is red.

    • setBorderLineFraction

      public void setBorderLineFraction(double val)
      Sets the border line fraction. This is the width of a stroked line as a fraction of the width (or height) of a grid cell. Grid lines are drawn centered on the borders around the grid. Note that if the grid is being drawn clipped (see Display2D.setClipping(...)), then only HALF of the width of this line will be visible (the half that lies within the grid region). By default the fraction is 1/8.0..

    • setBorderLineMinMaxWidth

      public void setBorderLineMinMaxWidth(double min, double max)
      Sets the minimum and maximum width of a border line in pixels. By default, the minimum is 1.0 and the maximum is positive infinity.