Click or drag to resize
SoVRMemoryWriter Class

Write data in memory.

Inheritance Hierarchy

Namespace: OIV.VolumeViz.Writers
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 9.9.17.0 (9.9.17.0)
Syntax
public class SoVRMemoryWriter : SoVolumeWriter

The SoVRMemoryWriter type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMemoryWriter

Constructor.

Top
Methods
  NameDescription
Public methodCloseAllHandles

Close all ressources that are locked by the writer so that someone else can read or write to them.

(Inherited from SoVolumeWriter.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodFinish

Finish writing the file, free ressources, ...

(Inherited from SoVolumeWriter.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInitialize

Initialize writer from current parameters.

(Overrides SoVolumeWriterInitialize.)
Public methodIsDataConverted

Always returns false.

(Overrides SoVolumeWriterIsDataConverted.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodRestoreAllHandles

Restore ressources that was closed by closeAllHandles.

(Inherited from SoVolumeWriter.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Public methodWriteSubSlice

Writes the data contained in the specified subslice.

(Overrides SoVolumeWriterWriteSubSlice(Int32, SbBox2i32, SoBufferObject).)
Public methodWriteTile

Given a tileID, writes a tile if the data is organized in tiles (see SoLDMTileID).

(Inherited from SoVolumeWriter.)
Top
Properties
  NameDescription
Public propertydata

Buffer containing data.

Public propertydataType

Type of input data (that will be given in the writeXXX method) .

(Inherited from SoVolumeWriter.)
Public propertydimension

Dimension of dataset, in voxels.

(Inherited from SoVolumeWriter.)
Public propertyextent

Extent of dataset.

(Inherited from SoVolumeWriter.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypadding

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

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertywordFormat

Endianess of data.

(Inherited from SoVolumeWriter.)
Top
Remarks

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

See Also