Package sim.portrayal.grid

Class SparseGrid3DPortrayal2D

java.lang.Object

sim.portrayal.FieldPortrayal

sim.portrayal.FieldPortrayal2D

sim.portrayal.grid.SparseGridPortrayal2D

sim.portrayal.grid.SparseGrid3DPortrayal2D

All Implemented Interfaces:

Portrayal, Portrayal2D

public class SparseGrid3DPortrayal2D
extends SparseGridPortrayal2D

Can be used to draw both continuous and discrete sparse fields. The 'location' passed into the DrawInfo2D handed to the SimplePortryal2D is an Int3D.

Field Summary

Fields inherited from class sim.portrayal.grid.SparseGridPortrayal2D

policy

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
SparseGrid3DPortrayal2D()

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	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, GUIState gui)
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	setObjectLocation(Object object, Object location, GUIState gui)	Sets location in the underlying field of the given object, if such a thing is reasonable.

Methods inherited from class sim.portrayal.grid.SparseGridPortrayal2D

getDefaultPortrayal, getDrawPolicy, setBorder, setBorderColor, setBorderLineFraction, setBorderLineMinMaxWidth, setDrawPolicy, 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, getDefaultNullPortrayal, getField, getInspector, getName, getPortrayalForAll, getPortrayalForNonNull, getPortrayalForNull, getPortrayalForObject, getPortrayalForRemainder, getStatus, isDirtyField, isImmutableField, reset, setAlternatePortrayalOrdering, setDirtyField, 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

Methods inherited from interface sim.portrayal.Portrayal

getInspector, getName, getStatus

Constructor Details

SparseGrid3DPortrayal2D

public SparseGrid3DPortrayal2D()

Method Details

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 SparseGridPortrayal2D

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 SparseGridPortrayal2D

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 SparseGridPortrayal2D

setObjectLocation

public void setObjectLocation(Object object,
 Object location,
 GUIState gui)

Description copied from class: FieldPortrayal

Sets location in the underlying field of the given object, if such a thing is reasonable. Largely used for setObjectPosition(...), and in the Inspector's LocationWrapper via the Stable classes. Optionally overridable. The default implementation does nothing.

Overrides:

setObjectLocation in class SparseGridPortrayal2D

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 SparseGridPortrayal2D

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 SparseGridPortrayal2D

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 SparseGridPortrayal2D

getWrapper

public LocationWrapper getWrapper(Object object,
 GUIState gui)

Overrides:

getWrapper in class SparseGridPortrayal2D