com.openinventor.directviz

Class SoDirectVizManager

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.directviz.SoDirectVizManager

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoDirectVizManager
extends SoNode

Manages ray-traced rendering. SoDirectVizManager manages ray-traced rendering of scenes. See DirectViz group for the package description.

SoDirectVizManager derives from SoNode, however it must not be referenced by the application and must not be inserted in a scene graph. SoDirectVizManager is freed by calling finish().

SoDirectVizManager provides general control of DirectViz:

• Activating ray-traced rendering for a viewer or render area
  SoDirectVizManager is associated with a scene manager when calling getInstance(). The scene manager can be retrived from a render area or viewer by calling SoXtRenderArea.getSceneManager() (or the SoWin or SoQt equivalent).
  Note that you can activate DirectViz for a viewer without using the SoDirectVizManager class by calling SoXtViewer.enableDirectViz(), SoWinViewer.enableDirectViz(), or SoQtViewer.enableDirectViz().
  As only one scene manager at a time can use ray-traced rendering in the current release, there can be only one DirectVizManager instance. If DirectViz was already associated with a scene manager, calling getInstance() with another scene manager will deactivate DirectViz on the previously associated scene manager. The same applies for viewers and render areas.
• Managing interactivity/quality trade-offs: resolution subsampling, progressive resolution, accumulation for oversampling/antialiasing, recursion depth limit.
• Enabling/disabling the control dialog
• Getting information about frame size, time for rendering, current accumulation pass; number of geometry objects, textures, lights and surface shaders
  • Managing cache files for acceleration structures

Note: reflection and shadow rays computation use an offset internally used to deflect ray in order to prevent infinite hits. This offset is properly initialized to 1e-3, but it may lead to artefacts in some cases (wrong pixels). Then, the SoPreference variable DIRECTVIZ_RAY_EPSILON will have to be set to 1e-2 or 1e-1.

See also:

SoSceneManager, SoXtRenderArea, SoXtViewer, SoWinRenderArea, SoWinViewer, SoQtRenderArea, SoQtViewer, SoSeparator, SoDirectVizShaderDeprecated since Open Inventor 9500
No longer supported.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoDirectVizManager.CacheModes Deprecated. Cache states.
static class	SoDirectVizManager.EnvLights Deprecated. Number of environment lights.

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	accumulation Deprecated. Activates/deactivates accumulation passes.
SoSFBool	adaptiveOversampling Deprecated. Enables/disables adaptive oversampling rendering.
SoSFBool	controlDialog Deprecated. Enables/disables the DirectViz control dialog.
static int	ENV_LIGHTS_0 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_0 instead.
static int	ENV_LIGHTS_128 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_128 instead.
static int	ENV_LIGHTS_16 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_16 instead.
static int	ENV_LIGHTS_2 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_2 instead.
static int	ENV_LIGHTS_256 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_256 instead.
static int	ENV_LIGHTS_32 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_32 instead.
static int	ENV_LIGHTS_4 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_4 instead.
static int	ENV_LIGHTS_64 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_64 instead.
static int	ENV_LIGHTS_8 Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_8 instead.
SoSFFloat	envLightIntensityScale Deprecated. Intensity scale applied to environment lights defined by numEnvLights.
SoSFBool	fileCaching Deprecated. Enables/disables acceleration structure cache file.
SoSFBool	fuzzyLights Deprecated. Enables/disables fuzzy effects globally in the scene graph.
SoSFBool	globalShadowing Deprecated. Enables/disables shadows globally in the scene graph.
SoSFBool	glossySurfaces Deprecated. Enables/disables glossy surfaces effects globally in the scene graph.
SoSFInt32	maxAccumulationValue Deprecated. Specifies a maximum number of accumulation passes.
SoSFEnum<SoDirectVizManager.EnvLights>	numEnvLights Deprecated. Enables/disables environment lighting by specifying the number of lights.
SoSFInt32	numProgressiveRenderingSteps Deprecated. Specifies the number of steps (intermediate images) between subsampled rendering and full resolution rendering.
SoSFBool	progressiveRendering Deprecated. Activates/deactivates rendering with progressive resolution.
static int	READ_MODE Deprecated. Use SoDirectVizManager.CacheModes.READ_MODE instead.
static int	READ_WRITE_MODE Deprecated. Use SoDirectVizManager.CacheModes.READ_WRITE_MODE instead.
SoSFInt32	recursionLimit Deprecated. Specifies the recursion depth limit.
SoSFBool	rendering Deprecated. Activates/deactivates ray-traced rendering.
SoSFBool	softShadows Deprecated. Enables/disables soft shadows globally in the scene graph.
SoSFBool	subRecursion Deprecated. Enables/disables recursion when subsampling the scene.
SoSFBool	subSampling Deprecated. Activates/deactivates image sub-sampling.
SoSFFloat	subSamplingFactor Deprecated. Specifies the sub-sampling factor.
static int	WRITE_MODE Deprecated. Use SoDirectVizManager.CacheModes.WRITE_MODE instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
int	getCurrentAccumValue() Deprecated. Gets the current accumulation value.
static SoDirectVizManager	getInstance(SoSceneManager mgr) Deprecated. Returns a pointer to a DirectVizManager object associated with the specified scene manager.
double	getLastRenderTime() Deprecated. Gets the elapsed time for rendering the last frame in seconds.
int	getNumEnvironmentLights() Deprecated. Returns number of environment lights (see field numEnvLights).
SbVec2s	getRenderedImageSize() Deprecated. Gets the size of rendered image in pixels.
void	setCacheDirectory(java.lang.String directory) Deprecated. Specifies cache directory (it must be an absolute path).
void	setCacheFile(java.lang.String file) Deprecated. Calls setCacheFile(file, SoDirectVizManager.CacheModes.valueOf( SoDirectVizManager.CacheModes.READ_WRITE_MODE.getValue() )).
void	setCacheFile(java.lang.String file, SoDirectVizManager.CacheModes mode) Deprecated. Specifies cache file as an absolute path name.
void	setCamera(SoCamera camera) Deprecated. Set the camera to use for rendering.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

READ_WRITE_MODE

@Deprecated
public static final int READ_WRITE_MODE

Deprecated. Use SoDirectVizManager.CacheModes.READ_WRITE_MODE instead.

READ_MODE

@Deprecated
public static final int READ_MODE

Deprecated. Use SoDirectVizManager.CacheModes.READ_MODE instead.

WRITE_MODE

@Deprecated
public static final int WRITE_MODE

Deprecated. Use SoDirectVizManager.CacheModes.WRITE_MODE instead.

ENV_LIGHTS_0

@Deprecated
public static final int ENV_LIGHTS_0

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_0 instead.

ENV_LIGHTS_2

@Deprecated
public static final int ENV_LIGHTS_2

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_2 instead.

ENV_LIGHTS_4

@Deprecated
public static final int ENV_LIGHTS_4

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_4 instead.

ENV_LIGHTS_8

@Deprecated
public static final int ENV_LIGHTS_8

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_8 instead.

ENV_LIGHTS_16

@Deprecated
public static final int ENV_LIGHTS_16

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_16 instead.

ENV_LIGHTS_32

@Deprecated
public static final int ENV_LIGHTS_32

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_32 instead.

ENV_LIGHTS_64

@Deprecated
public static final int ENV_LIGHTS_64

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_64 instead.

ENV_LIGHTS_128

@Deprecated
public static final int ENV_LIGHTS_128

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_128 instead.

ENV_LIGHTS_256

@Deprecated
public static final int ENV_LIGHTS_256

Deprecated. Use SoDirectVizManager.EnvLights.ENV_LIGHTS_256 instead.

accumulation

public final SoSFBool accumulation

Deprecated.

Activates/deactivates accumulation passes.
Accumulation consists of successive rendering passes resulting in progressive oversampling of the rendered image, reducing aliasing. Accumulation passes are started only after a small delay without rendering, i.e. when the viewer is still and there is no animation in the scene. Each rendering pass takes a time equivalent to render a full resolution image. Accumulation is stopped after the current rendering pass is completed as soon as interaction starts again. Default is true.

The initial value can be set using the environment variable DIRECTVIZ _ACCUMULATION. See SoPreferences. The number of successive passes is controlled with the maxAccumulationValue field.

maxAccumulationValue

public final SoSFInt32 maxAccumulationValue

Deprecated.

Specifies a maximum number of accumulation passes.
Must be greater than or equal to 1. Default is 10.

The initial value can be set using the environment variable DIRECTVIZ_MAX_ACCUMULATION_VALUE. See SoPreferences.

subSampling

public final SoSFBool subSampling

Deprecated.

Activates/deactivates image sub-sampling.
Sub-sampling consists of rendering a smaller (i.e., lower resolution) image when the viewer is not still. Sub-sampling is controlled by a factor that represents the ratio between the rendered image and the full resolution image. Values can range from 0. to 1.0 (full resolution). To set this factor, use the subSamplingFactor field. Default is true.

The initial value can be set using the environment variable DIRECTVIZ_SUBSAMPLING. See SoPreferences.

subSamplingFactor

public final SoSFFloat subSamplingFactor

Deprecated.

Specifies the sub-sampling factor.
Values can range from 0. to 1. Default value is 0.5. The initial value can be set using the environment variable DIRECTVIZ_SUBSAMPLING_FACTOR. See SoPreferences.

recursionLimit

public final SoSFInt32 recursionLimit

Deprecated.

Specifies the recursion depth limit.
This is the maximum number of times a single ray can be reflected/refracted - "bounced" within the scene - when rendering a frame. Reflection (ray reflected by a shape) is enabled when the recursion limit is at least 2. Refraction (ray traversing a shape) is enabled when the recursion limit is at least 3. Default is 20.

The initial value can be set using the environment variable DIRECTVIZ_RECURSION_LIMIT. See SoPreferences.

subRecursion

public final SoSFBool subRecursion

Deprecated.

Enables/disables recursion when subsampling the scene.
Rendering may be sped up during interaction with the scene or when scene is animated by setting subRecursion to false: it will force the recursion limit to 1 and therefore prevent reflections and refractions. Default is true.

The initial value can be set using the environment variable DIRECTVIZ_SUB_RECURSION. See SoPreferences.

progressiveRendering

public final SoSFBool progressiveRendering

Deprecated.

Activates/deactivates rendering with progressive resolution.
Progressive rendering consists of making several render steps between the subsampled image and the full resolution image. The number of steps can be controlled with the numProgressiveRenderingSteps field. Default is false.

The initial value can be set using the environment variable DIRECTVIZ_PROGRESSIVE_RENDERING. See SoPreferences.

numProgressiveRenderingSteps

public final SoSFInt32 numProgressiveRenderingSteps

Deprecated.

Specifies the number of steps (intermediate images) between subsampled rendering and full resolution rendering.
Must be greater than 0. Default is 5.

The initial value can be set using the environment variable DIRECTVIZ_RENDER_STEPS. See SoPreferences.

rendering

public final SoSFBool rendering

Deprecated.

Activates/deactivates ray-traced rendering.
If true, ray-traced rendering is enabled. Default is false.

globalShadowing

public final SoSFBool globalShadowing

Deprecated.

Enables/disables shadows globally in the scene graph.
Default is false.

The initial value can be set using the environment variable DIRECTVIZ_GLOBAL_SHADOW. See SoPreferences.

adaptiveOversampling

public final SoSFBool adaptiveOversampling

Deprecated.

Enables/disables adaptive oversampling rendering.
Default is false.

Adaptive oversampling reduces aliasing only near aliased pixels in the image. The initial value can be set using the environment variable DIRECTVIZ_ADAPTIVE_OVERSAMPLING. See SoPreferences.

Since:

Open Inventor 7.2

softShadows

public final SoSFBool softShadows

Deprecated.

Enables/disables soft shadows globally in the scene graph.
Default is false.

The initial value can be set using the environment variable DIRECTVIZ_SOFT_SHADOWS. See SoPreferences.

Since:

Open Inventor 7.2

fuzzyLights

public final SoSFBool fuzzyLights

Deprecated.

Enables/disables fuzzy effects globally in the scene graph.
Default is false.

The initial value can be set using the environment variable DIRECTVIZ_FUZZY_LIGHTS. See SoPreferences.

Since:

Open Inventor 7.2

glossySurfaces

public final SoSFBool glossySurfaces

Deprecated.

Enables/disables glossy surfaces effects globally in the scene graph.
Default is false.

The initial value can be set using the environment variable DIRECTVIZ_GLOSSY_SURFACES. See SoPreferences.

Since:

Open Inventor 7.2

numEnvLights

public final SoSFEnum<SoDirectVizManager.EnvLights> numEnvLights

Deprecated.

Enables/disables environment lighting by specifying the number of lights.
When an Environment shader is specified, DirectViz allows extracting fake lights from the environment texture. Thus, the lighting is performed with additional lights coming directly from the environment. When combined with accumulation, the fake lights are taken at different environment texture positions at each accumulation step. Thus, lights from the entire environment can be used for illumination, giving a fast and accurate approximation of ambient occlusion. Default is 0.

The initial value can be set using the environment variable DIRECTVIZ_NUM_ENV_LIGHTS. See SoPreferences.

Since:

Open Inventor 8.0

envLightIntensityScale

public final SoSFFloat envLightIntensityScale

Deprecated.

Intensity scale applied to environment lights defined by numEnvLights.
Default is 1.

The initial value can be set using the environment variable DIRECTVIZ_ENV_LIGHTS_SCALE. See SoPreferences.

Since:

Open Inventor 8.0

fileCaching

public final SoSFBool fileCaching

Deprecated.

Enables/disables acceleration structure cache file.
DirectViz file caching consists of saving on disk the internal accelaration structure built for OpenRTRT objects corresponding to an Open Inventor scene graph, which can save a significant amount of time when reloading large scenes.
A cache directory must be specified with the setCacheDirectory method, which will contain the cache files. For each scene graph there is exactly one cache file. A signature is automatically created and written in cache files, so it is not nesessary to name explicitly cached files.
If fileCaching is set to true, before rendering a new scene, DirectViz will first search in the cache directory if there is a cache file correponding to the scene signature. If such cache file exists, DirectViz will directly load OpenRTRT objects from it. Otherwise, DirectViz will create OpenRTRT objects from the scene graph and save them with the scene signature in a new cache file in the cache directory. A cache file can also be specified explicitly with setCacheFile(). Default is false.

The initial value can be set using the environment variable DIRECTVIZ_FILE_CACHING. See SoPreferences.

controlDialog

public final SoSFBool controlDialog

Deprecated.

Enables/disables the DirectViz control dialog.
DirectViz interactive parameters can be controlled using this dialog with Qt or Win32 viewers. When set to true, the dialog can be displayed by pressing the Shift + F8 key (or the key specified in the DIRECTVIZ_DIALOG_SHORTCUT environment variable) Default is true.

The initial value can be set using the environment variable DIRECTVIZ_CONTROL_DIALOG. See SoPreferences.

Method Detail

setCacheFile

public void setCacheFile(java.lang.String file)

Deprecated.

Calls setCacheFile(file, SoDirectVizManager.CacheModes.valueOf( SoDirectVizManager.CacheModes.READ_WRITE_MODE.getValue() )).

setCacheFile

public void setCacheFile(java.lang.String file,
                         SoDirectVizManager.CacheModes mode)

Deprecated.

Specifies cache file as an absolute path name.
Cache files can be used for either reading or writing depending on mode:

• READ_WRITE_MODE (default): the file is used for both reading and writing.
  
• READ_MODE: the file is only used for reading. The file will not be erased when a cache is written.
  
• WRITE_MODE: the file is only used for writing.

getNumEnvironmentLights

public int getNumEnvironmentLights()

Deprecated.

Returns number of environment lights (see field numEnvLights).

setCamera

public void setCamera(SoCamera camera)

Deprecated.

Set the camera to use for rendering. This method should only be called when using DirectViz rendering outside of a standard Open Inventor viewer based on SoGuiViewer (e.g. custom viewer usage).

Since:

Open Inventor 9.3

setCacheDirectory

public void setCacheDirectory(java.lang.String directory)

Deprecated.

Specifies cache directory (it must be an absolute path).
The initial value can be set using the environment variable DIRECTVIZ_CACHE_DIR. See SoPreferences.

getRenderedImageSize

public SbVec2s getRenderedImageSize()

Deprecated.

Gets the size of rendered image in pixels.

getCurrentAccumValue

public int getCurrentAccumValue()

Deprecated.

Gets the current accumulation value.

getInstance

public static SoDirectVizManager getInstance(SoSceneManager mgr)

Deprecated.

Returns a pointer to a DirectVizManager object associated with the specified scene manager.
If DirectViz was already associated with a scene manager, calling getInstance() with another scene manager will deactivate DirectViz on the previously associated scene manager. To retrieve the scene manager corresponding to a viewer or render area, you can use code similar to:

 pViewer->getSceneManager();

getLastRenderTime

public double getLastRenderTime()

Deprecated.

Gets the elapsed time for rendering the last frame in seconds.