Class SoIvTune
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.ivtune.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 (seeSoPreferences
).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 (seeSoPreferences
) or using thesetShortcutValue()
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 methodSoDB.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).
-
-
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
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static SoKeyboardEvent.Keys
getShortcutValue()
Retrieves the defined keyboard shortcut used to launch IvTune/Open Inventor Studio.static boolean
isInstance()
Deprecated.As of Open Inventor 9000.static boolean
isRunning()
Returns true if IvTune/Open Inventor Studio are 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.static void
setShortcutValue(SoKeyboardEvent.Keys name_14298)
Defines the keyboard shortcut to use to launch IvTune/Open Inventor Studio.void
setValue(SoIvTune copyFrom)
static void
start(SoNode name_14297)
Starts an IvTune or Open Inventor Studio session based on the specified scene graph, for example a subset of the application scene graph.static void
start(SoSceneManager name_14299)
Deprecated.As of Open Inventor 9800.static void
start(SoRenderAreaCore name_14296)
Starts an IvTune or Open Inventor Studio session based on the scene graph managed by the givenSoRenderAreaCore
.static void
stop()
Ends IvTune/Open Inventor Studio session.-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Method Detail
-
setInstance
@Deprecated 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()
-
start
@Deprecated public static void start(SoSceneManager name_14299)
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 existingSoSceneManager
. 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_14298)
Defines the keyboard shortcut to use to launch IvTune/Open Inventor Studio.
-
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.Warning Deprecated since Open Inventor 9000. No longer used. Use
start()
instead.
-
start
public static void start(SoRenderAreaCore name_14296)
Starts an IvTune or Open Inventor Studio session based on the scene graph managed by the givenSoRenderAreaCore
. This method has no effect if IvTune or Open Inventor Studio are already running.
-
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.Warning Deprecated since Open Inventor 9000. No longer used. Use
isRunning()
instead.
-
start
public static void start(SoNode name_14297)
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.
-
-