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