Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / element / handler / Pick2.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Pick2.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Pick2.java
new file mode 100644 (file)
index 0000000..480d0c2
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Pick2.java
@@ -0,0 +1,50 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.g2d.element.handler;\r
+\r
+import java.awt.Shape;\r
+import java.util.Collection;\r
+\r
+import org.simantics.g2d.diagram.handler.PickRequest.PickPolicy;\r
+import org.simantics.g2d.element.IElement;\r
+import org.simantics.g2d.utils.GeometryUtils;\r
+\r
+\r
+/**\r
+ * Pick-interface allows detailed pick test for an element.\r
+ * If pick is not implemented, its ({@link Outline}) is used for pick test.\r
+ * If outline is not implemented, its bounds is used for pick.\r
+ * \r
+ * @See {@link InternalSize}\r
+ * @See {@link BoundsPickable}\r
+ * @See {@link GeometryUtils}\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface Pick2 extends Pick {\r
+\r
+    /**\r
+     * Try to pick the specified element and its possible children.\r
+     * \r
+     * The pick results are put in the specified element collection.\r
+     * \r
+     * @param e the element to pick test\r
+     * @param s the picking shape to test against e\r
+     * @param policy the criterion for picking acceptance\r
+     * @param result the result collection into which the picked elements will\r
+     *        be appended\r
+     * @return the amount of elements intersecting/containing s. Tells the\r
+     *         amount of elements added to the result collection.\r
+     */\r
+    int pick(IElement e, Shape s, PickPolicy policy, Collection<IElement> result);\r
+\r
+}\r