Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scenegraph / src / org / simantics / scenegraph / adapters / ISceneGraphProvider.java

diff --git a/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/adapters/ISceneGraphProvider.java b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/adapters/ISceneGraphProvider.java
new file mode 100644 (file)
index 0000000..f1da468
--- /dev/null
+++ b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/adapters/ISceneGraphProvider.java
@@ -0,0 +1,55 @@
+/*******************************************************************************\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.scenegraph.adapters;
+
+import java.awt.event.AWTEventListener;
+
+import org.simantics.scenegraph.g2d.G2DSceneGraph;
+
+/**
+ * Interface for resources that provide scene graph view
+ * Currently only 2D scene graph is supported
+ * 
+ * @author jplaine
+ *
+ */
+public interface ISceneGraphProvider {
+       /**
+        * 
+        * @param sg Initialized G2DSceneGraph instance 
+        * @return sg
+        */
+       public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg);
+\r
+    public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String modelURI, String RVI);\r
+
+       /**
+        * 
+        * @param sg Initialized G2DSceneGraph instance 
+        * @param view Layer other view identifier. If null, default is used
+        * @return sg
+        */
+       public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String view);
+
+       public AWTEventListener getEventListener();
+       
+       /**
+        * Method for passing parameters for initialization. Basically the key should be IHintContext.Key, but it doesn't have to be.
+        * The detailed list of supported keys and values should be described in implementation.
+        * 
+        * @param key Hint key
+        * @param value Hint value
+        */
+       public void setHint(Object key, Object value);
+       
+       public void dispose();
+}