Click or drag to resize
SoVolumeRenderDetail Class

Stores detail information about a picked voxel or pick ray in a data volume.

Inheritance Hierarchy

Namespace: OIV.VolumeViz.Details
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 9.9.17.0 (9.9.17.0)
Syntax
public class SoVolumeRenderDetail : SoVolumeDetail

The SoVolumeRenderDetail type exposes the following members.

Constructors
  NameDescription
Public methodSoVolumeRenderDetail

Constructor.

Top
Methods
  NameDescription
Public methodClone (Inherited from SoDetail.)
Public methodCopy

Returns an instance that is a copy of this instance.

(Overrides SoVolumeDetailCopy.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetFirstNonTransparentValue(Double, SbVec3i32)
Calls GetFirstNonTransparentValue(value, pos, OIV.Inventor.SbVec3f(), false).
(Inherited from SoVolumeDetail.)
Public methodGetFirstNonTransparentValue(Int64, SbVec3i32)
Calls GetFirstNonTransparentValue(value, pos, OIV.Inventor.SbVec3f(), false).
(Inherited from SoVolumeDetail.)
Public methodGetFirstNonTransparentValue(Double, SbVec3i32, SbVec3f)
Calls GetFirstNonTransparentValue(value, pos, objPos, false).
(Inherited from SoVolumeDetail.)
Public methodGetFirstNonTransparentValue(Int64, SbVec3i32, SbVec3f)
Calls GetFirstNonTransparentValue(value, pos, objPos, false).
(Inherited from SoVolumeDetail.)
Public methodGetFirstNonTransparentValue(Double, SbVec3i32, SbVec3f, Boolean)

Returns the floating point value of the first non-transparent voxel along the pick ray (if any) and its position in object and data space.

(Inherited from SoVolumeDetail.)
Public methodGetFirstNonTransparentValue(Int64, SbVec3i32, SbVec3f, Boolean)

Returns the integer value of the first non-transparent voxel along the pick ray (if any) and its position in object and data space.

(Inherited from SoVolumeDetail.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLongMaskCount Obsolete.

Returns the number of volume masks applied to the first non-transparent voxel.

Public methodGetMaskCount
Calls GetMaskCount(false).
Public methodGetMaskCount(Boolean)

Returns the number of volume masks applied to the first non-transparent voxel.

Public methodGetProfileDataPos Obsolete.
Calls GetProfileDataPos((cli.array<OIV.Inventor.SbVec3s>^)nullptr).
(Inherited from SoVolumeDetail.)
Public methodGetProfileDataPos(SbVec3i32)

Returns the number of values along the profile and the profile position in data space (voxel coordinates).

(Inherited from SoVolumeDetail.)
Public methodGetProfileDataPos(SbVec3s) Obsolete.

Obsoletesince Open Inventor 6000 No longer used.

(Inherited from SoVolumeDetail.)
Public methodGetProfileObjectPos

Returns the profile position in object space (world coordinates).

(Inherited from SoVolumeDetail.)
Public methodGetProfileValue(Int32, SbVec3i32)
Calls GetProfileValue(index, pos, OIV.Inventor.SbVec3f(), false).
(Inherited from SoVolumeDetail.)
Public methodGetProfileValue(Int32, SbVec3i32, SbVec3f)
Calls GetProfileValue(index, pos, objPos, false).
(Inherited from SoVolumeDetail.)
Public methodGetProfileValue(Int32, SbVec3i32, SbVec3f, Boolean)

Returns the index'th value (as an integer) and its position in object and data space.

(Inherited from SoVolumeDetail.)
Public methodGetProfileValueD(Int32, SbVec3i32, SbVec3f)
Calls GetProfileValueD(index, pos, objPos, false).
(Inherited from SoVolumeDetail.)
Public methodGetProfileValueD(Int32, SbVec3i32, SbVec3f, Boolean)

Returns the index'th value (as a double) and its position in object and data space.

(Inherited from SoVolumeDetail.)
Public methodGetRgbaValues(Queue) Obsolete.
Calls GetRgbaValues(rgbaValues, -1.f).
Public methodGetRgbaValues(ListSbVec4ub)
Calls GetRgbaValues(rgbaValues, -1.f).
Public methodGetRgbaValues(Queue, Queue) Obsolete.
Calls GetRgbaValues(rgbaValues, objectPos, -1.f).
Public methodGetRgbaValues(Queue, Single) Obsolete.

Returns the RGBA value of each voxel intersected by the pick ray.

Public methodGetRgbaValues(ListSbVec4ub, ListSbVec3f)
Calls GetRgbaValues(rgbaValues, objectPos, -1.f).
Public methodGetRgbaValues(ListSbVec4ub, ListSbVec3i32)
Calls GetRgbaValues(rgbaValues, dataPos, -1.f).
Public methodGetRgbaValues(ListSbVec4ub, Single)

Returns the RGBA value of each voxel intersected by the pick ray.

Public methodGetRgbaValues(Queue, Queue, Single) Obsolete.

Returns the RGBA value and object space position of each voxel intersected by the pick ray.

Public methodGetRgbaValues(ListSbVec4ub, ListSbVec3f, Single)

Returns the RGBA value and object space position of each voxel intersected by the pick ray.

Public methodGetRgbaValues(ListSbVec4ub, ListSbVec3i32, Single)

Returns the RGBA value and data space position of each voxel intersected by the pick ray.

Public methodGetRgbaValues(Queue, Queue, Queue, Queue) Obsolete.
Calls GetRgbaValues(rgbaValues, objectPos, dataPos, tileIds, -1.f).
Public methodGetRgbaValues(ListSbVec4ub, ListSbVec3f, ListSbVec3i32, ListSoLDMTileID)
Calls GetRgbaValues(rgbaValues, objectPos, dataPos, tileIds, -1.f).
Public methodGetRgbaValues(Queue, Queue, Queue, Queue, Single) Obsolete.

Returns the RGBA value, object space position, data space position and tileId for each voxel intersected by the pick ray.

Public methodGetRgbaValues(ListSbVec4ub, ListSbVec3f, ListSbVec3i32, ListSoLDMTileID, Single)

Returns the RGBA value, object space position, data space position and tileId for each voxel intersected by the pick ray.

Public methodGetRgbaValuesTileIds

Returns the tileID of each voxel intersected by the pick ray.

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVoxelStyleAndIsoValue(SoVolumeDataDrawStyleDrawStyles, Double)
Calls GetVoxelStyleAndIsoValue(style, iso, false).
Public methodGetVoxelStyleAndIsoValue(SoVolumeDataDrawStyleDrawStyles, Double, Boolean)

Returns the style applied to the first non-transparent voxel (and its isovalue if the style is SoVolumeDataDrawStyle.ISOSURFACE).

Public methodSetDetails
(Inherited from SoVolumeDetail.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

A successful pick operation returns an SoPickedPoint object. If the picked geometry is an SoVolumeRender node, use the getDetail method and cast the result to this class to get extra information about the the pick.

SoVolumeRenderDetail returns information about the first (closest) non-transparent voxel along the pick ray and/or information about all the voxels intersected by the pick ray (called a profile). For the first non-transparent voxel (if any) on the pick ray, it returns XYZ position, IJK location, and data value. For the profile defined by all the intersected voxels, it returns:

  • Profile position in object space (two XYZ points)

  • Profile location in the data volume (two IJK indices)

  • Number of values along the profile

  • Each voxel value and corresponding IJK location

Use the methods in SoVolumeDetail to get information about the data values of the picked voxels. Use the getRgba... methods in this class to get information about the mapped RGBA colors of the picked voxels. Because these methods return colors, they always return information based on the (possibly subsampled) tiles currently in memory.

GPU picking: Please see the discussion of GPU picking in SoVolumeDetail.

Limitations:

  • If multiple volumes are being combined under an SoMultiDataSeparator, the detail class only returns values for the first volume in the scene graph.

See Also