| SoDirectVizManager Class |
Note: This API is now obsolete.
Manages ray-traced rendering.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.DirectVizSoDirectVizManager
Namespace: OIV.DirectViz
Assembly: OIV.DirectViz (in OIV.DirectViz.dll) Version: 9.9.13.0 (9.9.13.0)
SyntaxThe SoDirectVizManager type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoNode.) |
| GetCurrentAccumValue | Gets the current accumulation value. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
 | GetInstance | Returns a pointer to a DirectVizManager object associated with the specified scene manager. |
| GetLastRenderTime | Gets the elapsed time for rendering the last frame in seconds. |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetNumEnvironmentLights | Returns number of environment lights (see field numEnvLights). |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderedImageSize | Gets the size of rendered image in pixels. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoNode.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetCacheDirectory | Specifies cache directory (it must be an absolute path). |
| SetCacheFile(String) | Calls SetCacheFile(file, OIV.DirectViz.SoDirectVizManager.CacheModes( .SoDirectVizManager.READ_WRITE_MODE )). |
| SetCacheFile(String, SoDirectVizManagerCacheModes) | Specifies cache file as an absolute path name. |
| SetCamera | Set the camera to use for rendering. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | accumulation | Activates/deactivates accumulation passes. |
| adaptiveOversampling | Enables/disables adaptive oversampling rendering. |
| controlDialog | Enables/disables the DirectViz control dialog. |
| envLightIntensityScale | Intensity scale applied to environment lights defined by numEnvLights. |
| fileCaching | Enables/disables acceleration structure cache file. |
| fuzzyLights | Enables/disables fuzzy effects globally in the scene graph. |
| globalShadowing | Enables/disables shadows globally in the scene graph. |
| glossySurfaces | Enables/disables glossy surfaces effects globally in the scene graph. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| maxAccumulationValue | Specifies a maximum number of accumulation passes. |
| numEnvLights | Enables/disables environment lighting by specifying the number of lights. |
| numProgressiveRenderingSteps | Specifies the number of steps (intermediate images) between subsampled rendering and full resolution rendering. |
| progressiveRendering | Activates/deactivates rendering with progressive resolution. |
| recursionLimit | Specifies the recursion depth limit. |
| rendering | Activates/deactivates ray-traced rendering. |
| softShadows | Enables/disables soft shadows globally in the scene graph. |
| subRecursion | Enables/disables recursion when subsampling the scene. |
| subSampling | Activates/deactivates image sub-sampling. |
| subSamplingFactor | Specifies the sub-sampling factor. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksSoDirectVizManager 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 areaSoDirectVizManager 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