sim.portrayal.grid
Class SparseGridPortrayal2D

java.lang.Object
  extended by sim.portrayal.FieldPortrayal
      extended by sim.portrayal.FieldPortrayal2D
          extended by sim.portrayal.grid.SparseGridPortrayal2D
All Implemented Interfaces:
java.io.Serializable, Portrayal, Portrayal2D
Direct Known Subclasses:
HexaSparseGridPortrayal2D

public class SparseGridPortrayal2D
extends FieldPortrayal2D

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

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class sim.portrayal.FieldPortrayal
FieldPortrayal.CustomInspector
 
Field Summary
 DrawPolicy policy
           
 
Fields inherited from class sim.portrayal.FieldPortrayal2D
DEFAULT, DONT_USE_BUFFER, USE_BUFFER
 
Fields inherited from class sim.portrayal.FieldPortrayal
classPortrayals, dirtyField, field, immutableField, portrayalForAll, portrayalForNonNull, portrayalForNull, portrayalForRemainder, portrayals
 
Constructor Summary
SparseGridPortrayal2D()
           
SparseGridPortrayal2D(DrawPolicy policy)
           
 
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.
 Portrayal getDefaultPortrayal()
          Should return a portrayal which can portray any object regardless of whether it's valid or not
 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 getObjectLocation(java.lang.Object object)
          Returns the first location in the underlying field of the given object, if such a thing is reasonable.
 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.
 LocationWrapper getWrapper(java.lang.Object object)
           
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.
 void setObjectPosition(java.lang.Object object, java.awt.geom.Point2D.Double position, DrawInfo2D fieldPortrayalInfo)
          Moves (or tries to move) the object to an internal location equivalent to the given position on-screen of the provided object, assuming that the object exists within the underlying field and that this location is acceptable.
 boolean setSelected(LocationWrapper wrapper, boolean selected)
          Selects or deselects all of the provided objects.
 
Methods inherited from class sim.portrayal.FieldPortrayal2D
draw, getBuffering, getObjectPosition, getRelativeObjectPosition, hitObjects, setBuffering
 
Methods inherited from class sim.portrayal.FieldPortrayal
getDefaultNullPortrayal, 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
 
Methods inherited from interface sim.portrayal.Portrayal
getInspector, getName, getStatus
 

Field Detail

policy

public DrawPolicy policy
Constructor Detail

SparseGridPortrayal2D

public SparseGridPortrayal2D()

SparseGridPortrayal2D

public SparseGridPortrayal2D(DrawPolicy policy)
Method Detail

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

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

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 FieldPortrayal2D

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 FieldPortrayal2D

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 FieldPortrayal2D

setObjectPosition

public void setObjectPosition(java.lang.Object object,
                              java.awt.geom.Point2D.Double position,
                              DrawInfo2D fieldPortrayalInfo)
Description copied from class: FieldPortrayal2D
Moves (or tries to move) the object to an internal location equivalent to the given position on-screen of the provided object, assuming that the object exists within the underlying field and that this location is acceptable. Optionally overridable. The default implementation does nothing.

Overrides:
setObjectPosition in class FieldPortrayal2D

getObjectLocation

public java.lang.Object getObjectLocation(java.lang.Object object)
Description copied from class: FieldPortrayal2D
Returns the first location in the underlying field of the given object, if such a thing is reasonable. Largely used for getPositionOfObject(...). 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 FieldPortrayal2D

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 FieldPortrayal2D

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(java.lang.Object object)

setSelected

public boolean setSelected(LocationWrapper wrapper,
                           boolean selected)
Description copied from class: FieldPortrayal
Selects or deselects all of the provided objects.

Specified by:
setSelected in interface Portrayal
Overrides:
setSelected in class FieldPortrayal