bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Pick.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.g2d.element.handler;
  13
  14 import java.awt.Shape;
  15
  16 import org.simantics.g2d.diagram.handler.PickRequest.PickPolicy;
  17 import org.simantics.g2d.element.IElement;
  18 import org.simantics.g2d.utils.GeometryUtils;
  19
  20
  21 /**
  22  * Pick-interface allows detailed pick test for an element.
  23  * If pick is not implemented, its ({@link Outline}) is used for pick test.
  24  * If outline is not implemented, its bounds is used for pick.
  25  *
  26  * @See {@link InternalSize}
  27  * @See {@link BoundsPickable}
  28  * @See {@link GeometryUtils}
  29  *
  30  * @author Toni Kalajainen
  31  */
  32 public interface Pick extends ElementHandler {
  33
  34     /**
  35      * Make pick test
  36      * @param e the element to pick test
  37      * @param s the picking shape to test against e, in canvas coordinate system
  38      * @param policy the criterion for picking acceptance
  39      * @return <code>true</code> if shape intersects/contains element e, otherwise <code>false</code>
  40      */
  41     boolean pickTest(IElement e, Shape s, PickPolicy policy);
  42
  43 }