Package com.openinventor.ldm.nodes

Class SoDataCompositor

  • All Implemented Interfaces:
    SafeDisposable
    public class SoDataCompositor
extends SoNode
    Data set compositor node. The SoDataCompositor node allows you to combine multiple data sets in memory instead of having to store the combined data sets on disk. For example, it can be used to visualize the result of the difference between two data sets. Notice: The SoDataCompositor cannot be used for unary operation (the number of data set used with a data compositor must be stricly greater than one). Unary operation can be performed using the SoLDMDataTransformCB (see SoDataSet node).

    NOTE: This node is only useful in LDM mode.

    A number of rules apply to the use of SoDataCompositor:

    For example, to realize the difference of two data sets, only the SoDataCompositor node, the SoDataSet nodes, and the rendering primitive node must be inserted under the SoMultiDataSeparator node created to handle the composition.

    Each SoDataSet following the compositor must have the same exact dimensions. However, the data set nodes can have different voxel data types (bytes per voxel). The final voxel data type is specified by the data compositor node through the dataType field.

    If the rgbaMode field is set to true, then dataType and numSigBits are ignored, and the output data is generated as UNSIGNED_INT32 with 32 significant bits.

    The SoDataCompositor node offers different default composition operators (see preDefCompositor) but it is possible to create a customized operator by subclassing the node and redefining one of the compose methods. To use the custom operator, the preDefCompositor field must be set to NONE.

    File format/default:

    DataCompositor{

      dataType UNSIGNED_BYTE
      numSigBits 0
      rgbaMode false
      preDefCompositor MINUS
      convert true
    }

    Action behavior:

    SoCallbackAction, SoGLRenderAction, SoWriteAction, SoGetBoundingBoxAction, SoPickAction
    Sets data compositor parameters in the traversal state.

    See Also:
    SoDataSet, SoLDMDataTransform, SoVolumeTransform

    • Field Detail

      • dataType

        public final SoSFEnum<SoDataCompositor.DataTypes> dataType
        Data type of the final composed buffer. . Default is UNSIGNED_BYTE. NOTE: If rgbaMode is true, this field is ignored and the output buffer is UNSIGNED_INT32.

      • numSigBits

        public final SoSFShort numSigBits
        Number of significant bits of the final composed datum.
        Default is 0 meaning all bits are significant. If this field is set to 24 on an UNSIGNED_INT32 data type, only the lowest 24 bits will be taken into account when creating textures. NOTES

        : If rgbaMode is true, this field is ignored and all 32 bits are significant.

      • rgbaMode

        public final SoSFBool rgbaMode
        Final composed buffer contains RGBA values (default is false).
        If set to true then the dataType and numSigBits fields are ignored and the output data is UNSIGNED_INT32 with 32 significant bits.

      • preDefCompositor

        public final SoSFEnum<SoDataCompositor.PreDefCompositors> preDefCompositor
        Predefined composition method. . Default is MINUS. If preDefCompositor is set to NONE, then LDM will call one of the virtual compose methods. Otherwise it will use the specified composition operator.

      • convert

        public final SoSFBool convert
        If the convert field is true, LDM will call the compose method after automatically converting data to the final data type if necessary. Otherwise the compose method is called without conversion and the application is responsible for handling the conversion. Default is true.

    • Constructor Detail

      • SoDataCompositor

        public SoDataCompositor()

    • Method Detail

      • compose

        public void compose​(SbVec3i32 tile_dimension,
                    int[] dataset_ids,
                    java.nio.ByteBuffer[] input_buffer,
                    int[] data_types,
                    java.nio.ByteBuffer output_buffer)
        The compose method can be overridden in a subclass to specify a custom composition.
        Inputs are:
        • tile_dimension specifies the dimension of the tile (same for each data set).
        • dataset_ids is an array of integers giving the id of each data set (set by the SoDataSet.dataSetId field of the SoDataSet node).
        • input_buffer is an array of buffers containing the tile of each data set. For example, input_buffer[0] is the data corresponding to the data set with id volume_ids[0] . If the field convert is true, the argument data_types is null and each tile has already been converted to the final data type (dataType field) if necessary. Otherwise (convert is false) data_types[i] is the data type of input_buffer[i].
        • output_buffer is the buffer to fill with the composed data (allocated by LDM, filled in by the compose method). The output_buffer is of type dataType (number of bytes returned by getDataSize()).

      • getDataSize

        public int getDataSize()
        Returns number of bytes for output datum.

      • isDataSigned

        public static boolean isDataSigned​(SoDataCompositor.DataTypes dataType)
        Returns true if the given data type is a signed integer data type.
        Note: If rgbaMode is true, then the data is considered to be UNSIGNED_INT32 (not signed).

      • getNumSigBits

        public int getNumSigBits()
        Returns the output number of significant bits.

      • compose

        public int[] compose​(int numDataSet,
                     SbVec3i32 tileDimension,
                     SoBufferObject[] inputBuffer,
                     SoBufferObject outputBuffer)
        The compose method can be overridden in a subclass to specify a custom composition. Inputs are:
        • numDataSet is the number of data sets to compose.
        • tileDimension specifies the dimension of the tile (same for each data set).
        • vdid is an array of integers giving the id of each data set (set by the dataSetId field of the SoDataSet node).
        • inputBuffer is an array of buffers containing the tile of each data set. For example, inputBuffer[0] is the data corresponding to the data set with id vdid[0] . Each tile has already been converted to the final data type (dataType field) if necessary.
        • outputBuffer is the buffer to fill with the composed data (allocated by LDM, filled in by the compose method). The outputBuffer is of type dataType (number of bytes returned by getDataSize).

        NOTE: For compatibility purposes, if this method is not redefined then the version with void* parameters instead of SoBufferObject* will be used.