sim.portrayal.DrawInfo2D Maven / Gradle / Ivy
Show all versions of mason Show documentation
/*
Copyright 2006 by Sean Luke and George Mason University
Licensed under the Academic Free License version 3.0
See the file "LICENSE" for more information
*/
package sim.portrayal;
import java.awt.*;
import java.awt.geom.*;
import sim.display.*;
import sim.portrayal.network.*;
/**
The DrawInfo2D class provides two Rectangles which define a simple drawing situation.
The draw rectangle describes a box which should be considered
to define the coordinates and scale for the object being drawn. That is, the
object should imagine that it's located at the origin [the box's coordinate],
and is being drawn relative to the scale [the box's values].
While continuous objects will probably center themselves on the origin,
Discrete 2D objects typically will draw themselves to fill the box (the
box effectively defines the [0,0] to [1,1] range). You may assume that
the coordinates will never be fipped or zeroed (that is, the width and
height will not be negative or 0).
Why is this rectangle being provided instead of just using an affine transform
on the grahics object to scale and translate the space? Two reasons. First,
affine transforms are expensive in Java2D. Second, if you need to draw auxillary
information (like readable text), the text would also get transformed (scaled), which
is not what we want. Line thickness is also likewise transformed, which might or
might not be desirable.
The clip rectangle describes a box defining a region that must be drawn.
This region will always intersect at least partially with the draw rectangle.
Why provide this clip rectangle? Because to my knowledge there's no standard way to
tell objects that only part of them needs to be updated in Java2D and Swing -- a failure
of the system design.
The precise flag hints to the underlying portrayals that the drawing should be
done precisely rather than rapidly: this is primarily for generating PDF images. It may
be ignored.
The selected flag indicates to the underlying portrayals that the object in question
is in selected mode. This flag is only set by FieldPortrayals.
The location object may store the location of the item in the outer Field.
Fields are free to not store anything here if they see fit. Further, this
object may not be the actual kind of object used to store the location (for example,
it might be a MutableDouble2D, even though the object is associated with a Double2D).
*/
public class DrawInfo2D
{
public GUIState gui;
public FieldPortrayal2D fieldPortrayal;
public Rectangle2D.Double draw;
public Rectangle2D.Double clip;
public boolean selected;
public boolean precise;
public Object location;
public DrawInfo2D(GUIState gui, FieldPortrayal2D fieldPortrayal, RectangularShape draw, RectangularShape clip)
{
this.draw = new Rectangle2D.Double();
this.draw.setRect(draw.getFrame());
this.clip = new Rectangle2D.Double();
this.clip.setRect(clip.getFrame());
precise = false;
this.gui = gui;
this.fieldPortrayal = fieldPortrayal;
}
public DrawInfo2D(DrawInfo2D other, double translateX, double translateY)
{
Rectangle2D.Double odraw = other.draw;
draw = new Rectangle2D.Double(odraw.x+translateX,odraw.y+translateY,odraw.width,odraw.height);
Rectangle2D.Double oclip = other.clip;
clip = new Rectangle2D.Double(oclip.x+translateX,oclip.y+translateY,oclip.width,oclip.height);
precise = other.precise;
gui = other.gui;
fieldPortrayal = other.fieldPortrayal;
selected = other.selected;
// location = other.location; // would location be invalid?
}
public DrawInfo2D(DrawInfo2D other)
{
this(other, 0, 0);
location = other.location;
}
public String toString() { return "DrawInfo2D[ Draw: " + draw + " Clip: " + clip + " Precise: " + precise + " Location : " + location + " portrayal: " + fieldPortrayal + "]"; }
}