/*
* @(#)QuadTreeDrawing.java
*
* Copyright (c) 1996-2010 The authors and contributors of JHotDraw.
* You may not use, copy or modify this file, except in compliance with the
* accompanying license terms.
*/
package org.jhotdraw.draw;
import org.jhotdraw.draw.event.FigureEvent;
import org.jhotdraw.geom.QuadTree;
import java.awt.*;
import java.awt.geom.*;
import org.jhotdraw.util.*;
import java.util.*;
import org.jhotdraw.geom.Geom;
import static org.jhotdraw.draw.AttributeKeys.*;
/**
* An implementation of {@link Drawing} which uses a
* {@link org.jhotdraw.geom.QuadTree} to provide a good responsiveness for
* drawings which contain many figures.
*
* @author Werner Randelshofer
* @version $Id$
*/
public class QuadTreeDrawing extends AbstractDrawing {
private static final long serialVersionUID = 1L;
private QuadTree<Figure> quadTree = new QuadTree<Figure>();
private boolean needsSorting = false;
@Override
public int indexOf(Figure figure) {
return children.indexOf(figure);
}
@Override
public void basicAdd(int index, Figure figure) {
super.basicAdd(index, figure);
quadTree.add(figure, figure.getDrawingArea());
needsSorting = true;
}
@Override
public Figure basicRemoveChild(int index) {
Figure figure = getChild(index);
quadTree.remove(figure);
needsSorting = true;
super.basicRemoveChild(index);
return figure;
}
@Override
public void draw(Graphics2D g) {
Rectangle2D clipBounds = g.getClipBounds();
if (clipBounds != null) {
Collection<Figure> c = quadTree.findIntersects(clipBounds);
Collection<Figure> toDraw = sort(c);
draw(g, toDraw);
} else {
draw(g, children);
}
}
/**
* Implementation note: Sorting can not be done for orphaned children.
*/
@Override
public java.util.List<Figure> sort(Collection<? extends Figure> c) {
ensureSorted();
ArrayList<Figure> sorted = new ArrayList<Figure>(c.size());
for (Figure f : children) {
if (c.contains(f)) {
sorted.add(f);
}
}
return sorted;
}
public void draw(Graphics2D g, Collection<Figure> c) {
for (Figure f : c) {
if (f.isVisible()) {
f.draw(g);
}
}
}
public java.util.List<Figure> getChildren(Rectangle2D.Double bounds) {
return new LinkedList<Figure>(quadTree.findInside(bounds));
}
@Override
public java.util.List<Figure> getChildren() {
return Collections.unmodifiableList(children);
}
@Override
public Figure findFigureInside(Point2D.Double p) {
Collection<Figure> c = quadTree.findContains(p);
for (Figure f : getFiguresFrontToBack()) {
if (c.contains(f) && f.contains(p)) {
return f.findFigureInside(p);
}
}
return null;
}
/**
* Returns an iterator to iterate in
* Z-order front to back over the children.
*/
@Override
public java.util.List<Figure> getFiguresFrontToBack() {
ensureSorted();
return new ReversedList<Figure>(children);
}
@Override
public Figure findFigure(Point2D.Double p) {
Collection<Figure> c = quadTree.findContains(p);
switch (c.size()) {
case 0:
return null;
case 1: {
Figure f = c.iterator().next();
return (f.contains(p)) ? f : null;
}
default: {
for (Figure f : getFiguresFrontToBack()) {
if (c.contains(f) && f.contains(p)) {
return f;
}
}
return null;
}
}
}
@Override
public Figure findFigureExcept(Point2D.Double p, Figure ignore) {
Collection<Figure> c = quadTree.findContains(p);
switch (c.size()) {
case 0: {
return null;
}
case 1: {
Figure f = c.iterator().next();
return (f == ignore || !f.contains(p)) ? null : f;
}
default: {
for (Figure f : getFiguresFrontToBack()) {
if (f != ignore && f.contains(p)) {
return f;
}
}
return null;
}
}
}
@Override
public Figure findFigureExcept(Point2D.Double p, Collection<? extends Figure> ignore) {
Collection<Figure> c = quadTree.findContains(p);
switch (c.size()) {
case 0: {
return null;
}
case 1: {
Figure f = c.iterator().next();
return (!ignore.contains(f) || !f.contains(p)) ? null : f;
}
default: {
for (Figure f : getFiguresFrontToBack()) {
if (!ignore.contains(f) && f.contains(p)) {
return f;
}
}
return null;
}
}
}
@Override
public Figure findFigureBehind(Point2D.Double p, Figure figure) {
boolean isBehind = false;
for (Figure f : getFiguresFrontToBack()) {
if (isBehind) {
if (f.isVisible() && f.contains(p)) {
return f;
}
} else {
isBehind = figure == f;
}
}
return null;
}
@Override
public Figure findFigureBehind(Point2D.Double p, Collection<? extends Figure> children) {
int inFrontOf = children.size();
for (Figure f : getFiguresFrontToBack()) {
if (inFrontOf == 0) {
if (f.isVisible() && f.contains(p)) {
return f;
}
} else {
if (children.contains(f)) {
inFrontOf--;
}
}
}
return null;
}
@Override
public java.util.List<Figure> findFigures(Rectangle2D.Double r) {
LinkedList<Figure> c = new LinkedList<Figure>(quadTree.findIntersects(r));
switch (c.size()) {
case 0:
// fall through
case 1:
return c;
default:
return sort(c);
}
}
@Override
public java.util.List<Figure> findFiguresWithin(Rectangle2D.Double bounds) {
LinkedList<Figure> contained = new LinkedList<Figure>();
for (Figure f : children) {
Rectangle2D.Double r = f.getBounds();
if (f.get(TRANSFORM) != null) {
Rectangle2D rt = f.get(TRANSFORM).createTransformedShape(r).getBounds2D();
r = (rt instanceof Rectangle2D.Double) ? (Rectangle2D.Double) rt : new Rectangle2D.Double(rt.getX(), rt.getY(), rt.getWidth(), rt.getHeight());
}
if (f.isVisible() && Geom.contains(bounds, r)) {
contained.add(f);
}
}
return contained;
}
@Override
public void bringToFront(Figure figure) {
if (children.remove(figure)) {
children.add(figure);
needsSorting = true;
fireAreaInvalidated(figure.getDrawingArea());
}
}
@Override
public void sendToBack(Figure figure) {
if (children.remove(figure)) {
children.add(0, figure);
needsSorting = true;
fireAreaInvalidated(figure.getDrawingArea());
}
}
@Override
public boolean contains(Figure f) {
return children.contains(f);
}
/**
* Ensures that the children are sorted in z-order sequence.
*/
private void ensureSorted() {
if (needsSorting) {
Collections.sort(children, FigureLayerComparator.INSTANCE);
needsSorting = false;
}
}
@Override
protected <T> void setAttributeOnChildren(AttributeKey<T> key, T newValue) {
// empty
}
@Override
public QuadTreeDrawing clone() {
QuadTreeDrawing that = (QuadTreeDrawing) super.clone();
that.quadTree = new QuadTree<Figure>();
for (Figure f : getChildren()) {
quadTree.add(f, f.getDrawingArea());
}
return that;
}
@Override
protected EventHandler createEventHandler() {
return new QuadTreeEventHandler();
}
/**
* Handles all figure events fired by Figures contained in the Drawing.
*/
protected class QuadTreeEventHandler extends AbstractCompositeFigure.EventHandler {
private static final long serialVersionUID = 1L;
@Override
public void figureChanged(FigureEvent e) {
if (!isChanging()) {
quadTree.remove(e.getFigure());
quadTree.add(e.getFigure(), e.getFigure().getDrawingArea());
needsSorting = true;
invalidate();
fireAreaInvalidated(e.getInvalidatedArea());
}
}
}
@Override
protected void drawFill(Graphics2D g) {
//throw new UnsupportedOperationException("Not supported yet.");
}
@Override
protected void drawStroke(Graphics2D g) {
// throw new UnsupportedOperationException("Not supported yet.");
}
@Override
public void drawCanvas(Graphics2D g) {
if (get(CANVAS_WIDTH) != null && get(CANVAS_HEIGHT) != null) {
// Determine canvas color and opacity
Color canvasColor = get(CANVAS_FILL_COLOR);
Double fillOpacity = get(CANVAS_FILL_OPACITY);
if (canvasColor != null && fillOpacity > 0) {
canvasColor = new Color(
(canvasColor.getRGB() & 0xffffff)
| ((int) (fillOpacity * 255) << 24), true);
// Fill the canvas
Rectangle2D.Double r = new Rectangle2D.Double(
0, 0, get(CANVAS_WIDTH), get(CANVAS_HEIGHT));
g.setColor(canvasColor);
g.fill(r);
}
}
}
}