bundles/org.simantics.g2d/src/org/simantics/g2d/diagram/handler/PickContext.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.diagram.handler;\r
  13 \r
  14 import java.util.Collection;\r
  15 \r
  16 import org.simantics.g2d.diagram.IDiagram;\r
  17 import org.simantics.g2d.diagram.handler.impl.PickContextImpl;\r
  18 import org.simantics.g2d.element.IElement;\r
  19 import org.simantics.g2d.element.handler.InternalSize;\r
  20 import org.simantics.g2d.element.handler.Outline;\r
  21 import org.simantics.g2d.element.handler.Pick;\r
  22 \r
  23 /**\r
  24  * Pick process is the following:\r
  25  *  1) Rough estimation with {@link InternalSize} \r
  26  *  2) use {@link Pick} if implementations exist\r
  27  *  3) if pick doesn't exist, use {@link Outline} if implementations exist \r
  28  * \r
  29  * @see {@link PickContextImpl} Implementation\r
  30  * @author Toni Kalajainen\r
  31  */\r
  32 public interface PickContext extends DiagramHandler {\r
  33 \r
  34         /**\r
  35          * Make a pick to the diagram.\r
  36          * Result content is added in z-order starting from the bottom.\r
  37          * \r
  38          * @param diagram\r
  39          * @param ctx\r
  40          * @param request\r
  41          * @param result\r
  42          */\r
  43         void pick(\r
  44                         IDiagram diagram, \r
  45                         PickRequest request, \r
  46                         Collection<IElement> result);   \r
  47         \r
  48 }\r