com.openinventor.ivtune

Class SoIvTune

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.ivtune.SoIvTune

public class SoIvTune
extends Inventor

Opens an IvTune window. IvTune is an editor and viewer for Open Inventor scene graphs.

If the hot key (Shift-F12 by default) is enabled, the user can start IvTune by pressing that key combination. Using the start() method, the application can programmatically start and stop IvTune. This is useful if all key combinations are already in use by the application or just to provide an IvTune item in a menu. The IvTune 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 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 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.

For details of using IvTune, see the on-line documentation provided for the pre-built IvTune viewer supplied with the Open Inventor SDK in the program (Windows) or bin (Unix/Linux) directory. The IvTune viewer application 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).

NOTE : Since Open Inventor 9.7, IvTune is built with Qt 5.x, which is not compatible with Qt 4.x. If your application is built with Qt 4.x, you will not be able to invoke IvTune.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
static SoKeyboardEvent.Keys	getShortcutValue() Retrieves the defined keyboard shortcut used to launch IvTune.
static boolean	isInstance() Deprecated. As of Open Inventor 9000 No longer used. Use isRunning() instead.
static boolean	isRunning() Returns true if IvTune is currently running.
static boolean	processEvents() Process Qt events (calls QCoreApplication.processEvents()).
static void	setInstance(int argc, java.lang.String[] argv, SoNode root) Deprecated.
static void	setInstance(int argc, java.lang.String[] argv, SoNode root, boolean createViewer) Deprecated. As of Open Inventor 9000 No longer used. Use start() instead.
static void	setShortcutValue(SoKeyboardEvent.Keys name_14045) Defines the keyboard shortcut to use to launch IvTune.
static void	start(SoNode name_14044) Starts an IvTune session based on the specified scene graph, for example a subset of the application scene graph.
static void	start(SoRenderAreaCore name_14043) Starts an IvTune session based on the scene graph managed by the given SoRenderAreaCore.
static void	start(SoSceneManager name_14046) Deprecated. As of Open Inventor 9800 No longer used. Use start(SoRenderAreaCore*) or start(SoNode*) instead.
static void	stop() Ends IvTune session.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setInstance

@Deprecated
public static void setInstance(int argc,
                                            java.lang.String[] argv,
                                            SoNode root)

Deprecated.

Calls setInstance(argc, argv, root, (boolean)false).

isInstance

@Deprecated
public static boolean isInstance()

Deprecated. As of Open Inventor 9000 No longer used. Use isRunning() instead.

Returns true if an IvTune window is currently open. Deprecated since Open Inventor 9000.
No longer used. Use isRunning() instead.

start

@Deprecated
public static void start(SoSceneManager name_14046)

Deprecated. As of Open Inventor 9800 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. Deprecated since Open Inventor 9800.
No longer used. Use start(SoRenderAreaCore*) or start(SoNode*) instead.

isRunning

public static boolean isRunning()

Returns true if IvTune is currently running.

setInstance

@Deprecated
public static void setInstance(int argc,
                                            java.lang.String[] argv,
                                            SoNode root,
                                            boolean createViewer)

Deprecated. As of Open Inventor 9000 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.Deprecated since Open Inventor 9000.
No longer used. Use start() instead.

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.

getShortcutValue

public static SoKeyboardEvent.Keys getShortcutValue()

Retrieves the defined keyboard shortcut used to launch IvTune.

setShortcutValue

public static void setShortcutValue(SoKeyboardEvent.Keys name_14045)

Defines the keyboard shortcut to use to launch IvTune.

start

public static void start(SoRenderAreaCore name_14043)

Starts an IvTune session based on the scene graph managed by the given SoRenderAreaCore. This method has no effect if IvTune is already running.

start

public static void start(SoNode name_14044)

Starts an IvTune session based on the specified scene graph, for example a subset of the application scene graph. This method has no effect if IvTune is already running.

stop

public static void stop()

Ends IvTune session. Calling stop() closes the IvTune windows. A new IvTune session can be launched using one of the start() methods.