Data set compositor node More...
#include <LDM/nodes/SoDataCompositor.h>
Public Types | |
enum | DataType { UNSIGNED_BYTE = SbDataType::UNSIGNED_BYTE, UNSIGNED_SHORT = SbDataType::UNSIGNED_SHORT, UNSIGNED_INT32 = SbDataType::UNSIGNED_INT32, SIGNED_BYTE = SbDataType::SIGNED_BYTE, SIGNED_SHORT = SbDataType::SIGNED_SHORT, SIGNED_INT32 = SbDataType::SIGNED_INT32, FLOAT = SbDataType::FLOAT } |
enum | PreDefCompositor { NONE, MINUS, ADD, MULTIPLY } |
Public Member Functions | |
virtual SoType | getTypeId () const |
SoDataCompositor () | |
virtual void | compose (int numDataSet, const SbVec3i32 &tileDimension, int *vdid, SoBufferObject **inputBuffer, SoBufferObject *outputBuffer) |
virtual void | compose (int numDataSet, const SbVec3i32 &tileDimension, int *vdid, SoBufferObject **inputBuffer, SoDataCompositor::DataType *dataTypes, SoBufferObject *outputBuffer) |
int | getDataSize () const |
int | getNumSigBits () const |
DataType | getDataType () const |
Static Public Member Functions | |
static SoType | getClassTypeId () |
static SbBool | isDataSigned (DataType dataType) |
Public Attributes | |
SoSFEnum | dataType |
SoSFShort | numSigBits |
SoSFBool | rgbaMode |
SoSFEnum | preDefCompositor |
SoSFBool | convert |
Deprecated | |
| |
virtual SoDEPRECATED void | compose (int numDataSet, const SbVec3i32 &tileDimension, int *vdid, void **inputBuffer, void *outputBuffer) |
virtual SoDEPRECATED void | compose (int numDataSet, const SbVec3i32 &tileDimension, int *vdid, void **inputBuffer, SoDataCompositor::DataType *dataTypes, void *outputBuffer) |
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.
dataType | UNSIGNED_BYTE |
numSigBits | 0 |
rgbaMode | FALSE |
preDefCompositor | MINUS |
convert | TRUE |
SoDataSet, SoLDMDataTransform, SoVolumeTransform
MedicalCPUDataCompose, MedicalGPUDataCompose, CpuDataCompose
SoDataCompositor::SoDataCompositor | ( | ) |
Constructor.
virtual SoDEPRECATED void SoDataCompositor::compose | ( | int | numDataSet, | |
const SbVec3i32 & | tileDimension, | |||
int * | vdid, | |||
void ** | inputBuffer, | |||
SoDataCompositor::DataType * | dataTypes, | |||
void * | outputBuffer | |||
) | [virtual] |
virtual SoDEPRECATED void SoDataCompositor::compose | ( | int | numDataSet, | |
const SbVec3i32 & | tileDimension, | |||
int * | vdid, | |||
void ** | inputBuffer, | |||
void * | outputBuffer | |||
) | [virtual] |
virtual void SoDataCompositor::compose | ( | int | numDataSet, | |
const SbVec3i32 & | tileDimension, | |||
int * | vdid, | |||
SoBufferObject ** | inputBuffer, | |||
SoDataCompositor::DataType * | dataTypes, | |||
SoBufferObject * | outputBuffer | |||
) | [virtual] |
Same as the compose method described above with one additional parameter: dataTypes is an array of SoDataSet::dataType giving the data type of each input buffer (e.g., inputBuffer[0] is of data type dataTypes[0]).
This compose method is called if the convert field is set to FALSE. In this case LDM does not automatically convert data to the final data type, and the application is responsible for doing the conversion if necessary.
NOTE: For compatibility purposes, if this method is not redefined then the version with void* parameters instead of SoBufferObject* will be used.
virtual void SoDataCompositor::compose | ( | int | numDataSet, | |
const SbVec3i32 & | tileDimension, | |||
int * | vdid, | |||
SoBufferObject ** | inputBuffer, | |||
SoBufferObject * | outputBuffer | |||
) | [virtual] |
The compose method can be overridden in a subclass to specify a custom composition.
Inputs are:
NOTE: For compatibility purposes, if this method is not redefined then the version with void* parameters instead of SoBufferObject* will be used.
static SoType SoDataCompositor::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoNode.
int SoDataCompositor::getDataSize | ( | ) | const |
Returns number of bytes for output datum.
DataType SoDataCompositor::getDataType | ( | ) | const |
Returns the output data type.
int SoDataCompositor::getNumSigBits | ( | ) | const |
Returns the output number of significant bits.
virtual SoType SoDataCompositor::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoNode.
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).
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.
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.
Predefined composition method.
Use enum PreDefCompositor. 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.
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.