| SoLDMReader Class |
Inheritance HierarchySystemObject
OIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.LDM.ReadersSoVolumeReader
OIV.LDM.ReadersSoLDMReader
OIV.LDM.ReadersSoVRLdmFileReader
OIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.LDM.ReadersSoVolumeReader
OIV.LDM.ReadersSoLDMReader
OIV.LDM.ReadersSoVRLdmFileReader
Namespace: OIV.LDM.Readers
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoLDMReader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoLDMReader |
Default constructor.
|
Methods| Name | Description | |
|---|---|---|
| CloseAllHandles |
Close all file handles currently opened by the reader.
(Inherited from SoVolumeReader.) |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetBbox |
Returns the bounding box of the data associated with
the specified file ID. The file ID corresponds to the
tile ID in an LDM data file. If returns FALSE, not supported.
|
| GetBorderFlag |
Returns the border flag. If 0, tiles do not overlap. If not 0, they do.
(Overrides SoVolumeReaderGetBorderFlag.) |
| GetCenter |
Returns the center of the data associated with the
specified file ID. If returns FALSE, not supported.
|
| GetConfiguredWriter |
Returns a writer that correspond to this reader (same format, same parameters, etc...).
(Inherited from SoVolumeReader.) |
| GetDataChar |
Gets the characteristics (file header) of the data volume.
size is the size of the actual volume. type is the type of the data.
dim is the dimension of the data.
(Overrides SoVolumeReaderGetDataChar(SbBox3f, SoDataSetDataTypes, SbVec3i32).) |
| GetDimension |
Returns the dimension of the data.
|
| GetDirectCoordSys |
Return whether the coordinate system used is direct or not.
(Inherited from SoVolumeReader.) |
| GetDirectCoordSysAutoDetection |
Return automatic detection value.
(Inherited from SoVolumeReader.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetHistogram |
Returns the distribution of data values, i.e., the number of voxels per data value.
numVox(0) is the number of voxels with value 0, numVox(1) is the number of voxels
with value 1, and so on.
(Overrides SoVolumeReaderGetHistogram(Queue).) |
| GetMinMax(Double, Double) |
Returns min max if stored in file for float data type
(Overrides SoVolumeReaderGetMinMax(Double, Double).) |
| GetMinMax(Int32, Int32) |
Returns min max if stored in file (obsolete)
(Overrides SoVolumeReaderGetMinMax(Int32, Int32).) |
| GetMinMax(Int64, Int64) |
Returns min max if stored in file for integer data type
(Overrides SoVolumeReaderGetMinMax(Int64, Int64).) |
| GetName | Returns the name of an instance. |
| GetNumSignificantBits |
This method is optional. It returns the number of significant bits of the volume data.
(Inherited from SoVolumeReader.) |
| GetOriginalFilename |
Returns original file name from which the data has been converted
to LDM format if stored in file.
(Overrides SoVolumeReaderGetOriginalFilename.) |
| GetReaderType |
Returns the reader type.
(Overrides SoVolumeReaderGetReaderType.) |
| GetSize |
Returns the bounding box of the total data in world coordinates.
|
| GetStringName | (Inherited from SoBase.) |
| GetSubSlice |
Note: SoLDMReader does not implement this method.
(Overrides SoVolumeReaderGetSubSlice(SbBox2i32, Int32, SbNativeArrayByte).) |
| GetTileMinMax |
Returns the minimum and maximum data values for the given tile.
It allows to profit of optimizations.
(Overrides SoVolumeReaderGetTileMinMax(Int32).) |
| GetTileSize |
Returns the size of a data tile.
(Overrides SoVolumeReaderGetTileSize(SbVec3i32).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetXmlTag |
Gets the first occurrence of the XML element whose tag name is specified by tagName.
Then the associated value or subtags can be fetched using the SbXmlElement methods.
Custom XML tags can be added to the LDM header file by using
the method SoLDMConverter.SetXmlCallback().
|
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsLittleEndian |
Returns whether the bytes of the data are stored in big or little endian order.
The order is little endian if the function returns true.
|
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| ReadTile(Int32, SbBox3i32) |
Given an index, reads a tile if the data is organized in tiles (for LDM).
(Inherited from SoVolumeReader.) |
| ReadTile(Int32, SbNativeArrayByte, SbBox3i32) | (Overrides SoVolumeReaderReadTile(Int32, SbNativeArrayByte, SbBox3i32).) |
| Set | 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. |
| SetDirectCoordSysAutoDetection |
Sets whether or not the reader should automatically try to detect if the coordinate system
used is direct or not.
The function will return FALSE if the feature is not supported
by the current reader.
Default is false.
(Inherited from SoVolumeReader.) |
| SetDirectCoorSys |
Specify if the coordinate system used is direct or not.
The function will return FALSE if the feature is not supported
by the current reader.
Default is false.
(Inherited from SoVolumeReader.) |
| SetFilename |
Specifies the path of the file. Returns 0 for success. Any other return
value indicates failure.
(Inherited from SoVolumeReader.) |
| SetName | (Inherited from SoBase.) |
| SetOutputDataType |
Sets the output data type. Returns FALSE if the reader does not support this feature.
(Inherited from SoVolumeReader.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| SetUserData |
Sets user data. Usually this is a filename.
The simplest approach is to call the setFileName method to handle file
I/O and then access the file in memory, but it is possible to write your own method.
(Overrides SoVolumeReaderSetUserData(Object).) |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
Properties| Name | Description | |
|---|---|---|
 | DataConverted |
The returned boolean indicates if the data is already organized for the LDM module.
If TRUE, VolumeViz will use the readTile method.
(Inherited from SoVolumeReader.) |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| IsThreadSafe |
Let the system know if the reader is thread safe or not.
this function is called by VolumeViz when using the multiIO mode.
(Inherited from SoVolumeReader.) |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
See Also