diff --git a/src/main/java/edu/umd/cs/piccolo/PCamera.java b/src/main/java/edu/umd/cs/piccolo/PCamera.java deleted file mode 100755 index ee39c46..0000000 --- a/src/main/java/edu/umd/cs/piccolo/PCamera.java +++ /dev/null @@ -1,736 +0,0 @@ -/* - * Copyright (c) 2002-@year@, University of Maryland - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, are permitted provided - * that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions - * and the following disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the University of Maryland nor the names of its contributors may be used to - * endorse or promote products derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR - * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Piccolo was written at the Human-Computer Interaction Laboratory www.cs.umd.edu/hcil by Jesse Grosjean - * under the supervision of Ben Bederson. The Piccolo website is www.cs.umd.edu/hcil/piccolo. - */ -package edu.umd.cs.piccolo; - -import java.awt.BasicStroke; -import java.awt.Color; -import java.awt.Graphics2D; -import java.awt.geom.AffineTransform; -import java.awt.geom.Dimension2D; -import java.awt.geom.NoninvertibleTransformException; -import java.awt.geom.Point2D; -import java.awt.geom.Rectangle2D; -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import edu.umd.cs.piccolo.activities.PTransformActivity; -import edu.umd.cs.piccolo.util.PAffineTransform; -import edu.umd.cs.piccolo.util.PBounds; -import edu.umd.cs.piccolo.util.PDebug; -import edu.umd.cs.piccolo.util.PDimension; -import edu.umd.cs.piccolo.util.PObjectOutputStream; -import edu.umd.cs.piccolo.util.PPaintContext; -import edu.umd.cs.piccolo.util.PPickPath; -import edu.umd.cs.piccolo.util.PUtil; - -/** - * PCamera represents a viewport onto a list of layer nodes. - * Each camera maintains a view transform through which it views these - * layers. Translating and scaling this view transform is how zooming - * and panning are implemented. - *

- * Cameras are also the point through which all PInputEvents enter Piccolo. The - * canvas coordinate system, and the local coordinate system of the topmost camera - * should always be the same. - *

- * @see PLayer - * @version 1.0 - * @author Jesse Grosjean - */ -public class PCamera extends PNode { - - /** - * - */ - private static final long serialVersionUID = -8870345914993419772L; - /** - * The property name that identifies a change in the set of this camera's - * layers (see {@link #getLayer getLayer}, {@link #getLayerCount - * getLayerCount}, {@link #getLayersReference getLayersReference}). A - * property change event's new value will be a reference to the list of this - * nodes layers, but old value will always be null. - */ - public static final String PROPERTY_LAYERS = "layers"; - public static final int PROPERTY_CODE_LAYERS = 1 << 11; - - /** - * The property name that identifies a change in this camera's view - * transform (see {@link #getViewTransform getViewTransform}, {@link - * #getViewTransformReference getViewTransformReference}). A property change - * event's new value will be a reference to the view transform, but old - * value will always be null. - */ - public static final String PROPERTY_VIEW_TRANSFORM = "viewTransform"; - public static final int PROPERTY_CODE_VIEW_TRANSFORM = 1 << 12; - - public static final int VIEW_CONSTRAINT_NONE = 0; - public static final int VIEW_CONSTRAINT_ALL = 1; - public static final int VIEW_CONSTRAINT_CENTER = 2; - - private transient PComponent component; - private transient List layers; - private PAffineTransform viewTransform; - private int viewConstraint; - - /** - * Construct a new camera with no layers and a default white color. - */ - public PCamera() { - super(); - viewTransform = new PAffineTransform(); - layers = new ArrayList(); - viewConstraint = VIEW_CONSTRAINT_NONE; - } - - /** - * Get the canvas associated with this camera. This will return null if - * not canvas has been associated, as may be the case for internal cameras. - */ - public PComponent getComponent() { - return component; - } - - /** - * Set the canvas associated with this camera. When the camera is repainted - * it will request repaints on this canvas. - */ - public void setComponent(PComponent aComponent) { - component = aComponent; - invalidatePaint(); - } - - /** - * Repaint this camera, and forward the repaint request to the camera's - * canvas if it is not null. - */ - public void repaintFrom(PBounds localBounds, PNode descendentOrThis) { - if (getParent() != null) { - if (descendentOrThis != this) { - localToParent(localBounds); - } - - if (component != null) { - component.repaint(localBounds); - } - - getParent().repaintFrom(localBounds, this); - } - } - - private static PBounds TEMP_REPAINT_RECT = new PBounds(); - - /** - * Repaint from one of the cameras layers. The repaint region needs to be - * transformed from view to local in this case. Unlike most repaint - * methods in piccolo this one must not modify the viewBounds parameter. - */ - public void repaintFromLayer(PBounds viewBounds, PNode repaintedLayer) { - TEMP_REPAINT_RECT.setRect(viewBounds); - - viewToLocal(TEMP_REPAINT_RECT); - if (getBoundsReference().intersects(TEMP_REPAINT_RECT)) { - PBounds.intersect(TEMP_REPAINT_RECT, getBoundsReference(), TEMP_REPAINT_RECT); - repaintFrom(TEMP_REPAINT_RECT, repaintedLayer); - } - } - - //**************************************************************** - // Layers - //**************************************************************** - - /** - * Return a reference to the list of layers managed by this camera. - */ - public List getLayersReference() { - return layers; - } - - public int getLayerCount() { - return layers.size(); - } - - public PLayer getLayer(int index) { - return (PLayer) layers.get(index); - } - - public int indexOfLayer(PLayer layer) { - return layers.indexOf(layer); - } - - /** - * Add the layer to the end of this camera's list of layers. - * Layers may be viewed by multiple cameras at once. - */ - public void addLayer(PLayer layer) { - addLayer(layers.size(), layer); - } - - /** - * Add the layer at the given index in this camera's list of layers. - * Layers may be viewed by multiple cameras at once. - */ - public void addLayer(int index, PLayer layer) { - layers.add(index, layer); - layer.addCamera(this); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_LAYERS ,PROPERTY_LAYERS, null, layers); - } - - /** - * Remove the given layer from the list of layers managed by this - * camera. - */ - public PLayer removeLayer(PLayer layer) { - return removeLayer(layers.indexOf(layer)); - } - - /** - * Remove the layer at the given index from the list of - * layers managed by this camera. - */ - public PLayer removeLayer(int index) { - PLayer layer = (PLayer) layers.remove(index); - layer.removeCamera(this); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_LAYERS, PROPERTY_LAYERS, null, layers); - return layer; - } - - /** - * Return the total bounds of all the layers that this camera looks at. - */ - public PBounds getUnionOfLayerFullBounds() { - PBounds result = new PBounds(); - - int count = getLayerCount(); - for (int i = 0; i < count; i++) { - PLayer each = (PLayer) layers.get(i); - result.add(each.getFullBoundsReference()); - } - - return result; - } - - //**************************************************************** - // Painting Layers - //**************************************************************** - - /** - * Paint this camera (default background color is white) and then paint - * the cameras view through the view transform. - */ - protected void paint(PPaintContext paintContext) { - super.paint(paintContext); - - paintContext.pushClip(getBoundsReference()); - paintContext.pushTransform(viewTransform); - - paintCameraView(paintContext); - paintDebugInfo(paintContext); - - paintContext.popTransform(viewTransform); - paintContext.popClip(getBoundsReference()); - } - - /** - * Paint all the layers that the camera is looking at, this method is - * only called when the cameras view transform and clip are applied - * to the paintContext. - */ - protected void paintCameraView(PPaintContext paintContext) { - int count = getLayerCount(); - for (int i = 0; i < count; i++) { - PLayer each = (PLayer) layers.get(i); - each.fullPaint(paintContext); - } - } - - protected void paintDebugInfo(PPaintContext paintContext) { - if (PDebug.debugBounds || PDebug.debugFullBounds) { - Graphics2D g2 = paintContext.getGraphics(); - paintContext.setRenderQuality(PPaintContext.LOW_QUALITY_RENDERING); - g2.setStroke(new BasicStroke(0)); - ArrayList nodes = new ArrayList(); - PBounds nodeBounds = new PBounds(); - - Color boundsColor = Color.red; - Color fullBoundsColor = new Color(1.0f, 0f, 0f, 0.2f); - - for (int i = 0; i < getLayerCount(); i++) { - getLayer(i).getAllNodes(null, nodes); - } - - Iterator i = getAllNodes(null, nodes).iterator(); - - while (i.hasNext()) { - PNode each = (PNode) i.next(); - - if (PDebug.debugBounds) { - g2.setPaint(boundsColor); - nodeBounds.setRect(each.getBoundsReference()); - - if (!nodeBounds.isEmpty()) { - each.localToGlobal(nodeBounds); - globalToLocal(nodeBounds); - if (each == this || each.isDescendentOf(this)) { - localToView(nodeBounds); - } - g2.draw(nodeBounds); - } - } - - if (PDebug.debugFullBounds) { - g2.setPaint(fullBoundsColor); - nodeBounds.setRect(each.getFullBoundsReference()); - - if (!nodeBounds.isEmpty()) { - if (each.getParent() != null) { - each.getParent().localToGlobal(nodeBounds); - } - globalToLocal(nodeBounds); - if (each == this || each.isDescendentOf(this)) { - localToView(nodeBounds); - } - g2.fill(nodeBounds); - } - } - } - } - } - - /** - * Override fullPaint to push the camera onto the paintContext so that it - * can be later be accessed by PPaintContext.getCamera(); - */ - public void fullPaint(PPaintContext paintContext) { - paintContext.pushCamera(this); - super.fullPaint(paintContext); - paintContext.popCamera(this); - } - - //**************************************************************** - // Picking - //**************************************************************** - - /** - * Generate and return a PPickPath for the point x,y specified in the local - * coord system of this camera. Picking is done with a rectangle, halo - * specifies how large that rectangle will be. - */ - public PPickPath pick(double x, double y, double halo) { - PBounds b = new PBounds(new Point2D.Double(x, y), -halo, -halo); - PPickPath result = new PPickPath(this, b); - - fullPick(result); - - // make sure this camera is pushed. - if (result.getNodeStackReference().size() == 0) { - result.pushNode(this); - result.pushTransform(getTransformReference(false)); - } - - return result; - } - - /** - * After the direct children of the camera have been given a chance to be - * picked objects viewed by the camera are given a chance to be picked. - */ - protected boolean pickAfterChildren(PPickPath pickPath) { - if (intersects(pickPath.getPickBounds())) { - pickPath.pushTransform(viewTransform); - - if (pickCameraView(pickPath)) { - return true; - } - - pickPath.popTransform(viewTransform); - return true; - } - return false; - } - - /** - * Pick all the layers that the camera is looking at, this method is - * only called when the cameras view transform and clip are applied - * to the pickPath. - */ - protected boolean pickCameraView(PPickPath pickPath) { - int count = getLayerCount(); - for (int i = count - 1; i >= 0; i--) { - PLayer each = (PLayer) layers.get(i); - if (each.fullPick(pickPath)) { - return true; - } - } - return false; - } - - - //**************************************************************** - // View Transform - Methods for accessing the view transform. The - // view transform is applied before painting and picking the cameras - // layers. But not before painting or picking its direct children. - // - // Changing the view transform is how zooming and panning are - // accomplished. - //**************************************************************** - - /** - * Return the bounds of this camera in the view coordinate system. - */ - public PBounds getViewBounds() { - return (PBounds) localToView(getBounds()); - } - - /** - * Translates and scales the camera's view transform so that the given bounds (in camera - * layer's coordinate system)are centered withing the cameras view bounds. Use this method - * to point the camera at a given location. - */ - public void setViewBounds(Rectangle2D centerBounds) { - animateViewToCenterBounds(centerBounds, true, 0); - } - - /** - * Return the scale applied by the view transform to the layers - * viewed by this camera. - */ - public double getViewScale() { - return viewTransform.getScale(); - } - - /** - * Scale the view transform that is applied to the layers - * viewed by this camera by the given amount. - */ - public void scaleView(double scale) { - scaleViewAboutPoint(scale, 0, 0); - } - - /** - * Scale the view transform that is applied to the layers - * viewed by this camera by the given amount about the given point. - */ - public void scaleViewAboutPoint(double scale, double x, double y) { - viewTransform.scaleAboutPoint(scale, x, y); - applyViewConstraints(); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_VIEW_TRANSFORM, PROPERTY_VIEW_TRANSFORM, null, viewTransform); - } - - /** - * Set the scale of the view transform that is applied to - * the layers viewed by this camera. - */ - public void setViewScale(double scale) { - scaleView(scale / getViewScale()); - } - - /** - * Translate the view transform that is applied to the camera's - * layers. - */ - public void translateView(double dx, double dy) { - viewTransform.translate(dx, dy); - applyViewConstraints(); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_VIEW_TRANSFORM, PROPERTY_VIEW_TRANSFORM, null, viewTransform); - } - - /** - * Sets the offset of the view transform that is applied - * to the camera's layers. - */ - public void setViewOffset(double x, double y) { - viewTransform.setOffset(x, y); - applyViewConstraints(); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_VIEW_TRANSFORM, PROPERTY_VIEW_TRANSFORM, null, viewTransform); - } - - /** - * Get a copy of the view transform that is applied to the camera's - * layers. - */ - public PAffineTransform getViewTransform() { - return (PAffineTransform) viewTransform.clone(); - } - - /** - * Get a reference to the view transform that is applied to the camera's - * layers. - */ - public PAffineTransform getViewTransformReference() { - return viewTransform; - } - - /** - * Set the view transform that is applied to the views layers. - */ - public void setViewTransform(AffineTransform aTransform) { - viewTransform.setTransform(aTransform); - applyViewConstraints(); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_VIEW_TRANSFORM, PROPERTY_VIEW_TRANSFORM, null, viewTransform); - } - - /** - * Animate the camera's view from its current transform when the activity - * starts to a new transform that centers the given bounds in the camera - * layers coordinate system into the cameras view bounds. If the duration is - * 0 then the view will be transformed immediately, and null will be - * returned. Else a new PTransformActivity will get returned that is set to - * animate the camera's view transform to the new bounds. If shouldScale - * is true, then the camera will also scale its view so that the given - * bounds fit fully within the cameras view bounds, else the camera will - * maintain its original scale. - */ - public PTransformActivity animateViewToCenterBounds(Rectangle2D centerBounds, boolean shouldScaleToFit, long duration) { - PBounds viewBounds = getViewBounds(); - PDimension delta = viewBounds.deltaRequiredToCenter(centerBounds); - PAffineTransform newTransform = getViewTransform(); - newTransform.translate(delta.width, delta.height); - - if (shouldScaleToFit) { - double s = Math.min(viewBounds.getWidth() / centerBounds.getWidth(), viewBounds.getHeight() / centerBounds.getHeight()); - if (s != Double.POSITIVE_INFINITY && s != 0) { - newTransform.scaleAboutPoint(s, centerBounds.getCenterX(), centerBounds.getCenterY()); - } - } - - return animateViewToTransform(newTransform, duration); - } - - /** - * Pan the camera's view from its current transform when the activity starts - * to a new transform so that the view bounds will contain (if possible, intersect - * if not possible) the new bounds in the camera layers coordinate system. - * If the duration is 0 then the view will be transformed immediately, and null - * will be returned. Else a new PTransformActivity will get returned that is set - * to animate the camera's view transform to the new bounds. - */ - public PTransformActivity animateViewToPanToBounds(Rectangle2D panToBounds, long duration) { - PBounds viewBounds = getViewBounds(); - PDimension delta = viewBounds.deltaRequiredToContain(panToBounds); - - if (delta.width != 0 || delta.height != 0) { - if (duration == 0) { - translateView(-delta.width, -delta.height); - } else { - AffineTransform at = getViewTransform(); - at.translate(-delta.width, -delta.height); - return animateViewToTransform(at, duration); - } - } - - return null; - } - - /** - * @deprecated Renamed to animateViewToPanToBounds - */ - public PTransformActivity animateViewToIncludeBounds(Rectangle2D includeBounds, long duration) { - return animateViewToPanToBounds(includeBounds, duration); - } - - /** - * Animate the cameras view transform from its current value when the - * activity starts to the new destination transform value. - */ - public PTransformActivity animateViewToTransform(AffineTransform destination, long duration) { - if (duration == 0) { - setViewTransform(destination); - return null; - } - - PTransformActivity.Target t = new PTransformActivity.Target() { - public void setTransform(AffineTransform aTransform) { - PCamera.this.setViewTransform(aTransform); - } - public void getSourceMatrix(double[] aSource) { - PCamera.this.viewTransform.getMatrix(aSource); - } - }; - - PTransformActivity ta = new PTransformActivity(duration, PUtil.DEFAULT_ACTIVITY_STEP_RATE, t, destination); - - PRoot r = getRoot(); - if (r != null) { - r.getActivityScheduler().addActivity(ta); - } - - return ta; - } - - //**************************************************************** - // View Transform Constraints - Methods for setting and applying - // constraints to the view transform. - //**************************************************************** - - public int getViewConstraint() { - return viewConstraint; - } - public void setViewConstraint(int constraint) { - viewConstraint = constraint; - applyViewConstraints(); - } - - protected void applyViewConstraints() { - if (viewConstraint == VIEW_CONSTRAINT_NONE) - return; - - PBounds viewBounds = getViewBounds(); - PBounds layerBounds = (PBounds) globalToLocal(getUnionOfLayerFullBounds()); - PDimension constraintDelta = null; - - switch (viewConstraint) { - case VIEW_CONSTRAINT_ALL: - constraintDelta = viewBounds.deltaRequiredToContain(layerBounds); - break; - - case VIEW_CONSTRAINT_CENTER: - layerBounds.setRect(layerBounds.getCenterX(), layerBounds.getCenterY(), 0, 0); - constraintDelta = viewBounds.deltaRequiredToContain(layerBounds); - break; - } - - viewTransform.translate(-constraintDelta.width, -constraintDelta.height); - } - - //**************************************************************** - // Camera View Coord System Conversions - Methods to translate from - // the camera's local coord system (above the camera's view transform) to the - // camera view coord system (below the camera's view transform). When - // converting geometry from one of the canvas's layers you must go - // through the view transform. - //**************************************************************** - - /** - * Convert the point from the camera's view coordinate system to the - * camera's local coordinate system. The given point is modified by this. - */ - public Point2D viewToLocal(Point2D viewPoint) { - return viewTransform.transform(viewPoint, viewPoint); - } - - /** - * Convert the dimension from the camera's view coordinate system to the - * camera's local coordinate system. The given dimension is modified by this. - */ - public Dimension2D viewToLocal(Dimension2D viewDimension) { - return viewTransform.transform(viewDimension, viewDimension); - } - - /** - * Convert the rectangle from the camera's view coordinate system to the - * camera's local coordinate system. The given rectangle is modified by this method. - */ - public Rectangle2D viewToLocal(Rectangle2D viewRectangle) { - return viewTransform.transform(viewRectangle, viewRectangle); - } - - /** - * Convert the point from the camera's local coordinate system to the - * camera's view coordinate system. The given point is modified by this method. - */ - public Point2D localToView(Point2D localPoint) { - try { - return viewTransform.inverseTransform(localPoint, localPoint); - } catch (NoninvertibleTransformException e) { - e.printStackTrace(); - } - return null; - } - - /** - * Convert the dimension from the camera's local coordinate system to the - * camera's view coordinate system. The given dimension is modified by this method. - */ - public Dimension2D localToView(Dimension2D localDimension) { - return viewTransform.inverseTransform(localDimension, localDimension); - } - - /** - * Convert the rectangle from the camera's local coordinate system to the - * camera's view coordinate system. The given rectangle is modified by this method. - */ - public Rectangle2D localToView(Rectangle2D localRectangle) { - return viewTransform.inverseTransform(localRectangle, localRectangle); - } - - //**************************************************************** - // Serialization - Cameras conditionally serialize their layers. - // This means that only the layer references that were unconditionally - // (using writeObject) serialized by someone else will be restored - // when the camera is unserialized. - //****************************************************************/ - - /** - * Write this camera and all its children out to the given stream. Note - * that the cameras layers are written conditionally, so they will only - * get written out if someone else writes them unconditionally. - */ - private void writeObject(ObjectOutputStream out) throws IOException { - out.defaultWriteObject(); - - int count = getLayerCount(); - for (int i = 0; i < count; i++) { - ((PObjectOutputStream)out).writeConditionalObject(layers.get(i)); - } - - out.writeObject(Boolean.FALSE); - ((PObjectOutputStream)out).writeConditionalObject(component); - } - - private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { - in.defaultReadObject(); - - layers = new ArrayList(); - - while (true) { - Object each = in.readObject(); - if (each != null) { - if (each.equals(Boolean.FALSE)) { - break; - } else { - layers.add((PLayer)each); - } - } - } - - component = (PComponent) in.readObject(); - } -} - diff --git a/src/main/java/edu/umd/cs/piccolo/PCanvas.java b/src/main/java/edu/umd/cs/piccolo/PCanvas.java deleted file mode 100755 index 894f177..0000000 --- a/src/main/java/edu/umd/cs/piccolo/PCanvas.java +++ /dev/null @@ -1,609 +0,0 @@ -/* - * Copyright (c) 2002-@year@, University of Maryland - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, are permitted provided - * that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions - * and the following disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the University of Maryland nor the names of its contributors may be used to - * endorse or promote products derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR - * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Piccolo was written at the Human-Computer Interaction Laboratory www.cs.umd.edu/hcil by Jesse Grosjean - * under the supervision of Ben Bederson. The Piccolo website is www.cs.umd.edu/hcil/piccolo. - */ -package edu.umd.cs.piccolo; - -import java.awt.Color; -import java.awt.Component; -import java.awt.Cursor; -import java.awt.Graphics; -import java.awt.Graphics2D; -import java.awt.event.ActionListener; -import java.awt.event.InputEvent; -import java.awt.event.KeyEvent; -import java.awt.event.KeyListener; -import java.awt.event.MouseEvent; -import java.awt.event.MouseListener; -import java.awt.event.MouseMotionListener; -import java.awt.event.MouseWheelEvent; -import java.awt.event.MouseWheelListener; - -import javax.swing.JComponent; -import javax.swing.RepaintManager; -import javax.swing.Timer; - -import edu.umd.cs.piccolo.event.PInputEventListener; -import edu.umd.cs.piccolo.event.PPanEventHandler; -import edu.umd.cs.piccolo.event.PZoomEventHandler; -import edu.umd.cs.piccolo.util.PBounds; -import edu.umd.cs.piccolo.util.PDebug; -import edu.umd.cs.piccolo.util.PPaintContext; -import edu.umd.cs.piccolo.util.PStack; -import edu.umd.cs.piccolo.util.PUtil; - -/** - * PCanvas is a simple Swing component that can be used to embed - * Piccolo into a Java Swing application. Canvases view the Piccolo scene graph - * through a camera. The canvas manages screen updates coming from this camera, - * and forwards swing mouse and keyboard events to the camera. - *

- * @version 1.0 - * @author Jesse Grosjean - */ -public class PCanvas extends JComponent implements PComponent { - - /** - * - */ - private static final long serialVersionUID = -3189990907056781407L; - - public static final String INTERATING_CHANGED_NOTIFICATION = "INTERATING_CHANGED_NOTIFICATION"; - - public static PCanvas CURRENT_ZCANVAS = null; - - private PCamera camera; - private PStack cursorStack; - private int interacting; - private int defaultRenderQuality; - private int animatingRenderQuality; - private int interactingRenderQuality; - private PPanEventHandler panEventHandler; - private PZoomEventHandler zoomEventHandler; - private boolean paintingImmediately; - private boolean animatingOnLastPaint; - private MouseListener mouseListener; - private KeyListener keyListener; - private MouseWheelListener mouseWheelListener; - private MouseMotionListener mouseMotionListener; - - /** - * Construct a canvas with the basic scene graph consisting of a - * root, camera, and layer. Event handlers for zooming and panning - * are automatically installed. - */ - public PCanvas() { - CURRENT_ZCANVAS = this; - cursorStack = new PStack(); - setCamera(createDefaultCamera()); - installInputSources(); - setDefaultRenderQuality(PPaintContext.HIGH_QUALITY_RENDERING); - setAnimatingRenderQuality(PPaintContext.LOW_QUALITY_RENDERING); - setInteractingRenderQuality(PPaintContext.LOW_QUALITY_RENDERING); - setPanEventHandler(new PPanEventHandler()); - setZoomEventHandler(new PZoomEventHandler()); - setBackground(Color.WHITE); - } - - protected PCamera createDefaultCamera() { - return PUtil.createBasicScenegraph(); - } - - //**************************************************************** - // Basic - Methods for accessing common piccolo nodes. - //**************************************************************** - - /** - * Get the pan event handler associated with this canvas. This event handler - * is set up to get events from the camera associated with this canvas by - * default. - */ - public PPanEventHandler getPanEventHandler() { - return panEventHandler; - } - - /** - * Set the pan event handler associated with this canvas. - * @param handler the new zoom event handler - */ - public void setPanEventHandler(PPanEventHandler handler) { - if(panEventHandler != null) { - removeInputEventListener(panEventHandler); - } - - panEventHandler = handler; - - if(panEventHandler != null) { - addInputEventListener(panEventHandler); - } - } - - /** - * Get the zoom event handler associated with this canvas. This event handler - * is set up to get events from the camera associated with this canvas by - * default. - */ - public PZoomEventHandler getZoomEventHandler() { - return zoomEventHandler; - } - - /** - * Set the zoom event handler associated with this canvas. - * @param handler the new zoom event handler - */ - public void setZoomEventHandler(PZoomEventHandler handler) { - if(zoomEventHandler != null) { - removeInputEventListener(zoomEventHandler); - } - - zoomEventHandler = handler; - - if(zoomEventHandler != null) { - addInputEventListener(zoomEventHandler); - } - } - - /** - * Return the camera associated with this canvas. All input events from this canvas - * go through this camera. And this is the camera that paints this canvas. - */ - public PCamera getCamera() { - return camera; - } - - /** - * Set the camera associated with this canvas. All input events from this canvas - * go through this camera. And this is the camera that paints this canvas. - */ - public void setCamera(PCamera newCamera) { - if (camera != null) { - camera.setComponent(null); - } - - camera = newCamera; - - if (camera != null) { - camera.setComponent(this); - camera.setBounds(getBounds()); - } - } - - /** - * Return root for this canvas. - */ - public PRoot getRoot() { - return camera.getRoot(); - } - - /** - * Return layer for this canvas. - */ - public PLayer getLayer() { - return camera.getLayer(0); - } - - /** - * Add an input listener to the camera associated with this canvas. - */ - public void addInputEventListener(PInputEventListener listener) { - getCamera().addInputEventListener(listener); - } - - /** - * Remove an input listener to the camera associated with this canvas. - */ - public void removeInputEventListener(PInputEventListener listener) { - getCamera().removeInputEventListener(listener); - } - - //**************************************************************** - // Painting - //**************************************************************** - - /** - * Return true if this canvas has been marked as interacting. If so - * the canvas will normally render at a lower quality that is faster. - */ - public boolean getInteracting() { - return interacting > 0; - } - - /** - * Return true if any activities that respond with true to the method - * isAnimating were run in the last PRoot.processInputs() loop. This - * values is used by this canvas to determine the render quality - * to use for the next paint. - */ - public boolean getAnimating() { - return getRoot().getActivityScheduler().getAnimating(); - } - - /** - * Set if this canvas is interacting. If so the canvas will normally - * render at a lower quality that is faster. Also repaints the canvas if the - * render quality should change. - */ - public void setInteracting(boolean isInteracting) { - boolean wasInteracting = getInteracting(); - - if (isInteracting) { - interacting++; - } else { - interacting--; - } - - if (!getInteracting()) { // determine next render quality and repaint if it's greater then the old - // interacting render quality. - int nextRenderQuality = defaultRenderQuality; - if (getAnimating()) nextRenderQuality = animatingRenderQuality; - if (nextRenderQuality > interactingRenderQuality) { - repaint(); - } - } - - isInteracting = getInteracting(); - - if (wasInteracting != isInteracting) { - firePropertyChange(INTERATING_CHANGED_NOTIFICATION, wasInteracting, isInteracting); - } - } - - /** - * Set the render quality that should be used when rendering this canvas - * when it is not interacting or animating. The default value is - * PPaintContext. HIGH_QUALITY_RENDERING. - * - * @param requestedQuality supports PPaintContext.HIGH_QUALITY_RENDERING or PPaintContext.LOW_QUALITY_RENDERING - */ - public void setDefaultRenderQuality(int requestedQuality) { - defaultRenderQuality = requestedQuality; - repaint(); - } - - /** - * Set the render quality that should be used when rendering this canvas - * when it is animating. The default value is PPaintContext.LOW_QUALITY_RENDERING. - * - * @param requestedQuality supports PPaintContext.HIGH_QUALITY_RENDERING or PPaintContext.LOW_QUALITY_RENDERING - */ - public void setAnimatingRenderQuality(int requestedQuality) { - animatingRenderQuality = requestedQuality; - if (getAnimating()) repaint(); - } - - /** - * Set the render quality that should be used when rendering this canvas - * when it is interacting. The default value is PPaintContext.LOW_QUALITY_RENDERING. - * - * @param requestedQuality supports PPaintContext.HIGH_QUALITY_RENDERING or PPaintContext.LOW_QUALITY_RENDERING - */ - public void setInteractingRenderQuality(int requestedQuality) { - interactingRenderQuality = requestedQuality; - if (getInteracting()) repaint(); - } - - /** - * Set the canvas cursor, and remember the previous cursor on the - * cursor stack. - */ - public void pushCursor(Cursor cursor) { - cursorStack.push(getCursor()); - setCursor(cursor); - } - - /** - * Pop the cursor on top of the cursorStack and set it as the - * canvas cursor. - */ - public void popCursor() { - setCursor((Cursor)cursorStack.pop()); - } - - //**************************************************************** - // Code to manage connection to Swing. There appears to be a bug in - // swing where it will occasionally send to many mouse pressed or mouse - // released events. Below we attempt to filter out those cases before - // they get delivered to the Piccolo framework. - //**************************************************************** - - private boolean isButton1Pressed; - private boolean isButton2Pressed; - private boolean isButton3Pressed; - - /** - * Overrride setEnabled to install/remove canvas input sources as needed. - */ - public void setEnabled(boolean enabled) { - super.setEnabled(enabled); - - if (isEnabled()) { - installInputSources(); - } else { - removeInputSources(); - } - } - - /** - * This method installs mouse and key listeners on the canvas that forward - * those events to piccolo. - */ - protected void installInputSources() { - if (mouseListener == null) { - mouseListener = new MouseListener() { - public void mouseClicked(MouseEvent e) { - sendInputEventToInputManager(e, MouseEvent.MOUSE_CLICKED); - } - - public void mouseEntered(MouseEvent e) { - MouseEvent simulated = null; - - if ((e.getModifiersEx() & (InputEvent.BUTTON1_MASK | InputEvent.BUTTON2_MASK | InputEvent.BUTTON3_MASK)) != 0) { - simulated = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_DRAGGED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),e.getButton()); - } else { - simulated = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_MOVED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),e.getButton()); - } - - sendInputEventToInputManager(e, MouseEvent.MOUSE_ENTERED); - sendInputEventToInputManager(simulated, simulated.getID()); - } - - public void mouseExited(MouseEvent e) { - MouseEvent simulated = null; - - if ((e.getModifiersEx() & (InputEvent.BUTTON1_MASK | InputEvent.BUTTON2_MASK | InputEvent.BUTTON3_MASK)) != 0) { - simulated = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_DRAGGED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),e.getButton()); - } else { - simulated = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_MOVED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),e.getButton()); - } - - sendInputEventToInputManager(simulated, simulated.getID()); - sendInputEventToInputManager(e, MouseEvent.MOUSE_EXITED); - } - - public void mousePressed(MouseEvent e) { - requestFocus(); - - boolean shouldBalanceEvent = false; - - if (e.getButton() == MouseEvent.NOBUTTON) { - if ((e.getModifiers() & MouseEvent.BUTTON1_MASK) == MouseEvent.BUTTON1_MASK) { - e = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_PRESSED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),MouseEvent.BUTTON1); - } - else if ((e.getModifiers() & MouseEvent.BUTTON2_MASK) == MouseEvent.BUTTON2_MASK) { - e = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_PRESSED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),MouseEvent.BUTTON2); - } - else if ((e.getModifiers() & MouseEvent.BUTTON3_MASK) == MouseEvent.BUTTON3_MASK) { - e = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_PRESSED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),MouseEvent.BUTTON3); - } - } - - switch (e.getButton()) { - case MouseEvent.BUTTON1: - if (isButton1Pressed) { - shouldBalanceEvent = true; - } - isButton1Pressed = true; - break; - - case MouseEvent.BUTTON2: - if (isButton2Pressed) { - shouldBalanceEvent = true; - } - isButton2Pressed = true; - break; - - case MouseEvent.BUTTON3: - if (isButton3Pressed) { - shouldBalanceEvent = true; - } - isButton3Pressed = true; - break; - } - - if (shouldBalanceEvent) { - MouseEvent balanceEvent = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_RELEASED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),e.getButton()); - sendInputEventToInputManager(balanceEvent, MouseEvent.MOUSE_RELEASED); - } - - sendInputEventToInputManager(e, MouseEvent.MOUSE_PRESSED); - } - - public void mouseReleased(MouseEvent e) { - boolean shouldBalanceEvent = false; - - if (e.getButton() == MouseEvent.NOBUTTON) { - if ((e.getModifiers() & MouseEvent.BUTTON1_MASK) == MouseEvent.BUTTON1_MASK) { - e = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_RELEASED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),MouseEvent.BUTTON1); - } - else if ((e.getModifiers() & MouseEvent.BUTTON2_MASK) == MouseEvent.BUTTON2_MASK) { - e = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_RELEASED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),MouseEvent.BUTTON2); - } - else if ((e.getModifiers() & MouseEvent.BUTTON3_MASK) == MouseEvent.BUTTON3_MASK) { - e = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_RELEASED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),MouseEvent.BUTTON3); - } - } - - switch (e.getButton()) { - case MouseEvent.BUTTON1: - if (!isButton1Pressed) { - shouldBalanceEvent = true; - } - isButton1Pressed = false; - break; - - case MouseEvent.BUTTON2: - if (!isButton2Pressed) { - shouldBalanceEvent = true; - } - isButton2Pressed = false; - break; - - case MouseEvent.BUTTON3: - if (!isButton3Pressed) { - shouldBalanceEvent = true; - } - isButton3Pressed = false; - break; - } - - if (shouldBalanceEvent) { - MouseEvent balanceEvent = new MouseEvent((Component)e.getSource(),MouseEvent.MOUSE_PRESSED,e.getWhen(),e.getModifiers(),e.getX(),e.getY(),e.getClickCount(),e.isPopupTrigger(),e.getButton()); - sendInputEventToInputManager(balanceEvent, MouseEvent.MOUSE_PRESSED); - } - - sendInputEventToInputManager(e, MouseEvent.MOUSE_RELEASED); - } - }; - addMouseListener(mouseListener); - } - - if (mouseMotionListener == null) { - mouseMotionListener = new MouseMotionListener() { - public void mouseDragged(MouseEvent e) { - sendInputEventToInputManager(e, MouseEvent.MOUSE_DRAGGED); - } - public void mouseMoved(MouseEvent e) { - sendInputEventToInputManager(e, MouseEvent.MOUSE_MOVED); - } - }; - addMouseMotionListener(mouseMotionListener); - } - - if (mouseWheelListener == null) { - mouseWheelListener = new MouseWheelListener() { - public void mouseWheelMoved(MouseWheelEvent e) { - sendInputEventToInputManager(e, e.getScrollType()); - if (!e.isConsumed() && getParent() != null) { - getParent().dispatchEvent(e); - } - } - }; - addMouseWheelListener(mouseWheelListener); - } - - if (keyListener == null) { - keyListener = new KeyListener() { - public void keyPressed(KeyEvent e) { - sendInputEventToInputManager(e, KeyEvent.KEY_PRESSED); - } - public void keyReleased(KeyEvent e) { - sendInputEventToInputManager(e, KeyEvent.KEY_RELEASED); - } - public void keyTyped(KeyEvent e) { - sendInputEventToInputManager(e, KeyEvent.KEY_TYPED); - } - }; - addKeyListener(keyListener); - } - } - - /** - * This method removes mouse and key listeners on the canvas that forward - * those events to piccolo. - */ - protected void removeInputSources() { - if (mouseListener != null) removeMouseListener(mouseListener); - if (mouseMotionListener != null) removeMouseMotionListener(mouseMotionListener); - if (mouseWheelListener != null) removeMouseWheelListener(mouseWheelListener); - if (keyListener != null) removeKeyListener(keyListener); - - mouseListener = null; - mouseMotionListener = null; - mouseWheelListener = null; - keyListener = null; - } - - protected void sendInputEventToInputManager(InputEvent e, int type) { - getRoot().getDefaultInputManager().processEventFromCamera(e, type, getCamera()); - } - - public void setBounds(int x, int y, final int w, final int h) { - camera.setBounds(camera.getX(), camera.getY(), w, h); - super.setBounds(x, y, w, h); - } - - public void repaint(PBounds bounds) { - PDebug.processRepaint(); - - bounds.expandNearestIntegerDimensions(); - bounds.inset(-1, -1); - - repaint((int)bounds.x, - (int)bounds.y, - (int)bounds.width, - (int)bounds.height); - } - - public void paintComponent(Graphics g) { - PDebug.startProcessingOutput(); - - Graphics2D g2 = (Graphics2D) g.create(); - g2.setColor(getBackground()); - g2.fillRect(0, 0, getWidth(), getHeight()); - - // create new paint context and set render quality to lowest common - // denominator render quality. - PPaintContext paintContext = new PPaintContext(g2); - if (getInteracting() || getAnimating()) { - if (interactingRenderQuality < animatingRenderQuality) { - paintContext.setRenderQuality(interactingRenderQuality); - } else { - paintContext.setRenderQuality(animatingRenderQuality); - } - } else { - paintContext.setRenderQuality(defaultRenderQuality); - } - - // paint piccolo - camera.fullPaint(paintContext); - - // if switched state from animating to not animating invalidate the entire - // screen so that it will be drawn with the default instead of animating - // render quality. - if (!getAnimating() && animatingOnLastPaint) { - repaint(); - } - animatingOnLastPaint = getAnimating(); - - PDebug.endProcessingOutput(g2); - } - - public void paintImmediately() { - if (paintingImmediately) { - return; - } - - paintingImmediately = true; - RepaintManager.currentManager(this).paintDirtyRegions(); - paintingImmediately = false; - } - - public Timer createTimer(int delay, ActionListener listener) { - return new Timer(delay,listener); - } -} \ No newline at end of file diff --git a/src/main/java/edu/umd/cs/piccolo/PComponent.java b/src/main/java/edu/umd/cs/piccolo/PComponent.java deleted file mode 100755 index 45a1780..0000000 --- a/src/main/java/edu/umd/cs/piccolo/PComponent.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Copyright (c) 2002-@year@, University of Maryland - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, are permitted provided - * that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions - * and the following disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the University of Maryland nor the names of its contributors may be used to - * endorse or promote products derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR - * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Piccolo was written at the Human-Computer Interaction Laboratory www.cs.umd.edu/hcil by Jesse Grosjean - * under the supervision of Ben Bederson. The Piccolo website is www.cs.umd.edu/hcil/piccolo. - */ -package edu.umd.cs.piccolo; - -import java.awt.Cursor; - -import edu.umd.cs.piccolo.util.PBounds; - -/** - * Interface that a component needs to implement if it wants to act as a Piccolo - * canvas. - * - * @version 1.0 - * @author Lance Good - */ -public interface PComponent { - - public void repaint(PBounds bounds); - - public void paintImmediately(); - - public void pushCursor(Cursor cursor); - - public void popCursor(); - - public void setInteracting(boolean interacting); -} diff --git a/src/main/java/edu/umd/cs/piccolo/PInputManager.java b/src/main/java/edu/umd/cs/piccolo/PInputManager.java deleted file mode 100755 index b810cb6..0000000 --- a/src/main/java/edu/umd/cs/piccolo/PInputManager.java +++ /dev/null @@ -1,279 +0,0 @@ -/* - * Copyright (c) 2002-@year@, University of Maryland - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, are permitted provided - * that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions - * and the following disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the University of Maryland nor the names of its contributors may be used to - * endorse or promote products derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR - * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Piccolo was written at the Human-Computer Interaction Laboratory www.cs.umd.edu/hcil by Jesse Grosjean - * under the supervision of Ben Bederson. The Piccolo website is www.cs.umd.edu/hcil/piccolo. - */ -package edu.umd.cs.piccolo; - -import java.awt.event.FocusEvent; -import java.awt.event.InputEvent; -import java.awt.event.KeyEvent; -import java.awt.event.MouseEvent; -import java.awt.event.MouseWheelEvent; -import java.awt.geom.Point2D; - -import edu.umd.cs.piccolo.event.PBasicInputEventHandler; -import edu.umd.cs.piccolo.event.PInputEvent; -import edu.umd.cs.piccolo.event.PInputEventListener; -import edu.umd.cs.piccolo.util.PPickPath; - -/** - * PInputManager is responsible for dispatching PInputEvents - * to node's event listeners. Events are dispatched from PRoot's processInputs - * method. - *

- * @see edu.umd.cs.piccolo.event.PInputEvent - * @see PRoot - * @version 1.0 - * @author Jesse Grosjean - */ -public class PInputManager extends PBasicInputEventHandler implements PRoot.InputSource { - - private Point2D lastCanvasPosition; - private Point2D currentCanvasPosition; - - private InputEvent nextInput; - private int nextType; - private PCamera nextInputSource; - - private PPickPath mouseFocus; - private PPickPath previousMouseFocus; - private PPickPath mouseOver; - private PPickPath previousMouseOver; - private PInputEventListener keyboardFocus; - - private int pressedCount; - - public PInputManager() { - super(); - lastCanvasPosition = new Point2D.Double(); - currentCanvasPosition = new Point2D.Double(); - } - - //**************************************************************** - // Basic - //**************************************************************** - - /** - * Return the node that currently has the keyboard focus. This node - * receives the key events. - */ - public PInputEventListener getKeyboardFocus() { - return keyboardFocus; - } - - /** - * Set the node that should recive key events. - */ - public void setKeyboardFocus(PInputEventListener eventHandler) { - PInputEvent focusEvent = new PInputEvent(this, null); - - if (keyboardFocus != null) { - dispatchEventToListener(focusEvent, FocusEvent.FOCUS_LOST, keyboardFocus); - } - - keyboardFocus = eventHandler; - - if (keyboardFocus != null) { - dispatchEventToListener(focusEvent, FocusEvent.FOCUS_GAINED, keyboardFocus); - } - } - - /** - * Return the node that currently has the mouse focus. This will return - * the node that received the current mouse pressed event, or null if the - * mouse is not pressed. The mouse focus gets mouse dragged events even - * what the mouse is not over the mouse focus. - */ - public PPickPath getMouseFocus() { - return mouseFocus; - } - - public void setMouseFocus(PPickPath path) { - previousMouseFocus = mouseFocus; - mouseFocus = path; - } - - /** - * Return the node the the mouse is currently over. - */ - public PPickPath getMouseOver() { - return mouseOver; - } - - public void setMouseOver(PPickPath path) { - mouseOver = path; - } - - public Point2D getLastCanvasPosition() { - return lastCanvasPosition; - } - - public Point2D getCurrentCanvasPosition() { - return currentCanvasPosition; - } - - //**************************************************************** - // Event Handling - Methods for handling events - // - // The dispatch manager updates the focus nodes based on the - // incoming events, and dispatches those events to the appropriate - // focus nodes. - //**************************************************************** - - public void keyPressed(PInputEvent event) { - dispatchEventToListener(event, KeyEvent.KEY_PRESSED, keyboardFocus); - } - - public void keyReleased(PInputEvent event) { - dispatchEventToListener(event, KeyEvent.KEY_RELEASED, keyboardFocus); - } - - public void keyTyped(PInputEvent event) { - dispatchEventToListener(event, KeyEvent.KEY_TYPED, keyboardFocus); - } - - public void mouseClicked(PInputEvent event) { - dispatchEventToListener(event, MouseEvent.MOUSE_CLICKED, previousMouseFocus); - } - - public void mouseWheelRotated(PInputEvent event) { - setMouseFocus(getMouseOver()); - dispatchEventToListener(event, MouseWheelEvent.WHEEL_UNIT_SCROLL, mouseOver); - } - - public void mouseWheelRotatedByBlock(PInputEvent event) { - setMouseFocus(getMouseOver()); - dispatchEventToListener(event, MouseWheelEvent.WHEEL_BLOCK_SCROLL, mouseOver); - } - - public void mouseDragged(PInputEvent event) { - checkForMouseEnteredAndExited(event); - dispatchEventToListener(event, MouseEvent.MOUSE_DRAGGED, mouseFocus); - } - - public void mouseEntered(PInputEvent event) { - dispatchEventToListener(event, MouseEvent.MOUSE_ENTERED, mouseOver); - } - - public void mouseExited(PInputEvent event) { - dispatchEventToListener(event, MouseEvent.MOUSE_EXITED, previousMouseOver); - } - - public void mouseMoved(PInputEvent event) { - checkForMouseEnteredAndExited(event); - dispatchEventToListener(event, MouseEvent.MOUSE_MOVED, mouseOver); - } - - public void mousePressed(PInputEvent event) { - if (pressedCount == 0) { - setMouseFocus(getMouseOver()); - } - pressedCount++; - dispatchEventToListener(event, MouseEvent.MOUSE_PRESSED, mouseFocus); - if (pressedCount < 1 || pressedCount > 3) System.err.println("invalid pressedCount on mouse pressed: " + pressedCount); - } - - public void mouseReleased(PInputEvent event) { - pressedCount--; - checkForMouseEnteredAndExited(event); - dispatchEventToListener(event, MouseEvent.MOUSE_RELEASED, mouseFocus); - if (pressedCount == 0) { - setMouseFocus(null); - } - if (pressedCount < 0 || pressedCount > 2) System.err.println("invalid pressedCount on mouse released: " + pressedCount); - } - - protected void checkForMouseEnteredAndExited(PInputEvent event) { - PNode c = (mouseOver != null) ? mouseOver.getPickedNode() : null; - PNode p = (previousMouseOver != null) ? previousMouseOver.getPickedNode() : null; - - if (c != p) { - dispatchEventToListener(event, MouseEvent.MOUSE_EXITED, previousMouseOver); - dispatchEventToListener(event, MouseEvent.MOUSE_ENTERED, mouseOver); - previousMouseOver = mouseOver; - } - } - - //**************************************************************** - // Event Dispatch. - //**************************************************************** - - public void processInput() { - if (nextInput == null) return; - - PInputEvent e = new PInputEvent(this, nextInput); - - Point2D newCurrentCanvasPosition = null; - Point2D newLastCanvasPosition = null; - - if (e.isMouseEvent()) { - if (e.isMouseEnteredOrMouseExited()) { - PPickPath aPickPath = nextInputSource.pick(((MouseEvent)nextInput).getX(), ((MouseEvent)nextInput).getY(), 1); - setMouseOver(aPickPath); - previousMouseOver = aPickPath; - newCurrentCanvasPosition = (Point2D) currentCanvasPosition.clone(); - newLastCanvasPosition = (Point2D) lastCanvasPosition.clone(); - } else { - lastCanvasPosition.setLocation(currentCanvasPosition); - currentCanvasPosition.setLocation(((MouseEvent)nextInput).getX(), ((MouseEvent)nextInput).getY()); - PPickPath aPickPath = nextInputSource.pick(currentCanvasPosition.getX(), currentCanvasPosition.getY(), 1); - setMouseOver(aPickPath); - } - } - - nextInput = null; - nextInputSource = null; - - this.processEvent(e, nextType); - - if (newCurrentCanvasPosition != null && newLastCanvasPosition != null) { - currentCanvasPosition.setLocation(newCurrentCanvasPosition); - lastCanvasPosition.setLocation(newLastCanvasPosition); - } - } - - public void processEventFromCamera(InputEvent event, int type, PCamera camera) { - // queue input - nextInput = event; - nextType = type; - nextInputSource = camera; - - // tell root to process queued inputs - camera.getRoot().processInputs(); - } - - private void dispatchEventToListener(PInputEvent event, int type, PInputEventListener listener) { - if (listener != null) { - // clear the handled bit since the same event object is used to send multiple events such as - // mouseEntered/mouseExited and mouseMove. - event.setHandled(false); - listener.processEvent(event, type); - } - } -} - diff --git a/src/main/java/edu/umd/cs/piccolo/PLayer.java b/src/main/java/edu/umd/cs/piccolo/PLayer.java deleted file mode 100755 index 33dfbe4..0000000 --- a/src/main/java/edu/umd/cs/piccolo/PLayer.java +++ /dev/null @@ -1,212 +0,0 @@ -/* - * Copyright (c) 2002-@year@, University of Maryland - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, are permitted provided - * that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions - * and the following disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the University of Maryland nor the names of its contributors may be used to - * endorse or promote products derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR - * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Piccolo was written at the Human-Computer Interaction Laboratory www.cs.umd.edu/hcil by Jesse Grosjean - * under the supervision of Ben Bederson. The Piccolo website is www.cs.umd.edu/hcil/piccolo. - */ -package edu.umd.cs.piccolo; - -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.util.ArrayList; -import java.util.List; - -import edu.umd.cs.piccolo.util.PBounds; -import edu.umd.cs.piccolo.util.PObjectOutputStream; - -/** - * PLayer is a node that can be viewed directly by multiple camera nodes. - * Generally child nodes are added to a layer to give the viewing cameras - * something to look at. - *

- * A single layer node may be viewed through multiple cameras with each - * camera using its own view transform. This means that any node (since layers can have - * children) may be visible through multiple cameras at the same time. - *

- * @see PCamera - * @see edu.umd.cs.piccolo.event.PInputEvent - * @see edu.umd.cs.piccolo.util.PPickPath - * @version 1.0 - * @author Jesse Grosjean - */ -public class PLayer extends PNode { - - /** - * - */ - private static final long serialVersionUID = 3135722599250436769L; - /** - * The property name that identifies a change in the set of this layer's - * cameras (see {@link #getCamera getCamera}, {@link #getCameraCount - * getCameraCount}, {@link #getCamerasReference getCamerasReference}). In - * any property change event the new value will be a reference to the list - * of cameras, but old value will always be null. - */ - public static final String PROPERTY_CAMERAS = "cameras"; - public static final int PROPERTY_CODE_CAMERAS = 1 << 13; - - private transient List cameras; - - public PLayer() { - super(); - cameras = new ArrayList(); - } - - //**************************************************************** - // Cameras - Maintain the list of cameras that are viewing this - // layer. - //**************************************************************** - - /** - * Get the list of cameras viewing this layer. - */ - public List getCamerasReference() { - return cameras; - } - - /** - * Get the number of cameras viewing this layer. - */ - public int getCameraCount() { - if (cameras == null) { - return 0; - } - return cameras.size(); - } - - /** - * Get the camera in this layer's camera list at the specified index. - */ - public PCamera getCamera(int index) { - return (PCamera) cameras.get(index); - } - - /** - * Add a camera to this layer's camera list. This method it called automatically - * when a layer is added to a camera. - */ - public void addCamera(PCamera camera) { - addCamera(cameras.size(), camera); - } - - /** - * Add a camera to this layer's camera list at the specified index. This - * method it called automatically when a layer is added to a camera. - */ - public void addCamera(int index, PCamera camera) { - cameras.add(index, camera); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_CAMERAS, PROPERTY_CAMERAS, null, cameras); - } - - /** - * Remove the camera from this layer's camera list. - */ - public PCamera removeCamera(PCamera camera) { - return removeCamera(cameras.indexOf(camera)); - } - - /** - * Remove the camera at the given index from this layer's camera list. - */ - public PCamera removeCamera(int index) { - PCamera result = (PCamera) cameras.remove(index); - invalidatePaint(); - firePropertyChange(PROPERTY_CODE_CAMERAS, PROPERTY_CAMERAS, null, cameras); - return result; - } - - //**************************************************************** - // Camera Repaint Notifications - Layer nodes must forward their - // repaints to each camera that is viewing them so that the camera - // views will also get repainted. - //**************************************************************** - - /** - * Override repaints and forward them to the cameras that are - * viewing this layer. - */ - public void repaintFrom(PBounds localBounds, PNode childOrThis) { - if (childOrThis != this) { - localToParent(localBounds); - } - - notifyCameras(localBounds); - - if (getParent() != null) { - getParent().repaintFrom(localBounds, childOrThis); - } - } - - protected void notifyCameras(PBounds parentBounds) { - int count = getCameraCount(); - for (int i = 0; i < count; i++) { - PCamera each = (PCamera) cameras.get(i); - each.repaintFromLayer(parentBounds, this); - } - } - - //**************************************************************** - // Serialization - Layers conditionally serialize their cameras. - // This means that only the camera references that were unconditionally - // (using writeObject) serialized by someone else will be restored - // when the layer is unserialized. - //**************************************************************** - - /** - * Write this layer and all its children out to the given stream. Note - * that the layer writes out any cameras that are viewing it conditionally, so they will only - * get written out if someone else writes them unconditionally. - */ - private void writeObject(ObjectOutputStream out) throws IOException { - out.defaultWriteObject(); - - int count = getCameraCount(); - for (int i = 0; i < count; i++) { - ((PObjectOutputStream)out).writeConditionalObject(cameras.get(i)); - } - - out.writeObject(Boolean.FALSE); - } - - private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { - in.defaultReadObject(); - - cameras = new ArrayList(); - - while (true) { - Object each = in.readObject(); - if (each != null) { - if (each.equals(Boolean.FALSE)) { - break; - } else { - cameras.add((PCamera)each); - } - } - } - } -} diff --git a/src/main/java/edu/umd/cs/piccolo/PNode.java b/src/main/java/edu/umd/cs/piccolo/PNode.java deleted file mode 100755 index 78e9e70..0000000 --- a/src/main/java/edu/umd/cs/piccolo/PNode.java +++ /dev/null @@ -1,3084 +0,0 @@ -/* - * Copyright (c) 2002-@year@, University of Maryland - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, are permitted provided - * that the following conditions are met: - * - * Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. - * - * Redistributions in binary form must reproduce the above copyright notice, this list of conditions - * and the following disclaimer in the documentation and/or other materials provided with the - * distribution. - * - * Neither the name of the University of Maryland nor the names of its contributors may be used to - * endorse or promote products derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A - * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR - * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR - * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - * - * Piccolo was written at the Human-Computer Interaction Laboratory www.cs.umd.edu/hcil by Jesse Grosjean - * under the supervision of Ben Bederson. The Piccolo website is www.cs.umd.edu/hcil/piccolo. - */ - -package edu.umd.cs.piccolo; - -import java.awt.Color; -import java.awt.Graphics; -import java.awt.Graphics2D; -import java.awt.GraphicsConfiguration; -import java.awt.GraphicsEnvironment; -import java.awt.Image; -import java.awt.Paint; -import java.awt.Transparency; -import java.awt.geom.AffineTransform; -import java.awt.geom.Dimension2D; -import java.awt.geom.NoninvertibleTransformException; -import java.awt.geom.Point2D; -import java.awt.geom.Rectangle2D; -import java.awt.image.BufferedImage; -import java.awt.print.Book; -import java.awt.print.PageFormat; -import java.awt.print.Paper; -import java.awt.print.Printable; -import java.awt.print.PrinterJob; -import java.beans.PropertyChangeEvent; -import java.beans.PropertyChangeListener; -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.io.Serializable; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.Enumeration; -import java.util.Iterator; -import java.util.List; -import java.util.ListIterator; - -import javax.swing.event.EventListenerList; -import javax.swing.event.SwingPropertyChangeSupport; -import javax.swing.text.MutableAttributeSet; -import javax.swing.text.SimpleAttributeSet; - -import edu.umd.cs.piccolo.activities.PActivity; -import edu.umd.cs.piccolo.activities.PColorActivity; -import edu.umd.cs.piccolo.activities.PInterpolatingActivity; -import edu.umd.cs.piccolo.activities.PTransformActivity; -import edu.umd.cs.piccolo.event.PInputEventListener; -import edu.umd.cs.piccolo.util.PAffineTransform; -import edu.umd.cs.piccolo.util.PBounds; -import edu.umd.cs.piccolo.util.PNodeFilter; -import edu.umd.cs.piccolo.util.PObjectOutputStream; -import edu.umd.cs.piccolo.util.PPaintContext; -import edu.umd.cs.piccolo.util.PPickPath; -import edu.umd.cs.piccolo.util.PUtil; - -/** - * PNode is the central abstraction in Piccolo. All objects that are - * visible on the screen are instances of the node class. All nodes may have - * other "child" nodes added to them. - *

- * See edu.umd.piccolo.examples.NodeExample.java for demonstrations of how nodes - * can be used and how new types of nodes can be created. - *

- * @version 1.0 - * @author Jesse Grosjean - */ -public class PNode implements Cloneable, Serializable, Printable { - private static final long serialVersionUID = -5710973444775892582L; -//ORIG private static final long serialVersionUID = -5737613834659240286L; - /** - * The property name that identifies a change in this node's client - * propertie (see {@link #getClientProperty getClientProperty}). In - * an property change event the new value will be a reference to the map of - * client properties but old value will always be null. - */ - public static final String PROPERTY_CLIENT_PROPERTIES = "clientProperties"; - public static final int PROPERTY_CODE_CLIENT_PROPERTIES = 1 << 0; - - /** - * The property name that identifies a change of this node's bounds (see - * {@link #getBounds getBounds}, {@link #getBoundsReference - * getBoundsReference}). In any property change event the new value will be - * a reference to this node's bounds, but old value will always be null. - */ - public static final String PROPERTY_BOUNDS = "bounds"; - public static final int PROPERTY_CODE_BOUNDS = 1 << 1; - - /** - * The property name that identifies a change of this node's full bounds - * (see {@link #getFullBounds getFullBounds}, {@link #getFullBoundsReference - * getFullBoundsReference}). In any property change event the new value will - * be a reference to this node's full bounds cache, but old value will - * always be null. - */ - public static final String PROPERTY_FULL_BOUNDS = "fullBounds"; - public static final int PROPERTY_CODE_FULL_BOUNDS = 1 << 2; - - /** - * The property name that identifies a change of this node's transform (see - * {@link #getTransform getTransform}, {@link #getTransformReference - * getTransformReference}). In any property change event the new value will - * be a reference to this node's transform, but old value will always be - * null. - */ - public static final String PROPERTY_TRANSFORM = "transform"; - public static final int PROPERTY_CODE_TRANSFORM = 1 << 3; - - /** - * The property name that identifies a change of this node's visibility (see - * {@link #getVisible getVisible}). Both old value and new value will be - * null in any property change event. - */ - public static final String PROPERTY_VISIBLE = "visible"; - public static final int PROPERTY_CODE_VISIBLE = 1 << 4; - - /** - * The property name that identifies a change of this node's paint (see - * {@link #getPaint getPaint}). Both old value and new value will be set - * correctly in any property change event. - */ - public static final String PROPERTY_PAINT = "paint"; - public static final int PROPERTY_CODE_PAINT = 1 << 5; - - /** - * The property name that identifies a change of this node's transparency - * (see {@link #getTransparency getTransparency}). Both old value and new - * value will be null in any property change event. - */ - public static final String PROPERTY_TRANSPARENCY = "transparency"; - public static final int PROPERTY_CODE_TRANSPARENCY = 1 << 6; - - /** - * The property name that identifies a change of this node's pickable status - * (see {@link #getPickable getPickable}). Both old value and new value will - * be null in any property change event. - */ - public static final String PROPERTY_PICKABLE = "pickable"; - public static final int PROPERTY_CODE_PICKABLE = 1 << 7; - - /** - * The property name that identifies a change of this node's children - * pickable status (see {@link #getChildrenPickable getChildrenPickable}). - * Both old value and new value will be null in any property change event. - */ - public static final String PROPERTY_CHILDREN_PICKABLE = "childrenPickable"; - public static final int PROPERTY_CODE_CHILDREN_PICKABLE = 1 << 8; - - /** - * The property name that identifies a change in the set of this node's direct children - * (see {@link #getChildrenReference getChildrenReference}, {@link #getChildrenIterator getChildrenIterator}). - * In any property change event the new value will be a reference to this node's children, - * but old value will always be null. */ - public static final String PROPERTY_CHILDREN = "children"; - public static final int PROPERTY_CODE_CHILDREN = 1 << 9; - - /** - * The property name that identifies a change of this node's parent - * (see {@link #getParent getParent}). - * Both old value and new value will be set correctly in any property change event. - */ - public static final String PROPERTY_PARENT = "parent"; - public static final int PROPERTY_CODE_PARENT = 1 << 10; - - private static final PBounds TEMP_REPAINT_BOUNDS = new PBounds(); - - /** - * The single scene graph delegate that recives low level node events. - */ - public static PSceneGraphDelegate SCENE_GRAPH_DELEGATE = null; - - /** - * PSceneGraphDelegate is an interface to recive low level node events. It together - * with PNode.SCENE_GRAPH_DELEGATE gives Piccolo users an efficient way to learn about - * low level changes in Piccolo's scene graph. Most users will not need to use this. - */ - public interface PSceneGraphDelegate { - public void nodePaintInvalidated(PNode node); - public void nodeFullBoundsInvalidated(PNode node); - } - - private transient PNode parent; - private List children; - private PBounds bounds; - private PAffineTransform transform; - private Paint paint; - private float transparency; - private MutableAttributeSet clientProperties; - private PBounds fullBoundsCache; - - private int propertyChangeParentMask = 0; - private transient SwingPropertyChangeSupport changeSupport; - private transient EventListenerList listenerList; - - private boolean pickable; - private boolean childrenPickable; - private boolean visible; - private boolean childBoundsVolatile; - private boolean paintInvalid; - private boolean childPaintInvalid; - private boolean boundsChanged; - private boolean fullBoundsInvalid; - private boolean childBoundsInvalid; - private boolean occluded; - - /** - * Constructs a new PNode. - *

- * By default a node's paint is null, and bounds are empty. These values - * must be set for the node to show up on the screen once it's added to - * a scene graph. - */ - public PNode() { - bounds = new PBounds(); - fullBoundsCache = new PBounds(); - transparency = 1.0f; - pickable = true; - childrenPickable = true; - visible = true; - } - - //**************************************************************** - // Animation - Methods to animate this node. - // - // Note that animation is implemented by activities (PActivity), - // so if you need more control over your animation look at the - // activities package. Each animate method creates an animation that - // will animate the node from its current state to the new state - // specified over the given duration. These methods will try to - // automatically schedule the new activity, but if the node does not - // descend from the root node when the method is called then the - // activity will not be scheduled and you must schedule it manually. - //**************************************************************** - - /** - * Animate this node's bounds from their current location when the activity - * starts to the specified bounds. If this node descends from the root then - * the activity will be scheduled, else the returned activity should be - * scheduled manually. If two different transform activities are scheduled - * for the same node at the same time, they will both be applied to the - * node, but the last one scheduled will be applied last on each frame, so - * it will appear to have replaced the original. Generally you will not want - * to do that. Note this method animates the node's bounds, but does not change - * the node's transform. Use animateTransformToBounds() to animate the node's - * transform instead. - * - * @param duration amount of time that the animation should take - * @return the newly scheduled activity - */ - public PInterpolatingActivity animateToBounds(double x, double y, double width, double height, long duration) { - if (duration == 0) { - setBounds(x, y, width, height); - return null; - } else { - final PBounds dst = new PBounds(x, y, width, height); - - PInterpolatingActivity ta = new PInterpolatingActivity(duration, PUtil.DEFAULT_ACTIVITY_STEP_RATE) { - private PBounds src; - - protected void activityStarted() { - src = getBounds(); - startResizeBounds(); - super.activityStarted(); - } - - public void setRelativeTargetValue(float zeroToOne) { - PNode.this.setBounds(src.x + (zeroToOne * (dst.x - src.x)), - src.y + (zeroToOne * (dst.y - src.y)), - src.width + (zeroToOne * (dst.width - src.width)), - src.height + (zeroToOne * (dst.height - src.height))); - } - - protected void activityFinished() { - super.activityFinished(); - endResizeBounds(); - } - }; - - addActivity(ta); - return ta; - } - } - - /** - * Animate this node from it's current transform when the activity starts - * a new transform that will fit the node into the given bounds. If this - * node descends from the root then the activity will be scheduled, else - * the returned activity should be scheduled manually. If two different - * transform activities are scheduled for the same node at the same time, - * they will both be applied to the node, but the last one scheduled will be - * applied last on each frame, so it will appear to have replaced the original. - * Generally you will not want to do that. Note this method animates the node's - * transform, but does not directly change the node's bounds rectangle. Use - * animateToBounds() to animate the node's bounds rectangle instead. - * - * @param duration amount of time that the animation should take - * @return the newly scheduled activity - */ - public PTransformActivity animateTransformToBounds(double x, double y, double width, double height, long duration) { - PAffineTransform t = new PAffineTransform(); - t.setToScale(width / getWidth(), height / getHeight()); - double scale = t.getScale(); - t.setOffset(x - (getX() * scale), y - (getY() * scale)); - return animateToTransform(t, duration); - } - - /** - * Animate this node's transform from its current location when the - * activity starts to the specified location, scale, and rotation. If this - * node descends from the root then the activity will be scheduled, else the - * returned activity should be scheduled manually. If two different - * transform activities are scheduled for the same node at the same time, - * they will both be applied to the node, but the last one scheduled will be - * applied last on each frame, so it will appear to have replaced the - * original. Generally you will not want to do that. - * - * @param duration amount of time that the animation should take - * @param theta final theta value (in radians) for the animation - * @return the newly scheduled activity - */ - public PTransformActivity animateToPositionScaleRotation(double x, double y, double scale, double theta, long duration) { - PAffineTransform t = getTransform(); - t.setOffset(x, y); - t.setScale(scale); - t.setRotation(theta); - return animateToTransform(t, duration); - } - - /** - * Animate this node's transform from its current values when the activity - * starts to the new values specified in the given transform. If this node - * descends from the root then the activity will be scheduled, else the - * returned activity should be scheduled manually. If two different - * transform activities are scheduled for the same node at the same time, - * they will both be applied to the node, but the last one scheduled will be - * applied last on each frame, so it will appear to have replaced the - * original. Generally you will not want to do that. - * - * @param destTransform the final transform value - * @param duration amount of time that the animation should take - * @return the newly scheduled activity - */ - public PTransformActivity animateToTransform(AffineTransform destTransform, long duration) { - if (duration == 0) { - setTransform(destTransform); - return null; - } else { - PTransformActivity.Target t = new PTransformActivity.Target() { - public void setTransform(AffineTransform aTransform) { - PNode.this.setTransform(aTransform); - } - public void getSourceMatrix(double[] aSource) { - PNode.this.getTransformReference(true).getMatrix(aSource); - } - }; - - PTransformActivity ta = new PTransformActivity(duration, PUtil.DEFAULT_ACTIVITY_STEP_RATE, t, destTransform); - addActivity(ta); - return ta; - } - } - - /** - * Animate this node's color from its current value to the new value - * specified. This meathod assumes that this nodes paint property is of - * type color. If this node descends from the root then the activity will be - * scheduled, else the returned activity should be scheduled manually. If - * two different color activities are scheduled for the same node at the - * same time, they will both be applied to the node, but the last one - * scheduled will be applied last on each frame, so it will appear to have - * replaced the original. Generally you will not want to do that. - * - * @param destColor final color value. - * @param duration amount of time that the animation should take - * @return the newly scheduled activity - */ - public PInterpolatingActivity animateToColor(Color destColor, long duration) { - if (duration == 0) { - setPaint(destColor); - return null; - } else { - PColorActivity.Target t = new PColorActivity.Target() { - public Color getColor() { - return (Color) getPaint(); - } - public void setColor(Color color) { - setPaint(color); - } - }; - - PColorActivity ca = new PColorActivity(duration, PUtil.DEFAULT_ACTIVITY_STEP_RATE, t, destColor); - addActivity(ca); - return ca; - } - } - - /** - * Animate this node's transparency from its current value to the - * new value specified. Transparency values must range from zero to one. - * If this node descends from the root then the activity will be - * scheduled, else the returned activity should be scheduled manually. - * If two different transparency activities are scheduled for the same - * node at the same time, they will both be applied to the node, but the - * last one scheduled will be applied last on each frame, so it will appear - * to have replaced the original. Generally you will not want to do that. - * - * @param zeroToOne final transparency value. - * @param duration amount of time that the animation should take - * @return the newly scheduled activity - */ - public PInterpolatingActivity animateToTransparency(float zeroToOne, long duration) { - if (duration == 0) { - setTransparency(zeroToOne); - return null; - } else { - final float dest = zeroToOne; - - PInterpolatingActivity ta = new PInterpolatingActivity(duration, PUtil.DEFAULT_ACTIVITY_STEP_RATE) { - private float source; - - protected void activityStarted() { - source = getTransparency(); - super.activityStarted(); - } - - public void setRelativeTargetValue(float zeroToOne) { - PNode.this.setTransparency(source + (zeroToOne * (dest - source))); - } - }; - - addActivity(ta); - return ta; - } - } - - /** - * Schedule the given activity with the root, note that only scheduled - * activities will be stepped. If the activity is successfully added true is - * returned, else false. - * - * @param activity new activity to schedule - * @return true if the activity is successfully scheduled. - */ - public boolean addActivity(PActivity activity) { - PRoot r = getRoot(); - if (r != null) { - return r.addActivity(activity); - } - return false; - } - - // **************************************************************** - // Client Properties - Methods for managing client properties for - // this node. - // - // Client properties provide a way for programmers to attach - // extra information to a node without having to subclass it and - // add new instance variables. - //**************************************************************** - - /** - * Return mutable attributed set of client properites associated with - * this node. - */ - public MutableAttributeSet getClientProperties() { - if (clientProperties == null) { - clientProperties = new SimpleAttributeSet(); - } - return clientProperties; - } - - /** - * Returns the value of the client attribute with the specified key. Only - * attributes added with addAttribute will return - * a non-null value. - * - * @return the value of this attribute or null - */ - public Object getAttribute(Object key) { - if (clientProperties == null || key == null) { - return null; - } else { - return clientProperties.getAttribute(key); - } - } - - /** - * Add an arbitrary key/value to this node. - *

- * The get/add attribute methods provide access to - * a small per-instance attribute set. Callers can use get/add attribute - * to annotate nodes that were created by another module. - *

- * If value is null this method will remove the attribute. - */ - public void addAttribute(Object key, Object value) { - if (value == null && clientProperties == null) return; - - Object oldValue = getAttribute(key); - - if (value != oldValue) { - if (clientProperties == null) { - clientProperties = new SimpleAttributeSet(); - } - - if (value == null) { - clientProperties.removeAttribute(key); - } else { - clientProperties.addAttribute(key, value); - } - - if (clientProperties.getAttributeCount() == 0 && clientProperties.getResolveParent() == null) { - clientProperties = null; - } - - firePropertyChange(PROPERTY_CODE_CLIENT_PROPERTIES, PROPERTY_CLIENT_PROPERTIES, null, clientProperties); - firePropertyChange(PROPERTY_CODE_CLIENT_PROPERTIES, key.toString(), oldValue, value); - } - } - - /** - * Returns an enumeration of all keys maped to attribute values values. - * - * @return an Enumeration over attribute keys - */ - public Enumeration getClientPropertyKeysEnumeration() { - if (clientProperties == null) { - return PUtil.NULL_ENUMERATION; - } else { - return clientProperties.getAttributeNames(); - } - } - - // convenience methods for attributes - - public Object getAttribute(Object key, Object def) { - Object o = getAttribute(key); - return (o == null ? def : o); - } - - public boolean getBooleanAttribute(Object key, boolean def) { - Boolean b = (Boolean)getAttribute(key); - return (b == null ? def : b.booleanValue()); - } - - public int getIntegerAttribute(Object key, int def) { - Number n = (Number)getAttribute(key); - return (n == null ? def : n.intValue()); - } - - public double getDoubleAttribute(Object key, double def) { - Number n = (Number)getAttribute(key); - return (n == null ? def : n.doubleValue()); - } - - /** - * @deprecated use getAttribute(Object key)instead. - */ - public Object getClientProperty(Object key) { - return getAttribute(key); - } - - /** - * @deprecated use addAttribute(Object key, Object value)instead. - */ - public void addClientProperty(Object key, Object value) { - addAttribute(key, value); - } - - /** - * @deprecated use getClientPropertyKeysEnumerator() instead. - */ - public Iterator getClientPropertyKeysIterator() { - final Enumeration enumeration = getClientPropertyKeysEnumeration(); - return new Iterator