Package 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:

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.

Nested Class Summary

Nested classes/interfaces inherited from class sim.portrayal.grid.ObjectGridPortrayal2D

ObjectGridPortrayal2D.Message

Field Summary

Fields inherited from class sim.portrayal.grid.ObjectGridPortrayal2D

locationToPass

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

Constructors

Constructor	Description
HexaObjectGridPortrayal2D()

Method Summary

Modifier and Type	Method	Description
Point2D.Double	getLocationPosition(Object location, DrawInfo2D info)	Returns the position on-screen of the provided location in the underlying field.
Object	getPositionLocation(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(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.ObjectGridPortrayal2D

getDefaultNullPortrayal, getDefaultPortrayal, getObjectLocation, getWrapper, setBorderColor, setBorderLineFraction, setBorderLineMinMaxWidth, setField, setGridColor, setGridLineFraction, setGridLineMinMaxWidth, setGridMinSpacing, setGridModulus, setSelected

Methods inherited from class sim.portrayal.FieldPortrayal2D

draw, getBuffering, getClipLocation, getObjectPosition, getRelativeObjectPosition, hitObjects, setBuffering, setObjectPosition

Methods inherited from class sim.portrayal.FieldPortrayal

getAlternatePortrayalOrdering, getField, getInspector, getName, getPortrayalForAll, getPortrayalForNonNull, getPortrayalForNull, getPortrayalForObject, getPortrayalForRemainder, getStatus, isDirtyField, isImmutableField, reset, setAlternatePortrayalOrdering, setDirtyField, setImmutableField, setObjectLocation, 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

Methods inherited from interface sim.portrayal.Portrayal

getInspector, getName, getStatus

Constructor Details

HexaObjectGridPortrayal2D

public HexaObjectGridPortrayal2D()

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 ObjectGridPortrayal2D

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 ObjectGridPortrayal2D

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 ObjectGridPortrayal2D

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 ObjectGridPortrayal2D

setBorder

public void setBorder(boolean on)

This is not supported by hexagonal portrayals. Throws an exception.

Overrides:

setBorder in class ObjectGridPortrayal2D

setGridLines

public void setGridLines(boolean on)

This is not supported by hexagonal portrayals. Throws an exception.

Overrides:

setGridLines in class ObjectGridPortrayal2D