Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / diagram / handler / PickContext.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/diagram/handler/PickContext.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/diagram/handler/PickContext.java
new file mode 100644 (file)
index 0000000..9d89ed8
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/diagram/handler/PickContext.java
@@ -0,0 +1,48 @@
+/*******************************************************************************\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.diagram.handler;\r
+\r
+import java.util.Collection;\r
+\r
+import org.simantics.g2d.diagram.IDiagram;\r
+import org.simantics.g2d.diagram.handler.impl.PickContextImpl;\r
+import org.simantics.g2d.element.IElement;\r
+import org.simantics.g2d.element.handler.InternalSize;\r
+import org.simantics.g2d.element.handler.Outline;\r
+import org.simantics.g2d.element.handler.Pick;\r
+\r
+/**\r
+ * Pick process is the following:\r
+ *  1) Rough estimation with {@link InternalSize} \r
+ *  2) use {@link Pick} if implementations exist\r
+ *  3) if pick doesn't exist, use {@link Outline} if implementations exist \r
+ * \r
+ * @see {@link PickContextImpl} Implementation\r
+ * @author Toni Kalajainen\r
+ */\r
+public interface PickContext extends DiagramHandler {\r
+\r
+       /**\r
+        * Make a pick to the diagram.\r
+        * Result content is added in z-order starting from the bottom.\r
+        * \r
+        * @param diagram\r
+        * @param ctx\r
+        * @param request\r
+        * @param result\r
+        */\r
+       void pick(\r
+                       IDiagram diagram, \r
+                       PickRequest request, \r
+                       Collection<IElement> result);   \r
+       \r
+}\r