Write data in memory More...

#include <VolumeViz/writers/SoVRMemoryWriter.h>

Inheritance diagram for SoVRMemoryWriter:

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

	SoVRMemoryWriter ()
	Constructor.

virtual SbBool	initialize ()
	Initialize writer from current parameters.

virtual SbBool	isDataConverted () const
	Always returns FALSE.

virtual SbBool	writeSubSlice (int sliceIndex, const SbBox2i32 &subSlice, SoBufferObject *buffer)
	Writes the data contained in the specified subslice.

Public Member Functions inherited from SoVolumeWriter
virtual SbBool	closeAllHandles ()
	Close all ressources that are locked by the writer so that someone else can read or write to them.

virtual SbBool	restoreAllHandles ()
	Restore ressources that was closed by closeAllHandles.

virtual SbBool	writeTile (const SoLDMTileID &tileId, SoBufferObject *buffer)
	Given a tileID, writes a tile if the data is organized in tiles (see SoLDMTileID).

virtual SbBool	finish ()
	Finish writing the file, free ressources, ... depending on kind of writer.

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 Public Member Functions inherited from SoVolumeWriter
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.

Public Attributes
SoSFBufferObject	data
	Buffer containing data.

SoSFVec2s	padding
	Padding over x and y dimension, use to align slice data in memory.

Public Attributes inherited from SoVolumeWriter
SoSFBox3f	extent
	Extent of dataset.

SoSFVec3i32	dimension
	Dimension of dataset, in voxels.

SoSFEnum	dataType
	Type of input data (that will be given in the writeXXX method) Use enum SoDataSet::DataType.

SoSFEnum	wordFormat
	Endianess of data.

Additional Inherited Members
Public Types inherited from SoVolumeWriter
enum	WordFormat { WF_BIG_ENDIAN = 0 , WF_LITTLE_ENDIAN = 1 }
	Endianess. More...

Detailed Description

Write data in memory

This writer is the writer corresponding to SoVRMemoryReader. It writes data in the data buffer. You can manually specify this buffer. Else, a buffer will be created in the initialize() method. This writer does not organize data on tiles (isDataConverted returns FALSE). So you must use the writeSubSlice method and write data slice by slice.

Do not use the writeTile method with this writer.

SoVRMemoryReader can return an instance of this class already configured to write into the same area of memory.

Padding can be used to add zeros around the slice to align them in memory:

 ____________________
 |xxxxxxxxxxx|      |
 |xxxxxxxxxxx|      |
 |xxxxxxxxxxx|      |
 |___________|      |
 |                  |
 |__________________|
 <-----------><----->
     slice    padding

Constructor & Destructor Documentation

◆ SoVRMemoryWriter()

SoVRMemoryWriter::SoVRMemoryWriter ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoVRMemoryWriter::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoVRMemoryWriter::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoVolumeWriter.

◆ initialize()

virtual SbBool SoVRMemoryWriter::initialize ( )

virtual

Initialize writer from current parameters.

Allocate data buffer

Reimplemented from SoVolumeWriter.

◆ isDataConverted()

virtual SbBool SoVRMemoryWriter::isDataConverted ( ) const

virtual

Always returns FALSE.

This writer is not organized by tiles.

Implements SoVolumeWriter.

◆ writeSubSlice()

virtual SbBool SoVRMemoryWriter::writeSubSlice	(	int	sliceIndex,
		const SbBox2i32 &	subSlice,
		SoBufferObject *	buffer
	)

virtual

Writes the data contained in the specified subslice.

This function must be called only if isDataConverted() return FALSE.

Must be reimplemented in children classes.

Reimplemented from SoVolumeWriter.

Member Data Documentation

◆ data

SoSFBufferObject SoVRMemoryWriter::data

Buffer containing data.

If specified, it must be the right size (nbVoxel * dataSize, by taking padding in account). If NULL, it will be allocated in the initialize() method and deleted in destructor. default is NULL.

Definition at line 76 of file SoVRMemoryWriter.h.

◆ padding

SoSFVec2s SoVRMemoryWriter::padding

Padding over x and y dimension, use to align slice data in memory.

default is (0, 0).

Definition at line 80 of file SoVRMemoryWriter.h.

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

VolumeViz/writers/SoVRMemoryWriter.h

Open Inventor Release 2023.2.3

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

◆ SoVRMemoryWriter()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ initialize()

◆ isDataConverted()

◆ writeSubSlice()

Member Data Documentation

◆ data

◆ padding