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