SoCpuBufferFromVolumeReader Class Reference
[Tiles]

LDM buffer object optimized for in memory reader tile data. More...

#include <LDM/tiles/SoCpuBufferFromVolumeReader.h>

Inheritance diagram for SoCpuBufferFromVolumeReader:

List of all members.

Public Member Functions
	SoCpuBufferFromVolumeReader (SoDataSet *dataset, SoLDMTileID tileId)
virtual void	map (SoBufferObject *targetBufferObject, SoBufferObject::AccessMode accessMode, size_t startPosition, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	map (SoCpuBufferObject *targetBufferObject, SoBufferObject::AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void	map (SoGLBufferObject *targetBufferObject, SoBufferObject::AccessMode accessMode, size_t startPosition=0, size_t mappingSize=SO_BUFFER_SIZE_ALL)
virtual void *	map (SoBufferObject::AccessMode accessMode, size_t offset=0, size_t count=SO_BUFFER_SIZE_ALL)
virtual void	unmap (SoCpuBufferObject *bufferObject)
virtual void	unmap (SoGLBufferObject *bufferObject)
void	unmap (SoBufferObject *bufferObject)
virtual void	unmap ()
bool	getMinMax (double &min, double &max)
size_t	getRealSize () const
Friends
class	SoCpuBufferFromVolumeReaderImpl

---

Detailed Description

LDM buffer object optimized for in memory reader tile data.

SEE ALSO

SoBufferPropertiesInterface, SoCpuBufferObject

---

Constructor & Destructor Documentation

SoCpuBufferFromVolumeReader::SoCpuBufferFromVolumeReader	(	SoDataSet *	dataset,
		SoLDMTileID	tileId
	)

Constructor with dataset and tile Id as parameter.

Parameters:

	dataset	pointer to dataset associated with buffer
	tileId	tileId representing the tile the buffer will store

---

Member Function Documentation

bool SoCpuBufferFromVolumeReader::getMinMax	(	double &	min,
		double &	max
	)			[virtual]

Get the min and max values in the buffer, if they are known.

Returns false if these values have not been set or computed. Returns true if values are available.

Parameters:

	min	user variable to store min value
	max	user variable to store max value

Implements SoBufferPropertiesInterface.

size_t SoCpuBufferFromVolumeReader::getRealSize

(

)

const [virtual]

Returns the real size of the buffer in bytes.

Implements SoBufferPropertiesInterface.

virtual void* SoCpuBufferFromVolumeReader::map	(	SoBufferObject::AccessMode	accessMode,
		size_t	offset = 0,
		size_t	count = SO_BUFFER_SIZE_ALL
	)			[virtual]

Map the buffer to a system memory address and allows the mapping of a sub part of the buffer object into CPU memory.

Notes:

• The unmap() method must be called before using the buffer.

Returns:

Pointer to data in the mapped region of the buffer memory.

Reimplemented from SoBufferObject.

virtual void SoCpuBufferFromVolumeReader::map	(	SoGLBufferObject *	targetBufferObject,
		SoBufferObject::AccessMode	accessMode,
		size_t	startPosition = 0,
		size_t	mappingSize = SO_BUFFER_SIZE_ALL
	)			[virtual]

Map the current buffer object into the specified GL buffer object.

See the general map method for more information.

virtual void SoCpuBufferFromVolumeReader::map	(	SoCpuBufferObject *	targetBufferObject,
		SoBufferObject::AccessMode	accessMode,
		size_t	startPosition = 0,
		size_t	mappingSize = SO_BUFFER_SIZE_ALL
	)			[virtual]

Map the current buffer object into the specified CPU buffer object.

See the general map method for more information.

virtual void SoCpuBufferFromVolumeReader::map	(	SoBufferObject *	targetBufferObject,
		SoBufferObject::AccessMode	accessMode,
		size_t	startPosition,
		size_t	mappingSize = SO_BUFFER_SIZE_ALL
	)			[virtual]

Map the current buffer object into the specified buffer object.

It is useful in order to use a buffer in multiple contexts.

Parameters:

	targetBufferObject	The buffer object which will be the mapped version of this buffer.
	accessMode	The access mode used for the mapping.
	startPosition	offset in source buffer to map from (default is start of buffer).
	mappingSize	size from the startPosition, if SO_BUFFER_SIZE_ALL then the whole buffer is mapped.

virtual void SoCpuBufferFromVolumeReader::unmap

(

)

[virtual]

Unmap a mapped buffer.

No error is reported if the buffer was not mapped.

Reimplemented from SoBufferObject.

void SoCpuBufferFromVolumeReader::unmap

(

SoBufferObject *

bufferObject

)

Unmap the specified buffer object
It is defined just to speed up the call when the type of the object is known.

See the general unmap function for more information.

virtual void SoCpuBufferFromVolumeReader::unmap

(

SoGLBufferObject *

bufferObject

)

[virtual]

Unmap the specified GL buffer object
It is defined just to speed up the call when the type of the object is known.

If the access mode supports writing the specified buffer is sync'd with the buffer.

See the general unmap function for more information.

Parameters:

bufferObject

Buffer to be unmapped.

virtual void SoCpuBufferFromVolumeReader::unmap

(

SoCpuBufferObject *

bufferObject

)

[virtual]

Unmap the specified CPU buffer object
It is defined just to speed up the call when the type of the object is known.

Remove the specified bufferObject from the list of buffers which map the current buffer.

See the general unmap function for more information.

---

Friends And Related Function Documentation

friend class SoCpuBufferFromVolumeReaderImpl [friend]

Reimplemented from SoBufferPropertiesInterface.

---

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

• LDM/tiles/SoCpuBufferFromVolumeReader.h