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

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