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

#include <VolumeViz/nodes/SoVolumeFaceSet.h>

Inheritance diagram for SoVolumeFaceSet:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoVolumeFaceSet ()
	Constructor.

Public Member Functions inherited from SoFaceSet
	SoFaceSet ()
	Creates a face set node with default settings.

Public Member Functions inherited from SoVertexShape
SoNormalCache *	getNormalCache () const
	Returns the current normal cache, or NULL if there is none.

SoTangentCache *	getTangentCache () const
	Returns the current tangent cache, or NULL if there is none.

Public Member Functions inherited from SoShape
virtual SbBool	affectsState () const
	Overrides default method on SoNode.

ShapeType	getShapeType ()
	Gets the current shape Full Scene Antialiasing type.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	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.

SbBool	set (const SbString &fieldDataString)
	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.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Public Member Functions inherited from SoVolumeGeometry
	SoVolumeGeometry ()
	Constructor.

virtual	~SoVolumeGeometry ()
	Destructor.

virtual void	setRenderProgress (SoProgressIndicator *ps)
	Set an application defined SoProgressIndicator object which will raise an event before and after the rendering task, before and after each subtask (in this case: Texture creation and Geometry creation) and after each step in the subtasks which represents in most cases individual tiles of data.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoFaceSet
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNonIndexedShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoVertexShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SbBool	isPrimitiveRestartAvailable (SoState *state=NULL)
	Returns TRUE if the primitive restart feature is available.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFBool	clipGeometry
	Specifies to clip the geometry at the volume boundaries.

SoSFFloat	offset
	Sets an offset value used for computing the texture coordinates.

SoSFEnum	interpolation
	Interpolation mode.

Public Attributes inherited from SoFaceSet
SoMFInt32	numVertices
	Number of vertices per face or per contour.

Public Attributes inherited from SoNonIndexedShape
SoSFInt32	startIndex
	Index of first coordinate of shape.

Public Attributes inherited from SoVertexShape
SoSFNode	vertexProperty
	vertex property node.

Public Attributes inherited from SoShape
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Deprecated

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

Additional Inherited Members
Public Types inherited from SoShape
enum	ShapeType { POINTS , LINES , POLYGONS , TEXT }
	Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...

Detailed Description

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.

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 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);

VVizTextureToTextureVec
vec3 VVizTextureToTextureVec(in VVizDataSetId datasetSrc, in VVizDataSetId datasetDst, in vec3 texCoord)
Converts the input vector from the texture space of one dataset to the texture space of another datas...

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

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

ACTION BEHAVIOR

SoGLRenderAction

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

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.

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.

Member Enumeration Documentation

◆ Interpolation

enum SoVolumeFaceSet::Interpolation

Enumerator

NEAREST

OpenGL "nearest neighbor" interpolation.

LINEAR

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).

Definition at line 214 of file SoVolumeFaceSet.h.

Constructor & Destructor Documentation

◆ SoVolumeFaceSet()

SoVolumeFaceSet::SoVolumeFaceSet ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoVolumeFaceSet::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoVolumeFaceSet::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoFaceSet.

Member Data Documentation

◆ clipGeometry

SoSFBool SoVolumeFaceSet::clipGeometry

Specifies to clip the geometry at the volume boundaries.

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

Definition at line 192 of file SoVolumeFaceSet.h.

◆ interpolation

SoSFEnum SoVolumeFaceSet::interpolation

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.

Definition at line 210 of file SoVolumeFaceSet.h.

◆ offset

SoSFFloat SoVolumeFaceSet::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.

Definition at line 205 of file SoVolumeFaceSet.h.

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

VolumeViz/nodes/SoVolumeFaceSet.h

Open Inventor Release 2023.2.3

Public Member Functions

Static Public Member Functions

Public Attributes

Deprecated

Additional Inherited Members