Click or drag to resize
SoVolumeFaceSet Class

Polygonal face shape node for volume data.

Inheritance Hierarchy

Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoVolumeFaceSet : SoFaceSet

The SoVolumeFaceSet type exposes the following members.

Constructors
  NameDescription
Public methodSoVolumeFaceSet

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on OIV.Inventor.Nodes.SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)

These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type.

(Inherited from SoShape.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

This handles AABB bounding box computation for all shapes derived from this class.

(Overrides SoNonIndexedShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

This handles AABB bounding box computation for all shapes derived from this class.

(Overrides SoNonIndexedShapeComputeBBox(SoAction, SbXfBox3d, SbVec3d).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
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 methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail).

(Inherited from SoShape.)
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 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 methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox

Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method.

(Inherited from SoShape.)
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 methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNormalCache

Returns the current normal cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Inherited from SoFaceSet.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetTangentCache

Returns the current tangent cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Overrides SoFaceSetGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to know if bounding box computation should be ignored or not.

(Inherited from SoShape.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Inherited from SoShape.)
Public methodSearch
(Inherited from SoNode.)
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 methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
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 methodShapeVertex

add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail).

(Inherited from SoShape.)
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 SoNode.)
Public methodWrite
(Inherited from SoVertexShape.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyclipGeometry

Specifies to clip the geometry at the volume boundaries.

Public propertyinterpolation

Interpolation mode.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertynumVertices

Number of vertices per face or per contour.

(Inherited from SoFaceSet.)
Public propertyoffset

Sets an offset value used for computing the texture coordinates.

Public propertystartIndex

Index of first coordinate of shape.

(Inherited from SoNonIndexedShape.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvertexProperty

vertex property node.

(Inherited from SoVertexShape.)
Top
Remarks

This node defines a shape which is the intersection of the volume data defined by an OIV.VolumeViz.Nodes.SoVolumeData node and the 3D shape formed by constructing faces (polygons) from vertices located at the coordinates specified in the vertexProperty field (from OIV.Inventor.Nodes.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 OIV.VolumeViz.Nodes.SoVolumeData node and OIV.LDM.Nodes.SoTransferFunction node. The OIV.VolumeViz.Nodes.SoVolumeFaceSet.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 OIV.VolumeViz.Nodes.SoOrthoSlice, OIV.VolumeViz.Nodes.SoObliqueSlice, OIV.VolumeViz.Nodes.SoFenceSlice, etc features. But note:

  • Compared to an equivalent standard slice (e.g. OIV.VolumeViz.Nodes.SoOrthoSlice), the rendering may be slightly different due to positioning and interpolation.

  • The standard slices (e.g. OIV.VolumeViz.Nodes.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 OIV.Inventor.Nodes.SoShapeHints node.

When set to false, the OIV.VolumeViz.Nodes.SoVolumeFaceSet.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 OIV.Inventor.Nodes.SoFaceSet.

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

OIV.VolumeViz.Nodes.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 OIV.VolumeViz.Nodes.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.

Notes:

  • 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 OIV.VolumeViz.Nodes.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 OIV.VolumeViz.Nodes.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 OIV.Inventor.Nodes.SoVertexProperty node shared by several instances of OIV.VolumeViz.Nodes.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 OIV.Inventor.Nodes.SoTransformation nodes that are placed before the OIV.LDM.Nodes.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

OIV.Inventor.Actions.SoGLRenderAction Draws faces based on the current coordinates, normals, materials, drawing style, and so on.

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

OIV.Inventor.Actions.SoGetBoundingBoxAction 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.

OIV.Inventor.Actions.SoCallbackAction 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