Class SoVolumeFaceSet

  • All Implemented Interfaces:

    public class SoVolumeFaceSet
    extends SoFaceSet
    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:

    • Compared to an equivalent standard slice (e.g. SoOrthoSlice), the rendering may be slightly different due to positioning and interpolation.
    • The standard slices (e.g. SoOrthoSlice) have "two-sided lighting" enabled by default as a convenience. This is not true for volume geometry nodes (which have the same default as their corresponding standard geometry node), so the "back" side of the geometry will not be lighted unless you enable two-sided lighting using an SoShapeHints node.

    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.


    • A face set may render or pick incorrectly if any of its polygons are self-intersecting or non-planar.
    • The volume size and orientation (like geometry) can be modified by transformation nodes in the scene graph and this in turn modifies the appearance of volume rendering nodes like SoVolumeFaceSet. However the same transformation must be applied to the volume data node and all volume rendering nodes associated with that volume. So effectively any transformation nodes that affect the volume must be placed before the volume data node.
    • For performance concerns, an instance of SoVolumeFaceSet should not be used multiple times in the scene graph. In order to have the best trade-off between performances and memory footprint use a single SoVertexProperty node shared by several instances of SoVolumeFaceSet.
    • Composition with Multiple Data:
      It is possible to compose datasets that have different dimensions, tile sizes and transformations.
      In order to help fetch the correct data values in custom shaders, texture coordinates conversion functions are provided in the VolumeViz/vvizStructure.h shader include.
      For instance,
       vec3 VVizTextureToTextureVec(in VVizDataSetId datasetSrc, in VVizDataSetId datasetDst, in vec3 texCoord);
      can be used to convert texture coordinates related to one dataset to texture coordinates related to another dataset.
      The conversion is based solely on the transformations applied to each dataset, which are defined by their model matrix and their extent.
      Please note that the model matrix of a dataset is defined by to the SoTransformation nodes that are placed before the SoDataSet node in the order of the traversal.

    File format/default:

    VolumeFaceSet {

      vertexProperty NULL
      startIndex 0
      numVertices -1
      clipGeometry true
      offset 0
      interpolation LINEAR

    Action behavior:

    Draws faces based on the current coordinates, normals, materials, drawing style, and so on.

    Picks faces based on the current coordinates and transformation. Details about the intersection are returned in an SoFaceDetail.

    Computes the bounding box that encloses all vertices of the face set with the current transformation applied to them. Sets the center to the average of the coordinates of all vertices.

    If any triangle callbacks are registered with the action, they will be invoked for each successive triangle generated from each face in the set.

    See Also:
    SoVolumeData, SoTransferFunction, SoROI, SoCoordinate3, SoDrawStyle, SoVolumeIndexedFaceSet, SoVolumeIndexedTriangleStripSet, SoVolumeTriangleStripSet, SoFaceDetail, SoVertexProperty
    • Field Detail

      • clipGeometry

        public final SoSFBool clipGeometry
        Specifies to clip the geometry at the volume boundaries.
        The SoROI node also affects the clipping process. Default is true.
      • offset

        public final SoSFFloat offset
        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.
      • interpolation

        public final SoSFEnum<SoVolumeShape.Interpolations> interpolation
        Interpolation mode. . Default is LINEAR. NOTE: In most cases on modern graphics boards, indexed textures are used, so this refers to interpolation of volume data values.
    • Constructor Detail

      • SoVolumeFaceSet

        public SoVolumeFaceSet()