com.openinventor.ldm.nodes

Class SoDataCompositor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.ldm.nodes.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:

• The SoDataCompositor node and SoDataSet nodes must be children of an SoMultiDataSeparator node (an ordinary SoSeparator will not work correctly).
• The SoDataCompositor node must be inserted before the SoDataSet nodes in the scene graph.
• No rendering primitives (e.g., SoOrthoSlice, SoVolumeRender) are allowed between the SoDataSet nodes that are used for the composition.
• A SoDataSet node used for data compositing should not be referenced twice in the scene graph. Another data set node pointing to the same file should rather be instantiated).
• All nodes needed to realize the compositing must be under the same SoSeparator node.
• No other nodes must be under this SoSeparator node.
• It is not possible to mix SoDataSet nodes used for compositing with SoDataSet nodes used for normal rendering under the same SoSeparator.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoDataCompositor.DataTypes Supported data types.
static class	SoDataCompositor.PreDefCompositors Predefined compositor.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD Deprecated. Use SoDataCompositor.PreDefCompositors.ADD instead.
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.
SoSFEnum<SoDataCompositor.DataTypes>	dataType Data type of the final composed buffer.
static int	FLOAT Deprecated. Use SoDataCompositor.DataTypes.FLOAT instead.
static int	MINUS Deprecated. Use SoDataCompositor.PreDefCompositors.MINUS instead.
static int	MULTIPLY Deprecated. Use SoDataCompositor.PreDefCompositors.MULTIPLY instead.
static int	NONE Deprecated. Use SoDataCompositor.PreDefCompositors.NONE instead.
SoSFShort	numSigBits Number of significant bits of the final composed datum.
SoSFEnum<SoDataCompositor.PreDefCompositors>	preDefCompositor Predefined composition method.
SoSFBool	rgbaMode Final composed buffer contains RGBA values (default is false).
static int	SIGNED_BYTE Deprecated. Use SoDataCompositor.DataTypes.SIGNED_BYTE instead.
static int	SIGNED_INT32 Deprecated. Use SoDataCompositor.DataTypes.SIGNED_INT32 instead.
static int	SIGNED_SHORT Deprecated. Use SoDataCompositor.DataTypes.SIGNED_SHORT instead.
static int	UNSIGNED_BYTE Deprecated. Use SoDataCompositor.DataTypes.UNSIGNED_BYTE instead.
static int	UNSIGNED_INT32 Deprecated. Use SoDataCompositor.DataTypes.UNSIGNED_INT32 instead.
static int	UNSIGNED_SHORT Deprecated. Use SoDataCompositor.DataTypes.UNSIGNED_SHORT instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoDataCompositor()

Method Summary

Modifier and Type	Method and Description
int[]	compose(int numDataSet, SbVec3i32 tileDimension, SoBufferObject[] inputBuffer, SoBufferObject outputBuffer) The compose method can be overridden in a subclass to specify a custom composition.
void	compose(SbVec3i32 tile_dimension, int[] dataset_ids, java.nio.Buffer[] input_buffer, int[] data_types, java.nio.Buffer output_buffer) Deprecated. use #compose(SbVec3i, int[], ByteBuffer[], int[], ByteBuffer) instead.
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.
int	getDataSize() Returns number of bytes for output datum.
SoDataCompositor.DataTypes	getDataType() Returns the output data type.
int	getNumSigBits() Returns the output number of significant bits.
static boolean	isDataSigned(SoDataCompositor.DataTypes dataType) Returns true if the given data type is a signed integer data type.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNSIGNED_BYTE

@Deprecated
public static final int UNSIGNED_BYTE

Deprecated. Use SoDataCompositor.DataTypes.UNSIGNED_BYTE instead.

UNSIGNED_SHORT

@Deprecated
public static final int UNSIGNED_SHORT

Deprecated. Use SoDataCompositor.DataTypes.UNSIGNED_SHORT instead.

UNSIGNED_INT32

@Deprecated
public static final int UNSIGNED_INT32

Deprecated. Use SoDataCompositor.DataTypes.UNSIGNED_INT32 instead.

SIGNED_BYTE

@Deprecated
public static final int SIGNED_BYTE

Deprecated. Use SoDataCompositor.DataTypes.SIGNED_BYTE instead.

SIGNED_SHORT

@Deprecated
public static final int SIGNED_SHORT

Deprecated. Use SoDataCompositor.DataTypes.SIGNED_SHORT instead.

SIGNED_INT32

@Deprecated
public static final int SIGNED_INT32

Deprecated. Use SoDataCompositor.DataTypes.SIGNED_INT32 instead.

FLOAT

@Deprecated
public static final int FLOAT

Deprecated. Use SoDataCompositor.DataTypes.FLOAT instead.

NONE

@Deprecated
public static final int NONE

Deprecated. Use SoDataCompositor.PreDefCompositors.NONE instead.

MINUS

@Deprecated
public static final int MINUS

Deprecated. Use SoDataCompositor.PreDefCompositors.MINUS instead.

ADD

@Deprecated
public static final int ADD

Deprecated. Use SoDataCompositor.PreDefCompositors.ADD instead.

MULTIPLY

@Deprecated
public static final int MULTIPLY

Deprecated. Use SoDataCompositor.PreDefCompositors.MULTIPLY instead.

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()).

compose

public void compose(SbVec3i32 tile_dimension,
                    int[] dataset_ids,
                    java.nio.Buffer[] input_buffer,
                    int[] data_types,
                    java.nio.Buffer output_buffer)

Deprecated. use #compose(SbVec3i, int[], ByteBuffer[], int[], ByteBuffer) instead.

getDataType

public SoDataCompositor.DataTypes getDataType()

Returns the output data type.

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.

getDataSize

public int getDataSize()

Returns number of bytes for output datum.

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.