Click or drag to resize
SoMultiDataSeparator Class

Separator for combining multiple data sets.

Inheritance Hierarchy

Namespace: OIV.LDM.Nodes
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 9.9.36.0 (9.9.36.0)
Syntax
public class SoMultiDataSeparator : SoSeparator

The SoMultiDataSeparator type exposes the following members.

Constructors
  NameDescription
Public methodSoMultiDataSeparator

Constructor.

Top
Methods
  NameDescription
Public methodAddChild

Adds a child as last one in group.

(Inherited from SoGroup.)
Public methodAffectsState
(Inherited from SoSeparator.)
Public methodCallback
(Inherited from SoSeparator.)
Public methodClearCacheList
(Inherited from SoSeparator.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoSeparator.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodFindChild

Finds index of given child within group.

(Inherited from SoGroup.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
Public methodGetChild

Returns pointer the child node with the given index.

(Inherited from SoGroup.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLdmManagerAccess

Returns a reference to an LDMManagerAccess.

Public methodGetMatrix
(Inherited from SoSeparator.)
Public methodGetMediator

Return the mediator of this node.

Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumChildren

Returns number of children.

(Inherited from SoGroup.)
Public methodGetPrimitiveCount
(Inherited from SoSeparator.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
Public methodGLRenderBelowPath
Public methodGLRenderInPath
Public methodGLRenderOffPath
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoSeparator.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInsertChild

Adds a child so that it becomes the one with the given index.

(Inherited from SoGroup.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to known if bounding box computation should be ignored or not.

(Inherited from SoGroup.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoGroup.)
Public methodRayPick
(Inherited from SoSeparator.)
Public methodRemoveAllChildren

Removes all children from group.

(Inherited from SoGroup.)
Public methodRemoveChild(Int32)

Removes child with given index from group.

(Inherited from SoGroup.)
Public methodRemoveChild(SoNode)

Removes first instance of given child from group.

(Inherited from SoGroup.)
Public methodReplaceChild(Int32, SoNode)

Replaces child with given index with new child.

(Inherited from SoGroup.)
Public methodReplaceChild(SoNode, SoNode)

Replaces first instance of given child with new child.

(Inherited from SoGroup.)
Public methodSearch
(Inherited from SoSeparator.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
Top
Properties
  NameDescription
Public propertyboundingBoxCaching

Whether to cache during bounding box traversal.

(Inherited from SoSeparator.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoGroup.)
Public propertydirectVizCaching

Whether to cache during OpenRTRT rendering traversal.

(Inherited from SoSeparator.)
Public propertyfastEditing

Specifies the fast edit mode of the separator node.

(Inherited from SoSeparator.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypickCulling

Whether to cull during picking traversal.

(Inherited from SoSeparator.)
Public propertyrenderCaching

Whether to cache during rendering traversal.

(Inherited from SoSeparator.)
Public propertyrenderCulling

Whether to cull during rendering traversal.

(Inherited from SoSeparator.)
Public propertyrenderUnitId

Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

(Inherited from SoSeparator.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

The 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 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 SoDataSet node (typically an SoVolumeData node). Combining is enabled by an SoDataCompositor node for CPU combining or an 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 SoVolumeData node must have a unique SoDataSet.dataSetId.

  • All the SoVolumeData nodes to be composited must have the same volume dimensions (number of voxels in X, Y, and Z) and tile size.

  • All the SoVolumeData nodes to be composited, as well as the compositing node (e.g. SoVolumeShader for slices or SoVolumeRenderingQuality for volumes) and the rendering node (e.g. SoVolumeRender), must be under an SoMultiDataSeparator node.

  • The 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 SoMultiDataSeparator, set the usePalettedTexture field to false in the scalar dataset's SoVolumeData node to force the scalar data to be converted into RGBA data.

  • An 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 SoVolumeData node has its own resource settings (see field SoDataSet.ldmResourceParameters). The resources required for the composition are the sum of the resources for all of the 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 SoVolumeShader node. The shader source code is loaded using (for example) an SoFragmentShader object. Uniform parameters for the shader may be specified using the subclasses of SoShaderParameter. See SoVolumeShader for more information about the shader function library provided by VolumeViz.

For each data set there will typically be an SoDataRange node and an SoTransferFunction node to define the mapping from data values to color values. For each 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 SoDataSet.texturePrecision field. The texture unit used for each data set is determined by the SoDataSet.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 );
A custom fragment shader can lookup the color/intensity for each data value from the appropriate colormap, using the GLSL VolumeViz function:
vec4 color = VVizTransferFunction( value, colorMapId );
A custom fragment shader can then compute (using custom blending functions) the actual color for the voxel and output that color using the GLSL VolumeViz function:
VVizOutputColor( color ):

EXAMPLE

The following code shows how to do multidata rendering using an SoVolumeShader node to combine values for an SoVolumeRender node. Given two 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);

See Also