Image data adapter for in memory data. More...

#include <ImageViz/Nodes/Images/SoMemoryDataAdapter.h>

Inheritance diagram for SoMemoryDataAdapter:

Public Types
enum	LayerOrganization { CONTIGUOUS_PER_PIXEL , CONTIGUOUS_PER_LAYER , CONTIGUOUS_PER_PLANE , CONTIGUOUS_PER_VOLUME }
	Layer organization. More...

Public Types inherited from SoImageDataAdapter
enum	Interpretation { VALUE , LABEL , BINARY }
	Image Interpretation. More...

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

	SoMemoryDataAdapter ()
	Default constructor.

SoBufferObject *	getBufferObject ()
	Returns the buffer object containing the image data.

Public Member Functions inherited from SoImageDataAdapter
virtual Interpretation	getInterpretation () const
	Returns the current interpretation of the image.

virtual void	setInterpretation (const Interpretation &interpretation)
	Sets the interpretation of the image.

virtual SbImageDataType	getImageDataType ()
	Returns the data type of the image.

virtual SbVec4i32	getSize () const
	Returns a vector representing the dimensions of the image data.

virtual SbBox3f	getExtent () const
	Returns the extent of the image in 3D.

SbVec3f	getVoxelSize () const
	Returns the size of a voxel in 3D.

void	setVoxelSize (const SbVec3f &voxelSize)
	Sets the voxel size in 3D.

SbVec3f	getOrigin () const
	Returns the image origin in 3D.

void	setOrigin (const SbVec3f &origin)
	Sets the image origin in 3D.

void	setDirection (const SbVec3f &rowDirection, const SbVec3f &columnsDirection)
	Set the direction cosines of rows and columns.

SbVec3f	getRowDirection () const
	Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (1,0,0).

SbVec3f	getColumnDirection () const
	Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,1,0).

SbVec3f	getPlaneDirection () const
	Returns the vector in physical coordinate that points from the origin (0,0,0) to the point (0,0,1).

SbMatrix	getIndexToPhysicalTransformation () const
	Returns the transformation that maps a position in the image coordinate system to a position in the physical coordinate system.

SbImageDataAccessor &	getDataAccessor ()
	Returns an SbImageDataAccessor.

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 void	touch ()
	Marks an instance as modified, simulating a change to it.

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 SoMemoryDataAdapter *	createMemoryDataAdapter (const SbVec4i32 &dimension, SbImageDataType imageInfos, LayerOrganization organization, SoBufferObject *data)
	Factory method that creates an adapter from an existing block of memory.

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

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.

Additional Inherited Members
Public Attributes inherited from SoImageDataAdapter
SoSFEnum	interpretation
	Image Interpretation Default is VALUE.

SoSFBox3f	extent
	The extent and orientation fields define the position, size and orientation of the image in 3D (typicallly the physical space).

SoSFRotation	orientation

Detailed Description

Image data adapter for in memory data.

Loads image data from memory. See SoImageDataAdapter for methods to access the data.

FILE FORMAT/DEFAULT

extent

0,0,0, 1,1,1

Member Enumeration Documentation

◆ LayerOrganization

enum SoMemoryDataAdapter::LayerOrganization

Layer organization.

Enumerator
CONTIGUOUS_PER_PIXEL	values of each layer are grouped by pixel (e.g.: RGBA RGBA ... )
CONTIGUOUS_PER_LAYER	values of each layer are separated (e.g.: RRRR... GGGG... BBBB... AAAA... )
CONTIGUOUS_PER_PLANE	values of each layer are separated by 2d simple plane (e.g.: RR... GG... BB... RR... GG... BB...)
CONTIGUOUS_PER_VOLUME	values of each layer are separated by 3d simple volume

Definition at line 63 of file SoMemoryDataAdapter.h.

Constructor & Destructor Documentation

◆ SoMemoryDataAdapter()

SoMemoryDataAdapter::SoMemoryDataAdapter ( )

Default constructor.

Init an image with one voxel unit of one component of type UNSIGNED_BYTE.

Please use createMemoryDataAdapter() to create a Memory adapter from existing block of memory.

Member Function Documentation

◆ createMemoryDataAdapter()

static SoMemoryDataAdapter * SoMemoryDataAdapter::createMemoryDataAdapter	(	const SbVec4i32 &	dimension,
		SbImageDataType	imageInfos,
		LayerOrganization	organization,
		SoBufferObject *	data
	)

static

Factory method that creates an adapter from an existing block of memory.

Note: An SoMemoryDataAdapter stores its data in CONTIGUOUS_PER_PIXEL. Data may be copied and reorganized if LayerOrganization is not CONTIGUOUS_PER_PIXEL.

Parameters

dimension	Dimension of the buffer (width, height, depth, timestep).
imageInfos	Define the format type of data.
organization	Define the organization of layers.
data	Buffer object to map. If data is NULL, a buffer is automatically allocated and its values are initialized to 0.

◆ getBufferObject()

SoBufferObject * SoMemoryDataAdapter::getBufferObject ( )

Returns the buffer object containing the image data.

Data are stored line by line, slice by slice, channels in CONTIGUOUS_PER_PIXEL.

◆ getClassTypeId()

static SoType SoMemoryDataAdapter::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoMemoryDataAdapter::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoImageDataAdapter.

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

ImageViz/Nodes/Images/SoMemoryDataAdapter.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members