SoMultiDataSeparator Class |
Separator for combining multiple data sets.
Namespace: OIV.LDM.Nodes
The SoMultiDataSeparator type exposes the following members.
Name | Description | |
---|---|---|
SoMultiDataSeparator | Constructor. |
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 | (Overrides SoSeparatorDoAction(SoAction).) | |
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. | |
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 | (Overrides SoSeparatorGetBoundingBox(SoGetBoundingBoxAction).) | |
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.) | |
GetMediator | Return the mediator of this node. | |
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 | (Overrides SoSeparatorGLRender(SoGLRenderAction).) | |
GLRenderBelowPath | (Overrides SoSeparatorGLRenderBelowPath(SoGLRenderAction).) | |
GLRenderInPath | (Overrides SoSeparatorGLRenderInPath(SoGLRenderAction).) | |
GLRenderOffPath | (Overrides SoSeparatorGLRenderOffPath(SoGLRenderAction).) | |
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 | (Overrides SoGroupWrite(SoWriteAction).) |
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.) | |
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.) |
The OIV.LDM.Nodes.SoMultiDataSeparator node allows you to combine multiple data sets.
This is the correct method for combining multiple data sets. Combining multiple data sets without inserting them under an OIV.LDM.Nodes.SoMultiDataSeparator node may produce incorrect results and should be avoided.
All data sets below this node belong to the same group for subsequent multidata combining operations. Each data set is represented by an OIV.LDM.Nodes.SoDataSet node (typically an OIV.VolumeViz.Nodes.SoVolumeData node). Combining is enabled by an OIV.LDM.Nodes.SoDataCompositor node for CPU combining or an OIV.VolumeViz.Nodes.SoVolumeShader node for GPU combining. A common use of GPU combining is to implement co-blending of multiple volumes, in other words using a fragment shader to combine the color and/or intensity values of the voxels.
Some rules must be followed when doing render or data compositing:
Each OIV.VolumeViz.Nodes.SoVolumeData node must have a unique OIV.LDM.Nodes.SoDataSet.m_dataSetId.
All the OIV.VolumeViz.Nodes.SoVolumeData nodes to be composited must have the same volume dimensions (number of voxels in X, Y, and Z) and tile size.
All the OIV.VolumeViz.Nodes.SoVolumeData nodes to be composited, as well as the compositing node (e.g. OIV.VolumeViz.Nodes.SoVolumeShader for slices or OIV.VolumeViz.Nodes.SoVolumeRenderingQuality for volumes) and the rendering node (e.g. OIV.VolumeViz.Nodes.SoVolumeRender), must be under an OIV.LDM.Nodes.SoMultiDataSeparator node.
The OIV.VolumeViz.Nodes.SoVolumeData nodes to be composited must be all scalar data sets or all RGBA data sets. To composite scalar and RGBA data sets under the same OIV.LDM.Nodes.SoMultiDataSeparator, set the usePalettedTexture field to false in the scalar dataset's OIV.VolumeViz.Nodes.SoVolumeData node to force the scalar data to be converted into RGBA data.
An OIV.VolumeViz.Nodes.SoVolumeData node used in a data compositing scheme must not be inserted multiple times in the scene graph. Use another volume data node pointing to the same file.
Each OIV.VolumeViz.Nodes.SoVolumeData node has its own resource settings (see field OIV.LDM.Nodes.SoDataSet.m_ldmResourceParameters). The resources required for the composition are the sum of the resources for all of the OIV.VolumeViz.Nodes.SoVolumeData nodes involved. *
All transfer functions must have the same 'colorMapType' and must have the same number of entries in the colormap.
GPU combining must be implemented in a shader program written in the standard GLSL language. The shader program will be specified using an OIV.VolumeViz.Nodes.SoVolumeShader node. The shader source code is loaded using (for example) an OIV.Inventor.Nodes.SoFragmentShader object. Uniform parameters for the shader may be specified using the subclasses of OIV.Inventor.Nodes.SoShaderParameter. See OIV.VolumeViz.Nodes.SoVolumeShader for more information about the shader function library provided by VolumeViz.
For each data set there will typically be an OIV.LDM.Nodes.SoDataRange node and an OIV.LDM.Nodes.SoTransferFunction node to define the mapping from data values to color values. For each OIV.VolumeViz.Nodes.SoVolumeData a separate 3D texture will be generated and sent to the GPU. 3D textures can be generated with different precision (8-bit or 12-bit) according to the OIV.LDM.Nodes.SoDataSet.m_texturePrecision field. The texture unit used for each data set is determined by the OIV.LDM.Nodes.SoDataSet.m_dataSetId field. All colormaps are aggregated into a single 2D texture.
A custom fragment shader can retrieve the voxel's data value from each 3D texture using the GLSL VolumeViz function:
VVIZ_DATATYPE value = VVizGetData( dataSetId, texCoord );
vec4 color = VVizTransferFunction( value, colorMapId );
VVizOutputColor( color ):
The following code shows how to do multidata rendering using an OIV.VolumeViz.Nodes.SoVolumeShader node to combine values for an OIV.VolumeViz.Nodes.SoVolumeRender node. Given two OIV.VolumeViz.Nodes.SoVolumeData nodes ds1 and ds2:
SoVolumeShader volumeShader = new SoVolumeShader(); SoVolumeData volumeData1 = new SoVolumeData(); volumeData1.dataSetId.Value = 0; SoDataRange dataRange1 = new SoDataRange(); dataRange1.dataRangeId.Value = 0; SoTransferFunction colorMap1 = new SoTransferFunction(); SoVolumeData volumeData2 = new SoVolumeData(); volumeData2.dataSetId.Value = 1; SoDataRange dataRange2 = new SoDataRange(); dataRange2.dataRangeId.Value = 1; SoTransferFunction colorMap2 = new SoTransferFunction(); SoVolumeRender volumeRender = new SoVolumeRender(); SoMultiDataSeparator multiDataSep = new SoMultiDataSeparator(); multiDataSep.AddChild( volumeShader ); // Shader to combine volumes multiDataSep.AddChild( volumeData1 ); multiDataSep.AddChild( dataRange1 ); multiDataSep.AddChild( colorMap1 ); multiDataSep.AddChild( volumeData2 ); multiDataSep.AddChild( dataRange2 ); multiDataSep.AddChild( colorMap2 ); multiDataSep.AddChild( volumeRender ); root.AddChild(multiDataSep);