Click or drag to resize
SoVolumeWriter Class

Abstract base class for volume data writer.

Inheritance Hierarchy

Namespace: OIV.LDM.Writers
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public abstract class SoVolumeWriter : SoFieldContainer

The SoVolumeWriter type exposes the following members.

Methods
  NameDescription
Public methodCloseAllHandles

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

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, ...

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.

Public methodIsDataConverted

Returns true if the data is already organized in tiles for the LDM module.

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 OIV.LDM.Writers.SoVolumeWriter.CloseAllHandles().

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.

Public methodWriteTile

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

Top
Properties
  NameDescription
Public propertydataType

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

Public propertydimension

Dimension of dataset, in voxels.

Public propertyextent

Extent of dataset.

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

Endianess of data.

Top
Remarks

Base class used to write volume data. Data are generally organised by tiles (like in LDM) or by slices (like in DICOM).

The OIV.LDM.Writers.SoVolumeWriter.IsDataConverted() method must be reimplemented in derived classes and return true if the data is organized in tiles. In this case, the OIV.LDM.Writers.SoVolumeWriter.WriteTile(OIV.LDM.SoLDMTileID, OIV.Inventor.Devices.SoBufferObject) method MUST be implemented and will be used to write data.

If OIV.LDM.Writers.SoVolumeWriter.IsDataConverted() returns false, the OIV.LDM.Writers.SoVolumeWriter.WriteSubSlice(System.Int32, OIV.Inventor.SbBox2i32, OIV.Inventor.Devices.SoBufferObject) method MUST be implemented and will be used to write data.

EXAMPLE

SoVRLdmFileWriter writer = new SoVRLdmFileWriter();
writer.headerFilename.Value = "myFile.ldm";
writer.dimension.SetValue( 128, 128, 128 );
writer.extent.SetValue( -1,-1,-1, 1,1,1  );

writer.Initialize();

if ( writer.IsDataConverted() ) {
 SoLDMTileID tileID = 0;
 SoCpuBufferObject tileBuffer = new SoCpuBufferObject();
 writer.WriteTile( tileID, tileBuffer );
}
else {
 int sliceIndex = 0;
 SbBox2i32 subSlice = new SbBox2i32( 0,0, 128,128 );
 SoCpuBufferObject sliceBuffer = new SoCpuBufferObject();
 writer.WriteSubSlice( sliceIndex, subSlice, sliceBuffer );
}

writer.Finish();

See Also