Package sim.portrayal.grid
Class HexaValueGridPortrayal2D
java.lang.Object
sim.portrayal.FieldPortrayal
sim.portrayal.FieldPortrayal2D
sim.portrayal.grid.ValueGridPortrayal2D
sim.portrayal.grid.HexaValueGridPortrayal2D
- All Implemented Interfaces:
Portrayal
,Portrayal2D
- Direct Known Subclasses:
FastHexaValueGridPortrayal2D
Portrayal for hexagonal grids (each cell has six equally-distanced neighbors) with double-precision real values.
-
Field Summary
Fields inherited from class sim.portrayal.grid.ValueGridPortrayal2D
locationToPass, valueToPass
Fields inherited from class sim.portrayal.FieldPortrayal2D
DEFAULT, DONT_USE_BUFFER, USE_BUFFER
Fields inherited from class sim.portrayal.FieldPortrayal
classPortrayals, field, immutableField, portrayalForAll, portrayalForNonNull, portrayalForNull, portrayalForRemainder, portrayals
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetLocationPosition
(Object location, DrawInfo2D info) Returns the position on-screen of the provided location in the underlying field.getPositionLocation
(Point2D.Double position, DrawInfo2D info) Returns the Location, in the parlance of the underlying Field, of the given position.getScale
(DrawInfo2D info) Returns the width and height, in pixels, of 1.0 x 1.0 units in the underlying field.protected void
hitOrDraw
(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.void
setBorder
(boolean on) This is not supported by hexagonal portrayals.void
setGridLines
(boolean on) This is not supported by hexagonal portrayals.Methods inherited from class sim.portrayal.grid.ValueGridPortrayal2D
getDefaultPortrayal, getMap, getValueName, getWrapper, newValue, setBorderColor, setBorderLineFraction, setBorderLineMinMaxWidth, setField, setGridColor, setGridLineFraction, setGridLineMinMaxWidth, setGridMinSpacing, setGridModulus, setMap, setValueName
Methods inherited from class sim.portrayal.FieldPortrayal2D
draw, getBuffering, getClipLocation, getObjectPosition, getRelativeObjectPosition, hitObjects, setBuffering, setObjectPosition
Methods inherited from class sim.portrayal.FieldPortrayal
getAlternatePortrayalOrdering, getDefaultNullPortrayal, getField, getInspector, getName, getObjectLocation, getPortrayalForAll, getPortrayalForNonNull, getPortrayalForNull, getPortrayalForObject, getPortrayalForRemainder, getStatus, isDirtyField, isImmutableField, reset, setAlternatePortrayalOrdering, setDirtyField, setImmutableField, setObjectLocation, setPortrayalForAll, setPortrayalForClass, setPortrayalForNonNull, setPortrayalForNull, setPortrayalForObject, setPortrayalForRemainder, setSelected, 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, getStatus, setSelected
-
Constructor Details
-
HexaValueGridPortrayal2D
public HexaValueGridPortrayal2D() -
HexaValueGridPortrayal2D
-
-
Method Details
-
getScale
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 classValueGridPortrayal2D
-
getPositionLocation
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 classValueGridPortrayal2D
-
getLocationPosition
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 classValueGridPortrayal2D
-
hitOrDraw
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 classValueGridPortrayal2D
-
setBorder
public void setBorder(boolean on) This is not supported by hexagonal portrayals. Throws an exception.- Overrides:
setBorder
in classValueGridPortrayal2D
-
setGridLines
public void setGridLines(boolean on) This is not supported by hexagonal portrayals. Throws an exception.- Overrides:
setGridLines
in classValueGridPortrayal2D
-