Property node that sets the current dataset id More...

#include <LDM/nodes/SoDataSetId.h>

Inheritance diagram for SoDataSetId:

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

	SoDataSetId ()
	Constructor.

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 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
SoSFInt32	id
	Data set id.

Detailed Description

Property node that sets the current dataset id

When using multiple SoDataSet nodes, the dataSet id uniquely identifies each data set used in the compositing. It also specifies the OpenGL texture unit in which the textures for each data set will be stored for use by GLSL shader programs when doing render compositing.

If an SoDataSetId node is traversed before a data set node (SoDataSet, SoVolumeData, etc), the data set node's dataSetId field is ignored and the id from the SoDataSetId node is used.

In some cases we want to combine multiple data textures where each data texture comes from a different data set (SoVolumeData) node. In that case we could simply use each data set node's dataSetId field to assign each data texture a unique id. However it is also possible to create multiple data textures from a single data set using the SoVolumeTransform node. In this case the same data set node will be instanced in the scene graph multiple times (although its data will only be loaded in CPU memory once), but we still need to assign each data texture a unique id. This can be done using SoDataSetId nodes to specify a different data set id for each instance of the data set node. For example:

EXAMPLE

SoDataSetId* dataSetId1 = new SoDataSetId();
dataSetId1->id = 1;
SoDataSetId* dataSetId2 = new SoDataSetId();
dataSetId2->id = 2;  
 
SoMultiDataSeparator* multiDataSep = new SoMultiDataSeparator();
  multiDataSep->addChild( volumeShader ); // Shader to combine volumes
  multiDataSep->addChild( volumeTransform1 );
  multiDataSep->addChild( dataSetId1 );
  multiDataSep->addChild( volumeData );
 
  multiDataSep->addChild( volumeTransform2 );
  multiDataSep->addChild( dataSetId2 );
  multiDataSep->addChild( volumeData );   // Same data node instanced again
  multiDataSep->addChild( volumeRender );
root->addChild( multiDataSep );

FILE FORMAT/DEFAULT

SoDataSetId

id

1

ACTION BEHAVIOR

SoGLRenderAction

SoCallbackAction

Constructor & Destructor Documentation

◆ SoDataSetId()

SoDataSetId::SoDataSetId ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoDataSetId::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoDataSetId::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ id

SoSFInt32 SoDataSetId::id

Data set id.

1 by default (texture unit 0 is reserved for the color lookup table by default). The number of available texture units depends on your hardware. You can query this number using SoDataSet::getMaxNumDataSet.

NOTE: field available since Open Inventor 8.0

Definition at line 156 of file SoDataSetId.h.

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

LDM/nodes/SoDataSetId.h

Open Inventor Release 2024.1.0

Public Member Functions

Static Public Member Functions

Public Attributes