Data set compositor node More...

#include <LDM/nodes/SoDataCompositor.h>

Inheritance diagram for SoDataCompositor:

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 }
	Supported data types. More...

enum	PreDefCompositor { NONE , MINUS , ADD , MULTIPLY }
	Predefined compositor. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoDataCompositor ()
	Constructor.

virtual void	compose (int numDataSet, const SbVec3i32 &tileDimension, int vdid, SoBufferObject inputBuffer, SoBufferObject outputBuffer)
	The compose method can be overridden in a subclass to specify a custom composition.

virtual void	compose (int numDataSet, const SbVec3i32 &tileDimension, int vdid, SoBufferObject inputBuffer, SoDataCompositor::DataType dataTypes, SoBufferObject *outputBuffer)
	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]).

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

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

DataType	getDataType () const
	Returns the output data type.

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)

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	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.

SbBool	set (const SbString &fieldDataString)
	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.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SbBool	isDataSigned (DataType dataType)
	Returns TRUE if the given data type is a signed integer data type.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	dataType
	Data type of the final composed buffer.

SoSFShort	numSigBits
	Number of significant bits of the final composed datum.

SoSFBool	rgbaMode
	Final composed buffer contains RGBA values (default is FALSE).

SoSFEnum	preDefCompositor
	Predefined composition method.

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.

Detailed Description

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

dataType	UNSIGNED_BYTE
numSigBits	0
rgbaMode	FALSE
preDefCompositor	MINUS
convert	TRUE

ACTION BEHAVIOR

SoCallbackAction

SoGLRenderAction

SoWriteAction

SoGetBoundingBoxAction

SoPickAction

Member Enumeration Documentation

◆ DataType

enum SoDataCompositor::DataType

Supported data types.

Enumerator
UNSIGNED_BYTE	unsigned byte
UNSIGNED_SHORT	unsigned short
UNSIGNED_INT32	unsigned int (32bits)
SIGNED_BYTE	signed byte
SIGNED_SHORT	signed short
SIGNED_INT32	signed int (32bits)
FLOAT	float

Definition at line 124 of file SoDataCompositor.h.

◆ PreDefCompositor

enum SoDataCompositor::PreDefCompositor

Predefined compositor.

Enumerator
NONE	none
MINUS	minus
ADD	add
MULTIPLY	multiply

Definition at line 168 of file SoDataCompositor.h.

Constructor & Destructor Documentation

◆ SoDataCompositor()

SoDataCompositor::SoDataCompositor ( )

Constructor.

Member Function Documentation

◆ compose() [1/4]

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:

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.

◆ compose() [2/4]

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.

◆ compose() [3/4]

virtual SoDEPRECATED void SoDataCompositor::compose	(	int	numDataSet,
		const SbVec3i32 &	tileDimension,
		int *	vdid,
		void **	inputBuffer,
		SoDataCompositor::DataType *	dataTypes,
		void *	outputBuffer
	)

virtual

◆ compose() [4/4]

virtual SoDEPRECATED void SoDataCompositor::compose	(	int	numDataSet,
		const SbVec3i32 &	tileDimension,
		int *	vdid,
		void **	inputBuffer,
		void *	outputBuffer
	)

virtual

◆ getClassTypeId()

static SoType SoDataCompositor::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getDataSize()

int SoDataCompositor::getDataSize ( ) const

Returns number of bytes for output datum.

◆ getDataType()

DataType SoDataCompositor::getDataType ( ) const

Returns the output data type.

◆ getNumSigBits()

int SoDataCompositor::getNumSigBits ( ) const

Returns the output number of significant bits.

◆ getTypeId()

virtual SoType SoDataCompositor::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isDataSigned()

static SbBool SoDataCompositor::isDataSigned ( DataType dataType )

static

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

Member Data Documentation

◆ convert

SoSFBool SoDataCompositor::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.

Definition at line 196 of file SoDataCompositor.h.

◆ dataType

SoSFEnum SoDataCompositor::dataType

Data type of the final composed buffer.

Use enum DataType. Default is UNSIGNED_BYTE. NOTE: If rgbaMode is TRUE, this field is ignored and the output buffer is UNSIGNED_INT32.

Definition at line 147 of file SoDataCompositor.h.

◆ numSigBits

SoSFShort SoDataCompositor::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

rgbaMode

Definition at line 156 of file SoDataCompositor.h.

◆ preDefCompositor

SoSFEnum SoDataCompositor::preDefCompositor

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.

Definition at line 187 of file SoDataCompositor.h.

◆ rgbaMode

SoSFBool SoDataCompositor::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.

Definition at line 163 of file SoDataCompositor.h.

The documentation for this class was generated from the following file:

LDM/nodes/SoDataCompositor.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Member Enumeration Documentation

◆ DataType

◆ PreDefCompositor

Constructor & Destructor Documentation

◆ SoDataCompositor()

Member Function Documentation

◆ compose() [1/4]

◆ compose() [2/4]

◆ compose() [3/4]

◆ compose() [4/4]

◆ getClassTypeId()

◆ getDataSize()

◆ getDataType()

◆ getNumSigBits()

◆ getTypeId()

◆ isDataSigned()

Member Data Documentation

◆ convert

◆ dataType

◆ numSigBits

NOTES

◆ preDefCompositor

◆ rgbaMode