bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Pick2.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 import java.util.Collection;\r
  16 \r
  17 import org.simantics.g2d.diagram.handler.PickRequest.PickPolicy;\r
  18 import org.simantics.g2d.element.IElement;\r
  19 import org.simantics.g2d.utils.GeometryUtils;\r
  20 \r
  21 \r
  22 /**\r
  23  * Pick-interface allows detailed pick test for an element.\r
  24  * If pick is not implemented, its ({@link Outline}) is used for pick test.\r
  25  * If outline is not implemented, its bounds is used for pick.\r
  26  * \r
  27  * @See {@link InternalSize}\r
  28  * @See {@link BoundsPickable}\r
  29  * @See {@link GeometryUtils}\r
  30  * \r
  31  * @author Tuukka Lehtonen\r
  32  */\r
  33 public interface Pick2 extends Pick {\r
  34 \r
  35     /**\r
  36      * Try to pick the specified element and its possible children.\r
  37      * \r
  38      * The pick results are put in the specified element collection.\r
  39      * \r
  40      * @param e the element to pick test\r
  41      * @param s the picking shape to test against e\r
  42      * @param policy the criterion for picking acceptance\r
  43      * @param result the result collection into which the picked elements will\r
  44      *        be appended\r
  45      * @return the amount of elements intersecting/containing s. Tells the\r
  46      *         amount of elements added to the result collection.\r
  47      */\r
  48     int pick(IElement e, Shape s, PickPolicy policy, Collection<IElement> result);\r
  49 \r
  50 }\r