| SoIvTune Class |
Opens an Open Inventor Studio window or an IvTune window.
Inheritance HierarchyNamespace: OIV.IvTune
Assembly: OIV.IvTune (in OIV.IvTune.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoIvTune type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
 | GetShortcutValue | Retrieves the defined keyboard shortcut used to launch IvTune/Open Inventor Studio. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsInstance | Obsolete. Returns true if an IvTune window is currently open. |
| IsRunning | Returns true if IvTune/Open Inventor Studio are currently running. |
| ProcessEvents | Process Qt events (calls QCoreApplication.processEvents()). |
| SetInstance(Int32, String, SoNode) | Obsolete. Calls SetInstance(argc, argv, root, false). |
| SetInstance(Int32, String, SoNode, Boolean) | Obsolete. |
| SetShortcutValue | Defines the keyboard shortcut to use to launch IvTune/Open Inventor Studio. |
| Start(SoNode) |
Starts an IvTune session based on the specified scene graph,
for example a subset of the application scene graph.
|
| Start(SoRenderAreaCore) |
Starts an IvTune session based on the scene graph managed
by the given SoRenderAreaCore.
|
| Start(SoSceneManager) | Obsolete.
Starts an IvTune session based on the scene graph in an existing
SoSceneManager.
|
| Stop | Ends IvTune/Open Inventor Studio session. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
RemarksOIV.IvTune.SoIvTune is a class to start and stop either IvTune or Open Inventor Studio depending on the environment variable OIV_USE_OIVS (see OIV.Inventor.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 () 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 OIV.Inventor.SoPreferences) or using the OIV.IvTune.SoIvTune.SetShortcutValue(OIV.Inventor.Events.SoKeyboardEvent.Keys) 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 OIV.Inventor.SoDB.SetIvTuneAllowed(System.Boolean). 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.
Note: In order to use the IvTune/Open Inventor Studio hot key feature with an Open Inventor .NET application, you must explicitly add the IvTune assembly (OIV.IvTune) to the project references.
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 OIV.LDM.Nodes.SoTransferFunction nodes. Documentation and examples are provided in the source/IvTune subdirectory of the Open Inventor SDK (after installing the Demos package).
See Also