Package com.openinventor.ivtune

Class SoIvTune

  • public class SoIvTune
extends Inventor
    Opens an Open Inventor Studio window or an IvTune window. SoIvTune is a class to start and stop either IvTune or Open Inventor Studio depending on the environment variable OIV_USE_OIVS (see SoPreferences).

    If the hot key (Shift-F12 by default) is enabled, the user can start IvTune/Open Inventor Studio by pressing that key combination. Using the start() method, the application can programmatically start and stop IvTune/Open Inventor Studio. This is useful if all key combinations are already in use by the application or just to provide an IvTune/Open Inventor Studio item in a menu. The IvTune/Open Inventor Studio hot key can be redefined using the environment variable OIV_IVTUNE_SHORTCUT (see SoPreferences) or using the setShortcutValue() method.

    Note:
    We recommend disabling the IvTune/Open Inventor Studio hot key when you distribute your application, especially if it is a commercial application. See the method SoDB.setIvTuneAllowed(). This will prevent users from viewing or changing the application scene graph. Even if the hot key is disabled, the application can still allow opening IvTune, if desired, for example from an "expert" menu using the methods in this class.

    When IvTune/Open Inventor Studio is started from an application, it opens a separate window. This window includes a Tree_View panel which displays the scene graph, a Node_Overview panel to display the fields of a node, and Field_Editor and Field_Watch panels to edit and track interesting fields.

    IvTune and Open Inventor Studio viewer applications can also be used to view Open Inventor scene graph files.

    IvTune can also be extensively customized and extended using the IvTuneExtender API to create plugins. An IvTune plugin can modify the IvTune user interface, replace standard IvTune panels and even provide new panels that implement specialized operations such a color map editor for SoTransferFunction nodes. Documentation and examples are provided in the source/IvTune subdirectory of the Open Inventor SDK (after installing the Demos package).

    • Method Detail

      • setInstance

        @Deprecated(since="9.0.0.0")
public static void setInstance​(int argc,
                               java.lang.String[] argv,
                               SoNode root)
        Deprecated.
        Calls setInstance(argc, argv, root, (boolean)false).

      • setValue

        public void setValue​(SoIvTune copyFrom)

      • processEvents

        public static boolean processEvents()
        Process Qt events (calls QCoreApplication.processEvents()). A non-Qt application should call this function periodically so that IvTune's Qt events are handled. Not necessary for Qt applications.

        Returns false when IvTune is not running.

      • stop

        public static void stop()
        Ends IvTune/Open Inventor Studio session. Calling stop() closes the IvTune/Open Inventor Studio windows. A new IvTune/Open Inventor Studio session can be launched using one of the start() methods.

      • start

        @Deprecated(since="9.8.0.0")
public static void start​(SoSceneManager name_13899)
        Deprecated.
        As of Open Inventor 9.8.0.0. No longer used. Use start(SoRenderAreaCore*) or start(SoNode*) instead.
        Starts an IvTune session based on the scene graph in an existing SoSceneManager. This method has no effect if IvTune is already running.

        Warning Deprecated since Open Inventor 9800. No longer used. Use start(SoRenderAreaCore*) or start(SoNode*) instead.

      • getShortcutValue

        public static SoKeyboardEvent.Keys getShortcutValue()
        Retrieves the defined keyboard shortcut used to launch IvTune/Open Inventor Studio.

      • isRunning

        public static boolean isRunning()
        Returns true if IvTune/Open Inventor Studio are currently running.

      • setShortcutValue

        public static void setShortcutValue​(SoKeyboardEvent.Keys name_13898)
        Defines the keyboard shortcut to use to launch IvTune/Open Inventor Studio.

      • setInstance

        @Deprecated(since="9.0.0.0")
public static void setInstance​(int argc,
                               java.lang.String[] argv,
                               SoNode root,
                               boolean createViewer)
        Deprecated.
        As of Open Inventor 9.0.0.0. No longer used. Use start() instead.
        Opens an IvTune window displaying the specified scene graph. The argc and argv parameters are not normally used. if createViewer is true then a viewer is created to do the rendering else only the treeview part will be shown.

        Warning Deprecated since Open Inventor 9000. No longer used. Use start() instead.

      • start

        public static void start​(SoRenderAreaCore name_13896)
        Starts an IvTune or Open Inventor Studio session based on the scene graph managed by the given SoRenderAreaCore. This method has no effect if IvTune or Open Inventor Studio are already running.

      • isInstance

        @Deprecated(since="9.0.0.0")
public static boolean isInstance()
        Deprecated.
        As of Open Inventor 9.0.0.0. No longer used. Use isRunning() instead.
        Returns true if an IvTune window is currently open.

        Warning Deprecated since Open Inventor 9000. No longer used. Use isRunning() instead.

      • start

        public static void start​(SoNode name_13897)
        Starts an IvTune or Open Inventor Studio session based on the specified scene graph, for example a subset of the application scene graph. This method has no effect if IvTune/Open Inventor Studio are already running.