bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/adapters/ISceneGraphProvider.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.scenegraph.adapters;
  13
  14 import java.awt.event.AWTEventListener;
  15
  16 import org.simantics.scenegraph.g2d.G2DSceneGraph;
  17
  18 /**
  19  * Interface for resources that provide scene graph view
  20  * Currently only 2D scene graph is supported
  21  *
  22  * @author jplaine
  23  *
  24  */
  25 public interface ISceneGraphProvider {
  26         /**
  27          *
  28          * @param sg Initialized G2DSceneGraph instance
  29          * @return sg
  30          */
  31         public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg);
  32 \r
  33     public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String modelURI, String RVI);\r
  34
  35         /**
  36          *
  37          * @param sg Initialized G2DSceneGraph instance
  38          * @param view Layer other view identifier. If null, default is used
  39          * @return sg
  40          */
  41         public G2DSceneGraph initializeSceneGraph(G2DSceneGraph sg, String view);
  42
  43         public AWTEventListener getEventListener();
  44
  45         /**
  46          * Method for passing parameters for initialization. Basically the key should be IHintContext.Key, but it doesn't have to be.
  47          * The detailed list of supported keys and values should be described in implementation.
  48          *
  49          * @param key Hint key
  50          * @param value Hint value
  51          */
  52         public void setHint(Object key, Object value);
  53
  54         public void dispose();
  55 }