dev/org.simantics.proconf.g3d/src/org/simantics/proconf/g3d/gizmo/Gizmo.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007 VTT Technical Research Centre of Finland and others.\r
   3  * All rights reserved. This program and the accompanying materials\r
   4  * are made available under the terms of the Eclipse Public License v1.0\r
   5  * which accompanies this distribution, and is available at\r
   6  * http://www.eclipse.org/legal/epl-v10.html\r
   7  *\r
   8  * Contributors:\r
   9  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  10  *******************************************************************************/\r
  11 package org.simantics.proconf.g3d.gizmo;\r
  12 \r
  13 import com.jme.scene.Node;\r
  14 \r
  15 /**\r
  16  * Interface for gizmos, interactive components in the scene-graph.\r
  17  * \r
  18  * @author Marko Luukkainen <Marko.Luukkainen@vtt.fi>\r
  19  *\r
  20  */\r
  21 public interface Gizmo {\r
  22 \r
  23         /**\r
  24          * Must return unique identifier for this gizmo\r
  25          * @return\r
  26          */\r
  27     public abstract String getPickPrefix();\r
  28 \r
  29     /**\r
  30      * Sets selected component (where mouse is hovering) by using its name.\r
  31      * Name includes pick prefix\r
  32      * @param name\r
  33      */\r
  34     public abstract void setSelected(String name);\r
  35 \r
  36     /**\r
  37      * Returns root-node of the gizmo. It is used for inserting the gizmo into scenegraph.\r
  38      * @return\r
  39      */\r
  40     public abstract Node getNode();\r
  41     \r
  42     /**\r
  43      * Returns true if gizmo needs to be redrawn.\r
  44      * @return\r
  45      */\r
  46     public boolean isChanged();\r
  47     \r
  48     public void setChanged(boolean b);\r
  49 \r
  50 }