/*
 * Copyright (c) 2008-2019, Piccolo2D project, http://piccolo2d.org
 * Copyright (c) 1998-2008, 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.
 *
 * None of the name of the University of Maryland, the name of the Piccolo2D project, or 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.
 */
package org.piccolo2d.extras.swt;

import org.piccolo2d.PCamera;
import org.piccolo2d.PNode;
import org.piccolo2d.util.PBounds;
import org.piccolo2d.util.PPickPath;

/**
 * A class for managing the position of a sticky handle.
 */
public class PSWTStickyHandleManager extends PNode {
    private static final long serialVersionUID = 1L;
    private PNode target;
    private PCamera camera;

    /**
     * Creates a sticky handle that will be displayed on the given camera and
     * will update the provided target.
     * 
     * @param camera camera on which to display the sticky handle
     * @param target target being controlled by the handle
     */
    public PSWTStickyHandleManager(final PCamera camera, final PNode target) {
        setCameraTarget(camera, target);
        PSWTBoundsHandle.addBoundsHandlesTo(this);
    }

    /**
     * Changes the associated camera and target for this sticky handle.
     * 
     * @param newCamera new camera onto which this handle should appear
     * @param newTarget new target which this handle will control
     */
    public void setCameraTarget(final PCamera newCamera, final PNode newTarget) {
        camera = newCamera;
        camera.addChild(this);
        target = newTarget;
    }

    /** {@inheritDoc} */
    public boolean setBounds(final double x, final double y, final double width, final double height) {
        final PBounds b = new PBounds(x, y, width, height);
        camera.localToGlobal(b);
        camera.localToView(b);
        target.globalToLocal(b);
        target.setBounds(b);
        return super.setBounds(x, y, width, height);
    }

    /**
     * Always returns true to ensure that they will always be displayed
     * appropriately.
     * 
     * @return true
     */
    protected boolean getBoundsVolatile() {
        return true;
    }

    /** {@inheritDoc} */
    public PBounds getBoundsReference() {
        final PBounds targetBounds = target.getFullBounds();
        camera.viewToLocal(targetBounds);
        camera.globalToLocal(targetBounds);
        final PBounds bounds = super.getBoundsReference();
        bounds.setRect(targetBounds);
        return super.getBoundsReference();
    }

    /** {@inheritDoc} */
    public void startResizeBounds() {
        super.startResizeBounds();
        target.startResizeBounds();
    }

    /** {@inheritDoc} */
    public void endResizeBounds() {
        super.endResizeBounds();
        target.endResizeBounds();
    }

    /**
     * Since PSWTStickyHandle manager is not visible on screen, it just returns
     * false when it is asked to be repainted.
     * 
     * @param pickPath path of this node in which the interaction occurred that
     *            required the repaint
     * 
     * @return always false
     */
    public boolean pickAfterChildren(final PPickPath pickPath) {
        return false;
    }
}