SoIvTune Class Reference

Opens an Open Inventor Studio window or an IvTune window More...

#include <IvTune/SoIvTune.h>

Static Public Member Functions
static void	start (const SoRenderAreaCore *)
	Starts an IvTune or Open Inventor Studio session based on the scene graph managed by the given SoRenderAreaCore.
static void	start (SoNode *)
	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	stop ()
	Ends IvTune/Open Inventor Studio session.
static bool	isRunning ()
	Returns true if IvTune/Open Inventor Studio are currently running.
static bool	processEvents ()
	Process Qt events (calls QCoreApplication::processEvents()).
static void	setShortcutValue (SoKeyboardEvent::Key)
	Defines the keyboard shortcut to use to launch IvTune/Open Inventor Studio.
static SoKeyboardEvent::Key	getShortcutValue ()
	Retrieves the defined keyboard shortcut used to launch IvTune/Open Inventor Studio.
Deprecated
static SoDEPRECATED void	start (SoSceneManager *)
	Starts an IvTune session based on the scene graph in an existing SoSceneManager.
static SoDEPRECATED void	setInstance (int argc, char **argv, SoNode *root, bool createViewer=false)
	Opens an IvTune window displaying the specified scene graph.
static SoDEPRECATED void	setInstance (int argc, char **argv, SoGuiRenderArea *viewer)
	Opens an IvTune window displaying the scene graph from the specified viewer.
static SoDEPRECATED void	launch (int argc, char **argv, SoGuiRenderArea *viewer)
	Opens an IvTune window displaying the scene graph from the specified viewer, and returns immediatly.
static SoDEPRECATED SbBool	isInstance ()
	Returns TRUE if an IvTune window is currently open.

Detailed Description

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).

Definition at line 92 of file SoIvTune.h.

Member Function Documentation

getShortcutValue()

static SoKeyboardEvent::Key SoIvTune::getShortcutValue ( )

static

Retrieves the defined keyboard shortcut used to launch IvTune/Open Inventor Studio.

isInstance()

static SoDEPRECATED SbBool SoIvTune::isInstance ( )

static

Returns TRUE if an IvTune window is currently open.

isRunning()

static bool SoIvTune::isRunning ( )

static

Returns true if IvTune/Open Inventor Studio are currently running.

launch()

static SoDEPRECATED void SoIvTune::launch ( int  argc, char **  argv, SoGuiRenderArea *  viewer  )

static

Opens an IvTune window displaying the scene graph from the specified viewer, and returns immediatly.

The argc and argv parameters are not normally used. After launching IvTune, a non Qt application should call the processEvents function periodically so that Qt events will be treated.

You should pass the pointer returned by getGuiRenderArea() from your viewer object (which can be derived from SoQtRenderArea, SoXtRenderArea or SoWinRenderArea).

For example:

SoIvTune::setInstance ( 0, NULL, pViewer->getGuiRenderArea());

NOTE: There is currently no way to programmatically close an IvTune window. It can be closed manually, or it will be closed when the program exits.

processEvents()

static bool SoIvTune::processEvents ( )

static

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.

setInstance() [1/2]

static SoDEPRECATED void SoIvTune::setInstance ( int  argc, char **  argv, SoGuiRenderArea *  viewer  )

static

Opens an IvTune window displaying the scene graph from the specified viewer.

The argc and argv parameters are not normally used. When called from non Qt application, the function enters a Qt process events loop ( QCoreApplication::exec() ). Use launch() and processEvents() instead.

You should pass the pointer returned by getGuiRenderArea() from your viewer object (which can be derived from SoQtRenderArea, SoXtRenderArea or SoWinRenderArea).

For example:

SoIvTune::setInstance ( 0, NULL, pViewer->getGuiRenderArea());

NOTE: There is currently no way to programmatically close an IvTune window. It can be closed manually, or it will be closed when the program exits.

setInstance() [2/2]

static SoDEPRECATED void SoIvTune::setInstance ( int  argc, char **  argv, SoNode *  root, bool  createViewer = false  )

static

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.

setShortcutValue()

static void SoIvTune::setShortcutValue ( SoKeyboardEvent::Key  )

static

Defines the keyboard shortcut to use to launch IvTune/Open Inventor Studio.

start() [1/3]

static void SoIvTune::start ( const SoRenderAreaCore *  )

static

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.

start() [2/3]

static void SoIvTune::start ( SoNode *  )

static

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.

start() [3/3]

static SoDEPRECATED void SoIvTune::start ( SoSceneManager *  )

static

Starts an IvTune session based on the scene graph in an existing SoSceneManager.

This method has no effect if IvTune is already running.

stop()

static void SoIvTune::stop ( )

static

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.

---

The documentation for this class was generated from the following file:

• IvTune/SoIvTune.h