SoVolumeFaceSet Class Reference

VolumeViz Polygonal face shape node for volume data. More...

#include <VolumeViz/nodes/SoVolumeFaceSet.h>

Inheritance diagram for SoVolumeFaceSet:
SoFaceSet SoVolumeGeometry SoNonIndexedShape SoVertexShape SoShape SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
 SoVolumeFaceSet ()

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFBool clipGeometry
SoSFFloat offset
SoSFEnum interpolation


enum  Interpolation {
  NEAREST = SoVolumeShape::NEAREST,
  LINEAR = SoVolumeShape::LINEAR

Detailed Description

VolumeViz Polygonal face shape node for volume data.

This node defines a shape which is the intersection of the volume data defined by an SoVolumeData node and the 3D shape formed by constructing faces (polygons) from vertices located at the coordinates specified in the vertexProperty field (from SoVertexShape) or the current inherited state. For optimal performance, use of the vertexProperty field is recommended.

The shape defined by this intersection is textured using the data from the current SoVolumeData node and SoTransferFunction node. The interpolation field controls how the texture is interpolated. Texture coordinates are automatically computed for each vertex based on its position relative to the 3D extent of the volume. If texture coordinates are specified, they are ignored.

This node can be used to create custom "slices" through the volume, for example a cylinder slice. It can be considered a generalization of the SoOrthoSlice, SoObliqueSlice, SoFenceSlice, etc features. But note:

When set to FALSE, the clipGeometry field allows rendering of the portion of the geometry that does not intersect the volume data. This portion is not textured and is rendered as a regular SoFaceSet.

This node uses 3D texturing and is not available if the hardware does not support this feature.

SoVolumeFaceSet uses the coordinates in order, starting with the first one. Each face has a number of vertices specified by a value in the numVertices field. For example, an SoVolumeFaceSet with numVertices of [3,4,4] would use coordinates 1, 2, and 3 for the first face, coordinates 4, 5, 6, and 7 for the second face, and coordinates 8, 9, 10, and 11 for the third. For improved performance, arrange all the faces with only 3 vertices at the beginning of the list, then all faces with 4 vertices, and finally all other faces.

The number of values in the numVertices field indicates the number of faces in the set.

The coordinates of the face set are transformed by the current cumulative transformation. The faces are drawn with the current light model and drawing style.

Treatment of the current material and normal binding is as follows: The PER_PART and PER_FACE bindings specify a material or normal for each face. The _INDEXED bindings are equivalent to their non-indexed counterparts. The default material binding is OVERALL. The default normal binding is PER_VERTEX.

If any normals (or materials) are specified, Open Inventor assumes you have provided the correct number of them, as indicated by the binding. You will see unexpected results if you specify fewer normals (or materials) than the shape requires. If no normals are specified, they will be generated automatically.





SoVolumeData, SoTransferFunction, SoROI, SoCoordinate3, SoDrawStyle, SoVolumeIndexedFaceSet, SoVolumeIndexedTriangleStripSet, SoVolumeTriangleStripSet, SoFaceDetail, SoVertexProperty

Member Enumeration Documentation


Deprecated since Open Inventor 9000
Use the enumeration SoVolumeShape::Interpolation.

OpenGL "nearest neighbor" interpolation.


OpenGL linear interpolation (Default). This implies bi-linear interpolation for 2D textures (e.g. SoOrthoSlice, SoObliqueSlice, SoVolumeSkin, SoFenceSlice) and tri-linear interpolation for 3D textures (SoVolumeRender, SoVolumeGeometry).

Constructor & Destructor Documentation

SoVolumeFaceSet::SoVolumeFaceSet (  ) 


Member Function Documentation

static SoType SoVolumeFaceSet::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoFaceSet.

virtual SoType SoVolumeFaceSet::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoFaceSet.

Member Data Documentation

Specifies to clip the geometry at the volume boundaries.

The SoROI node also affects the clipping process. Default is TRUE.

Interpolation mode. Use enum SoVolumeShape::Interpolation. Default is LINEAR. NOTE: In most cases on modern graphics boards, indexed textures are used, so this refers to interpolation of volume data values.

Sets an offset value used for computing the texture coordinates.

The texture coordinate for each vertex will be taken from a point offset units away from the vertex. The offset is measured in the direction of the vertex normal. By default the offset is equal to 0 (no offset). When using this feature, a vertex normal must exist for every vertex. If vertex normals are not supplied, Open Inventor will compute vertex normals in the usual way except that the crease angle will be fixed at PI in order to assure that a vertex normal is computed at every vertex.

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

Open Inventor Toolkit reference manual, generated on 12 Sep 2022
Copyright © Thermo Fisher Scientific All rights reserved.