Package sim.portrayal.grid

Class ObjectGrid3DPortrayal2D

java.lang.Object

sim.portrayal.FieldPortrayal

sim.portrayal.FieldPortrayal2D

sim.portrayal.grid.ObjectGridPortrayal2D

sim.portrayal.grid.ObjectGrid3DPortrayal2D

All Implemented Interfaces:

Portrayal, Portrayal2D

Direct Known Subclasses:

DenseGrid3DPortrayal2D

public class ObjectGrid3DPortrayal2D
extends ObjectGridPortrayal2D

A 2D portrayal for 3D grids containing objects. Objects are portrayed in order of their z values: that is, objects with higher z values are drawn on top of objects with lower z values.

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 SimplePortrayal2D is a MutableInt3D.

Nested Class Summary

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

ObjectGridPortrayal2D.Message

Field Summary

Fields

Modifier and Type	Field	Description
protected final MutableInt3D	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
ObjectGrid3DPortrayal2D()

Method Summary

Modifier and Type	Method	Description
boolean	getIgnoresEmpty()	Returns whether null (empty) cells are completely ignored for hit-testing and drawing.
Point2D.Double	getLocationPosition(Object location, DrawInfo2D info)	Returns the position on-screen of the provided location in the underlying field.
Object	getObjectLocation(Object object, GUIState gui)	Returns the first location in the underlying field of the given object, if such a thing is reasonable.
Object	getPositionLocation(Point2D.Double position, DrawInfo2D info)	Returns the location corresponding with the given position -- and assuming that the location has a z-value of 0.
Double2D	getScale(DrawInfo2D info)	Returns the width and height, in pixels, of 1.0 x 1.0 units in the underlying field.
LocationWrapper	getWrapper(Object object, Int3D location)
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	setField(Object field)	Sets the field, and sets the dirtyField flag to true.
void	setIgnoresEmpty(boolean val)	Sets whether null (empty) cells are completely ignored for hit-testing and drawing.

Methods inherited from class sim.portrayal.grid.ObjectGridPortrayal2D

getDefaultNullPortrayal, getDefaultPortrayal, getWrapper, setBorder, setBorderColor, setBorderLineFraction, setBorderLineMinMaxWidth, setGridColor, setGridLineFraction, setGridLineMinMaxWidth, setGridLines, 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

Field Details

locationToPass

protected final MutableInt3D locationToPass

Constructor Details

ObjectGrid3DPortrayal2D

public ObjectGrid3DPortrayal2D()

Method Details

getIgnoresEmpty

public boolean getIgnoresEmpty()

Returns whether null (empty) cells are completely ignored for hit-testing and drawing. By default this is true.

setIgnoresEmpty

public void setIgnoresEmpty(boolean val)

Sets whether null (empty) cells are completely ignored for hit-testing and drawing. By default this is true.

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 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 Object getPositionLocation(Point2D.Double position,
 DrawInfo2D info)

Returns the location corresponding with the given position -- and assuming that the location has a z-value of 0.

Overrides:

getPositionLocation in class ObjectGridPortrayal2D

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

getWrapper

public LocationWrapper getWrapper(Object object,
 Int3D location)