SoVolumeIndexedFaceSet Class |
Indexed polygonal face shape node for volume data.
Namespace: OIV.VolumeViz.Nodes
The SoVolumeIndexedFaceSet type exposes the following members.
Name | Description | |
---|---|---|
SoVolumeIndexedFaceSet | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Overrides default method on OIV.Inventor.Nodes.SoNode. | |
BeginShape(SoAction, SoShapeTriangleShapes) | Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.) | |
BeginShape(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. | |
Callback | Implements primitive generation for all shapes. | |
ComputeBBox(SoAction, SbBox3f, SbVec3f) | This handles AABB bounding box computation for all shapes derived from this class. | |
ComputeBBox(SoAction, SbXfBox3d, SbVec3d) | This handles AABB bounding box computation for all shapes derived from this class. | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
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.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoNode.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
EndShape | end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). | |
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. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method. | |
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.) | |
GetMatrix | (Inherited from SoNode.) | |
GetName | Returns the name of an instance. | |
GetNormalCache | Returns the current normal cache, or NULL if there is none. | |
GetPrimitiveCount | Counts number of primitives produced by this shape. | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetShapeType | Gets the current shape Full Scene Antialiasing type. | |
GetStringName | (Inherited from SoBase.) | |
GetTangentCache | Returns the current tangent cache, or NULL if there is none. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GLRender | Implements rendering by rendering each primitive generated by subclass. | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoNode.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | Used by BoundingBoxAction to know if bounding box computation should be ignored or not. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | This handles pointPicking mode. | |
Search | (Inherited from SoNode.) | |
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. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetShapeType | set the antialiasing type for this shape. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
ShapeVertex | 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). | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
Write | (Inherited from SoVertexShape.) |
Name | Description | |
---|---|---|
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
clipGeometry | Specifies to clip the geometry at the volume boundaries. | |
coordIndex | The indices of the coordinates that the shape uses as its vertices. | |
interpolation | Interpolation mode. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
materialIndex | The indices of the materials that are used for the shape. | |
normalIndex | The indices of the normals that are used for the shape. | |
offset | Sets an offset value used for computing the texture coordinates. | |
tangentIndex | The indices of the tangents that are used for the shape. | |
textureCoordIndex | The indices of the texture coordinates that are used for the shape. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) | |
vertexProperty | vertex property node. |
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.SoVolumeIndexedFaceSet.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.SoVolumeIndexedFaceSet.clipGeometry field allows rendering of the portion of the geometry which does not intersect the volume data. This portion is not textured and is rendered as a regular OIV.Inventor.Nodes.SoIndexedFaceSet.
This node uses 3D texturing and is not available if the hardware does not support this feature.
OIV.VolumeViz.Nodes.SoVolumeIndexedFaceSet uses the indices in the coordIndex field (from OIV.Inventor.Nodes.SoIndexedShape) to specify the polygonal faces. An index of SO_END_FACE_INDEX (-1) indicates that the current face has ended and the next one begins. 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 vertices of the faces are transformed by the current transformation matrix. 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. PER_VERTEX specifies a material or normal for each vertex. The corresponding _INDEXED bindings are the same, but use the materialIndex or normalIndex indices (see OIV.Inventor.Nodes.SoIndexedShape). The default material binding is OVERALL. The default normal binding is PER_VERTEX_INDEXED.
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:
An indexed 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.SoVolumeIndexedFaceSet. 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.SoVolumeIndexedFaceSet 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.SoVolumeIndexedFaceSet.
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);
VolumeIndexedFaceSet {
vertexProperty | NULL |
coordIndex | 0 |
materialIndex | -1 |
normalIndex | -1 |
textureCoordIndex | -1 |
clipGeometry | true |
offset | 0 |
interpolation | LINEAR |
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.