SoMemoryDataAdapter Class Reference
[Images]

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

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

Inheritance diagram for SoMemoryDataAdapter:

List of all members.

Public Types
enum	LayerOrganization {   CONTIGUOUS_PER_PIXEL,   CONTIGUOUS_PER_LAYER,   CONTIGUOUS_PER_PLANE,   CONTIGUOUS_PER_VOLUME }
Public Member Functions
virtual SoType	getTypeId () const
	SoMemoryDataAdapter ()
SoBufferObject *	getBufferObject ()
Static Public Member Functions
static SoType	getClassTypeId ()
static SoMemoryDataAdapter *	createMemoryDataAdapter (const SbVec4i32 &dimension, SbImageDataType imageInfos, LayerOrganization organization, SoBufferObject *data)

---

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

MemoryDataAdapter {

extent

0,0,0, 1,1,1

}

SEE ALSO

SoImageDataAdapter, SoFileDataAdapter, SoVolumeReaderAdapter

See related examples:

DenoisingImage2D, CreatingImage2D, CreatingImage3D

---

Member Enumeration Documentation

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

---

Constructor & Destructor Documentation

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

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.

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.

static SoType SoMemoryDataAdapter::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoImageDataAdapter.

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