sim.portrayal.grid
Class HexaObjectGridPortrayal2D
java.lang.Object
sim.portrayal.FieldPortrayal
sim.portrayal.FieldPortrayal2D
sim.portrayal.grid.ObjectGridPortrayal2D
sim.portrayal.grid.HexaObjectGridPortrayal2D
- All Implemented Interfaces:
- java.io.Serializable, Portrayal, Portrayal2D
- Direct Known Subclasses:
- FastHexaObjectGridPortrayal2D
public class HexaObjectGridPortrayal2D
- extends ObjectGridPortrayal2D
Portrayal for hexagonal grids (each cell has six equally-distanced neighbors) containing objects.
By default this portrayal describes objects as gray ovals (that's what getDefaultPortrayal() returns)
and null values as empty regions (that's what getDefaultNullPortrayal() returns). You may wish to override this
for your own purposes.
The 'location' passed
into the DrawInfo2D handed to the SimplePortryal2D is a MutableInt2D.
- See Also:
- Serialized Form
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) |
Method Summary |
java.lang.Object |
getClipLocation(DrawInfo2D fieldPortrayalInfo)
Returns an object representing the location in the field of the origin of the clip of the DrawInfo2D. |
java.awt.geom.Point2D.Double |
getLocationPosition(java.lang.Object location,
DrawInfo2D info)
Returns the position on-screen of the provided location in the underlying field. |
java.lang.Object |
getPositionLocation(java.awt.geom.Point2D.Double position,
DrawInfo2D info)
Returns the Location, in the parlance of the underlying Field, of the given position. |
Double2D |
getScale(DrawInfo2D info)
Returns the width and height, in pixels, of 1.0 x 1.0 units in the underlying field. |
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.FieldPortrayal |
getField, getInspector, getName, getPortrayalForAll, getPortrayalForNonNull, getPortrayalForNull, getPortrayalForObject, getPortrayalForRemainder, getStatus, isImmutableField, setImmutableField, setPortrayalForAll, setPortrayalForClass, setPortrayalForNonNull, setPortrayalForNull, setPortrayalForObject, setPortrayalForRemainder, setSelected |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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)
HexaObjectGridPortrayal2D
public HexaObjectGridPortrayal2D()
getClipLocation
public java.lang.Object getClipLocation(DrawInfo2D fieldPortrayalInfo)
- Description copied from class:
FieldPortrayal2D
- Returns an object representing the location in the field of the origin of the clip of the DrawInfo2D.
This method calls getPositionLocation, which may or may not be implemented by the FieldPortrayal2D.
- Overrides:
getClipLocation
in class ObjectGridPortrayal2D
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 ObjectGridPortrayal2D
getPositionLocation
public java.lang.Object getPositionLocation(java.awt.geom.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 ObjectGridPortrayal2D
getLocationPosition
public java.awt.geom.Point2D.Double getLocationPosition(java.lang.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 ObjectGridPortrayal2D
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 ObjectGridPortrayal2D