sim.portrayal.grid
Class ObjectGridPortrayal2D
java.lang.Object
sim.portrayal.FieldPortrayal
sim.portrayal.FieldPortrayal2D
sim.portrayal.grid.ObjectGridPortrayal2D
- All Implemented Interfaces:
- java.io.Serializable, Portrayal, Portrayal2D
- Direct Known Subclasses:
- FastObjectGridPortrayal2D, HexaObjectGridPortrayal2D
public class ObjectGridPortrayal2D
- extends FieldPortrayal2D
A portrayal for grids containing objects, such as maybe agents or agent bodies.
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.
- See Also:
- Serialized Form
Method Summary |
Portrayal |
getDefaultNullPortrayal()
Returns a default portrayal for null. |
Portrayal |
getDefaultPortrayal()
Should return a portrayal which can portray any object regardless of
whether it's valid or not |
LocationWrapper |
getWrapper(Int2D location)
|
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. |
void |
setField(java.lang.Object field)
Sets the field. |
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 |
ObjectGridPortrayal2D
public ObjectGridPortrayal2D()
setField
public void setField(java.lang.Object field)
- Description copied from class:
FieldPortrayal
- Sets the field. Also sets dirtyField = true. May throw an exception if the field is inappropriate.
- Overrides:
setField
in class FieldPortrayal2D
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
getDefaultNullPortrayal
public Portrayal getDefaultNullPortrayal()
- Description copied from class:
FieldPortrayal
- Returns a default portrayal for null. By default this is set to
the same as getDefaultPortrayal(). Override this to provide a
more interesting default portrayals for null.
- Overrides:
getDefaultNullPortrayal
in class FieldPortrayal
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 FieldPortrayal2D
getWrapper
public LocationWrapper getWrapper(Int2D location)