| SoOffscreenVolumeRender Class |
Extract data from an OIV.VolumeViz.Nodes.SoVolumeRender.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.VolumeViz.NodesSoOffscreenVolumeRender
Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoOffscreenVolumeRender 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 | Determines whether the specified Object is equal to the current Object. (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.) |
| 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.) |
| GetMatrix | (Inherited from SoNode.) |
| GetMaxBoxSize | Calls GetMaxBoxSize((OIV.Inventor.Misc.SoState ^)nullptr). |
| GetMaxBoxSize(SoState) | Returns the maximum boxSize that can be extract in one boxComputed for the current state. |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | reimplement GLRender behavior to launch computation when trigger touch |
| 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. |
| IjkToXyzBox | Convert ijk box coordinates returned by boxComputed method to the bboxSceneGraph space. |
| 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. |
| 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. |
| SynchronousExtraction | Does extraction synchronously, whereas using trigger field will execute extraction on next redraw. |
| 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 | |
|---|---|---|
 | bboxSceneGraph | Head of the scene graph that defines the 3D off-screen scene cube to consider in world coordinates. |
| boxSize | Resolution of the output data in the off-screen box. |
| components | Components to get back from the offscreen render. |
| dataSpaceMatrix | This transformation is applied on the volume render texture coordinate during the extraction. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| opacityThreshold | During extraction, voxels with an opacity less than the specified value will be ignored Default is 0. |
| trigger | Setting this field to true will start the off-screen rendering process. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| volumerenderSceneGraph | Head of the scene graph that contains one or multiple VolumeRender node to render in 3D off-screen cube. |
RemarksThe OIV.VolumeViz.Nodes.SoOffscreenVolumeRender node extracts data by rendering one or more volumes (via OIV.VolumeViz.Nodes.SoVolumeRender) into a buffer that can then be used for different computation tasks.
Volumes of interest are specified by a subscenegraph in OIV.VolumeViz.Nodes.SoOffscreenVolumeRender.volumerenderSceneGraph.
The region to be extracted is the bounding box of the scene graph specified in the OIV.VolumeViz.Nodes.SoOffscreenVolumeRender.bboxSceneGraph field.
To implement an extraction, the application must derive a new class from OIV.VolumeViz.Nodes.SoOffscreenVolumeRender and implement :
the boxComputed method. This method is called with parameters that give access to information about the processed box.
the getNextSubBox method. This method must return subBox size smaller than getMaxBoxSize. We recommend to request subbox even smaller in order to get more parallelism between extraction processing (done on GPU) and application processing and reduce peak GPU memory resources used.
The resolution of the extraction is controlled by OIV.VolumeViz.Nodes.SoOffscreenVolumeRender.boxSize field. As extraction is done using GPU techniques, there is a size limit on the boxSize that can be extract in one call. This limit can be retreived through getMaxBoxSize call.
Limitations:
It is not possible to extract a volume displayed as an isosurface (via OIV.VolumeViz.Nodes.SoVolumeDataDrawStyle or OIV.VolumeViz.Nodes.SoVolumeIsosurface).
OIV.Inventor.Nodes.SoResetTransform node usage should be avoided in volumeRenderSceneGraph or bboxSceneGraph scene graph, in order to get the best extraction precision even with very flat extraction box. In general it is possible to use OIV.Inventor.Nodes.SoTransformSeparator node instead.
FILE FORMAT/DEFAULT
OIV.VolumeViz.Nodes.SoOffscreenVolumeRender {
| volumerenderSceneGraph | NULL |
| bboxSceneGraph | NULL |
| boxSize | (64, 64, 64) |
| trigger | false |
| opacityThreshold | 0 |
| components | ALPHA |
See Also