| SoVolumeGroup Class |
Groups multiple volumes to be volume rendered in the same scene.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoGroup
OIV.Inventor.NodesSoSeparator
OIV.VolumeViz.NodesSoVolumeGroup
Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoVolumeGroup type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVolumeGroup | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AddChild | Adds a child as last one in group. |
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoSeparator.) |
| ClearCacheList | (Inherited from SoSeparator.) |
| 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 SoSeparator.) |
| 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. |
| FindChild | Finds index of given child within group. |
| 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 SoSeparator.) |
| GetChild | Returns pointer the child node with the given index. |
| 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 SoSeparator.) |
| GetName | Returns the name of an instance. |
| GetNumChildren | Returns number of children. |
| GetPrimitiveCount | (Inherited from SoSeparator.) |
| 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 | (Inherited from SoSeparator.) |
| GLRenderBelowPath | (Overrides SoSeparatorGLRenderBelowPath(SoGLRenderAction).) |
| GLRenderInPath | (Overrides SoSeparatorGLRenderInPath(SoGLRenderAction).) |
| GLRenderOffPath | (Inherited from SoSeparator.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoSeparator.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| InsertChild | Adds a child so that it becomes the one with the given index. |
| IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. |
| 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 SoGroup.) |
| RayPick | (Inherited from SoSeparator.) |
| RemoveAllChildren | Removes all children from group. |
| RemoveChild(Int32) | Removes child with given index from group. |
| RemoveChild(SoNode) | Removes first instance of given child from group. |
| ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. |
| ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. |
| Search | (Inherited from SoSeparator.) |
| 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. |
| 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 SoGroup.) |
Properties| Name | Description | |
|---|---|---|
 | boundingBoxCaching | (Inherited from SoSeparator.) |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| fastEditing | Specifies the fast edit mode of the separator node. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| multiVolumes | Activates the multi-volumes feature. |
| pickCulling | Whether to cull during picking traversal. |
| renderCaching | Obsolete. Whether to cache during rendering traversal. |
| renderCulling | Whether to cull during rendering traversal. |
| renderUnitId | Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThe OIV.VolumeViz.Nodes.SoVolumeGroup node allows multiple volumes to be volume rendered (OIV.VolumeViz.Nodes.SoVolumeRender) correctly in the same scene. All OIV.VolumeViz.Nodes.SoVolumeRender nodes that are under an active OIV.VolumeViz.Nodes.SoVolumeGroup node (OIV.VolumeViz.Nodes.SoVolumeGroup.multiVolumes=true) are rendered together with correct blending, subject to some limitations. Other VolumeViz geometry objects, for example OIV.VolumeViz.Nodes.SoOrthoSlice, are not affected by OIV.VolumeViz.Nodes.SoVolumeGroup.
The OIV.VolumeViz.Nodes.SoVolumeRender nodes can represent different volume data sets (see OIV.VolumeViz.Nodes.SoVolumeData) or different subvolumes (see OIV.LDM.Nodes.SoROI) of the same volume data set.
This node forces the use of view-aligned slices for OIV.VolumeViz.Nodes.SoVolumeRender nodes that will be composed. It doesn't, however, actually modify the OIV.VolumeViz.Nodes.SoVolumeRender.samplingAlignment fields. Rather the values of these fields are ignored during traversal.
The OIV.VolumeViz.Nodes.SoVolumeGroup.multiVolumes field (true by default) controls whether the OIV.VolumeViz.Nodes.SoVolumeGroup's special handling of OIV.VolumeViz.Nodes.SoVolumeRender nodes is applied. If the (sub)volumes being rendered do not overlap in 3D space or only one of the volumes is transparent, then OIV.VolumeViz.Nodes.SoVolumeGroup special handling is automatically disabled.
OIV.VolumeViz.Nodes.SoVolumeGroup is primarily intended for cases where the volumes are sampled on different grids. For example if the volume dimension, size (3D extent) or orientation are different. For volumes that are actually multiple data sets sampled on the same grid, for example seismic attribute volumes, it may be more appropriate to blend the volumes using an OIV.LDM.Nodes.SoDataCompositor or OIV.VolumeViz.Nodes.SoVolumeShader node.
Since OIV 9.3, EdgeDetection (Gradient, Luminance, Depth) and LowResMode (DECREASE_SCREEN_RESOLUTION) effects are supported. These post process effects need to be applied to all or none of the volumes. If all fields corresponding to an effect are the same for each volume, the effect is activated. If fields are different then default value is used.
Limitations:
Performance: There is a significant performance decrease when OIV.VolumeViz.Nodes.SoVolumeGroup.multiVolumes is enabled.
Shaders: Using custom shaders (e.g. OIV.VolumeViz.Nodes.SoVolumeShader or OIV.VolumeViz.Nodes.SoVolumeRenderingQuality) when OIV.VolumeViz.Nodes.SoVolumeGroup.multiVolumes is enabled gives incorrect lighting results.
Raycasting: The volume raycasting render algorithm (SoVolumeShader.raycasting) is not supported when OIV.VolumeViz.Nodes.SoVolumeGroup.multiVolumes is enabled. This implies that ray-casting effects like voxelizedRendering, ambientOcclusion (OIV.VolumeViz.Nodes.SoVolumeRenderingQuality) and samplingAlignment = BOUNDARY_ALIGNED (OIV.VolumeViz.Nodes.SoVolumeRender) are not supported. When OIV.VolumeViz.Nodes.SoVolumeGroup.multiVolumes is enabled, VolumeViz will automatically switch to "sliced" (texture mapped polygon) rendering.
Post process: AmbientOcclusion and deferredLighting features are not supported when multiVolumes is enabled.
Shadows: 32-bit framebuffer options (see e.g. OIV.Inventor.Win.SoWinGLWidget.SetFloatingColorBuffer(System.Boolean, OIV.Inventor.Win.SoWinGLWidget.FloatColorBufferSizes)) cannot be used if an OIV.VolumeViz.Nodes.SoVolumeGroup is inside an OIV.Inventor.Nodes.SoShadowGroup (request is ignored).
FILE FORMAT/DEFAULT
VolumeRender {
| multiVolumes | true |
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction Draws a volume-rendered image based on current OIV.VolumeViz.Nodes.SoVolumeData.
OIV.Inventor.Actions.SoGetBoundingBoxAction Computes the bounding box that encloses the volume.
See Also