SoFenceSlice Class Reference

Fence slice shape node. More...

#include <VolumeViz/nodes/SoFenceSlice.h>

Inheritance diagram for SoFenceSlice:

Public Types
enum	Axis {   X ,   Y ,   Z }
Public Types inherited from SoSlice
enum	AlphaUse {   ALPHA_AS_IS ,   ALPHA_OPAQUE ,   ALPHA_BINARY }
	Alpha component usage mode Used in the alphaUse field. More...
Public Types inherited from SoVolumeShape
enum	Interpolation {   NEAREST ,   LINEAR ,   TRILINEAR ,   MULTISAMPLE_12 ,   CUBIC }
	Interpolation mode. More...
enum	Composition {   MAX_INTENSITY = 0 ,   MIN_INTENSITY ,   SUM_INTENSITY ,   ALPHA_BLENDING ,   COMPOSITION_LAST }
	Composition mode. More...
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...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoFenceSlice ()
	Constructor.
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.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SbBool	isSupported (SoState *state=NULL)
	Returns true if graphic card can render an SoFenceSlice.
Static Public Member Functions inherited from SoSlice
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoVolumeShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoLdmShape
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
SoSFInt32	dataSetId
	Specifies the SoVolumeData node to use.
SoMFVec2f	points
	Set of points defining a lineset.
SoSFEnum	axis
	Extrusion axis: X, Y, or Z.
Public Attributes inherited from SoSlice
SoSFBool	enableBumpMapping
	Specifies if a bump mapping effect will be applied to the slice.
SoSFFloat	bumpScale
	Specifies the intensity of the bump mapping effect.
SoSFNode	alternateRep
	This field optionally holds a subgraph containing only core Open Inventor nodes that can be used for rendering when VolumeViz is not available.
SoSFEnum	alphaUse
	Specifies how to use the alpha component of each voxel's RGBA value.
SoSFBool	useRGBA
	Specifies whether to create RGBA textures.
SoSFBool	largeSliceSupport
	Activate/deactivate direct loading of full resolution slice data.
Public Attributes inherited from SoVolumeShape
SoSFEnum	interpolation
	Interpolation mode.
SoDEPRECATED SoSFEnum	composition
	Specifies color composition mode.
Public Attributes inherited from SoShape
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Fence slice shape node.

This node renders a strip (connected series) of slices. The strip is defined by a set of 2D vertices that form a polyline. Each segment of the polyline is extruded along the axis specified in the axis field to form (in effect) an oblique slice. The default axis is Z, so the 2D points are treated as (X,Y) values. The points may be outside the 3D extent of the volume, but only the portion of the slice inside the volume will be drawn (subject to region of interest and other clipping nodes).

The SoVolumeData node on which this shape is applied can be specified with dataSetId. When this field is set to 0, the last SoVolumeData node on state is used.

A similar effect could be obtained using volume geometry (e.g. SoVolumeFaceSet), but SoFenceSlice is more convenient and is optimized for this specific case.

The 2D coordinates are interpreted according to the following table. See the code example below.

Fence axis	Coordinate axes
X	Y , Z
Y	Z , X
Z	X , Y

For a non-RGBA (scalar valued) volume, each voxel's RGBA value is determined by the current SoDataRange and SoTransferFunction. The current diffuse color and transparency (set, for example, with an SoMaterial node) modify the appearance of the slice. This means that, for example, the current transparency can be used as a global alpha value to modulate the overall opacity of the slice. For an RGBA volume each voxel's RGBA value comes directly from the volume data.

The interpolation field controls how the texture is interpolated.

The alphaUse field (SoSlice) controls how the voxel's alpha component is used when drawing the fence slice.

Optionally a bump mapping effect may be applied. Normal vectors are automatically computed from the data value gradient. The enableBumpMapping and bumpScale fields (SoSlice) control whether bump mapping is active and the intensity of the effect.

Notes:

• Transformation matrices:
  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 visualization nodes. However the same transformation must be applied to the volume data node and all volume visualization nodes associated with that volume. So effectively any transformation nodes that affect the volume must be placed before the volume data node.
• Picking:
  The entire slice is pickable, even where it is transparent as a result of the current transfer function. Currently SoFenceSlice does not provide an SoDetail object.
• Interpolation:
  Interpolation is specified using the interpolation field. The default (LINEAR) does bi-linear interpolation between voxel values. The NEAREST value can be used to display individual voxels. For best image quality we recommend using the MULTISAMPLE_12 value.
• Data range:
  By default VolumeViz maps the entire range of the voxel's data type (e.g. 0..65535 for unsigned short) into the colormap. This is often correct for byte (8 bit) voxels, but seldom correct for 16 bit voxels and never correct for floating point voxels. Use an SoDataRange node to specify the actual (or desired) range of data values to be mapped. Also use an SoDataRange node to implement brightness/contrast control like the Window/Level setting commonly used with medical images.
• Clipping:
  Volume primitives can be clipped using a region of interest (SoROI), geometry (SoVolumeClippingGroup) and/or height fields (SoUniformGridClipping). They are also clipped by OpenGL clipping planes (SoClipPlane), but we recommend using the VolumeViz clipping nodes instead.
• Material:
  The color of each voxel is modulated by the current diffuse color in the traversal state. The default diffuse color is 0.8,0.8,0.8. This results in full intensity values in the color map being displayed as 80% intensity. Therefore we recommend adding an SoMaterial node before the slice and setting its diffuseColor field to full white (1,1,1).
• Transparency:
  
  
  • Typically the color map (SoTransferFunction) used for volume rendering (SoVolumeRender) assigns transparency (alpha < 1) to some voxel values. If you want to use the same color map for slice rendering, but render the slice completely opaque, set the alphaUse field to ALPHA_OPAQUE. This overrides the alpha values in the color map (or an RGBA volume). However it does not affect transparency assigned using an SoMaterial node.
    
    
  • If you want to adjust the overall transparency of the slice, add an SoMaterial node and set its transparency field (keeping alphaUse set to ALPHA_AS_IS). Effectively a scale factor 1-transparency is applied to each voxel's alpha value.
    
    
  • Intersecting transparent slices cannot be rendered correctly by the basic blending transparency algorithms. To render this case correctly, set the transparency algorithm to SORTED_PIXEL using the viewer class or SoGLRenderAction.
• Voxel edges:
  The edges of the voxels can also be rendered. See options in the SoVolumeRenderingQuality node.
• Custom shaders:
  The current SoVolumeShader node, if any, allows custom shaders to be defined for special computation or rendering effects, including blending multiple volumes.
• 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.
• Performance:
  
  • Tile size:
    For backward compatibility, the default tile size is still only 64. This is quite small for modern CPU/GPU hardware. The smaller the tile size, the larger the total number of tiles that must be managed by VolumeViz. This overhead can be significant, especially for operations that require reloading the data textures on the GPU, for example, changing the data range (SoDataRange). For smaller volumes, like 512^3, it can be efficient to set the tile size large enough to contain the entire volume. For very large volumes, larger tile sizes are efficient for SoVolumeRender but somewhat inefficient for slice rendering because complete tiles must be loaded even though the slice only uses part of the data. Applications should experiment.
    For volumes stored in LDM file format, the tile size must be specified when the volume is converted to LDM (see SoConverter and the "-t" option). For other data data formats the tile size can be specified using the SoVolumeData node's ldmResourceParameters field, but only after setting the filename field or calling the setReader() method.
  • Tile cache policy:
    It specifies how the tiles are stored in CPU memory. The selected policy can significantly impact the data loading performance versus the CPU memory footprint. See SoLDMResourceParameters::tileCachePolicy for detail.
• Hardware requirements:
  This node needs a graphic card with support for GLSL shader, vertex buffer objects (VBO) and framebuffer object (FBO). Use the isSupported() method to check if the current graphics board can render a FenceSlice.

EXAMPLE

Please see SoObliqueSlice for a complete code example. The following shows how to set up the axis and points fields of SoFenceSlice.

SoFenceSlice* pFenceSlice = new SoFenceSlice;
  pFenceSlice->axis = SoFenceSlice::Y;
  pFenceSlice->points.set1Value( 0, SbVec2f(-0.2f, -0.66f) );
  pFenceSlice->points.set1Value( 1, SbVec2f( 0.2f, -0.4f ) );
  pFenceSlice->points.set1Value( 2, SbVec2f(-0.2f,  0.4f ) );
  pFenceSlice->points.set1Value( 3, SbVec2f( 0.2f,  0.66f) );

Fence slice on Y axis (Colt example data set):

Fence slice on X axis (Colt example data set):

Fence slice on Z axis (Colt example data set):

FILE FORMAT/DEFAULT

FenceSlice {

dataSetId	0
points	[ ]
axis	Z
interpolation	LINEAR
alphaUse	ALPHA_BINARY
useRGBA	FALSE
alternateRep	NULL
enableBumpMapping	FALSE
bumpScale	1.0

}

ACTION BEHAVIOR

SoGLRenderAction
Draws a textured shape based on current SoVolumeData, SoTransferFunction, and SoROI nodes.

SoGetBoundingBoxAction
Computes the bounding box that encloses the fence slice.

SEE ALSO

SoVolumeData, SoDataRange, SoTransferFunction, SoROI, SoSlice SoObliqueSlice, SoOrthoSlice, SoFenceSliceDetail

Definition at line 266 of file SoFenceSlice.h.

Member Enumeration Documentation

Axis

enum SoFenceSlice::Axis

Enumerator
X
Y
Z	(Default)

Definition at line 300 of file SoFenceSlice.h.

Constructor & Destructor Documentation

SoFenceSlice()

SoFenceSlice::SoFenceSlice

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoFenceSlice::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoFenceSlice::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoSlice.

isSupported()

static SbBool SoFenceSlice::isSupported ( SoState *  state = NULL )

static

Returns true if graphic card can render an SoFenceSlice.

GPU must support GLSL. When using a debug build of Open Inventor, some "no context available" warning messages may be generated. You can ignore them or see SoGLExtension for an example of using SoGLContext to avoid them.

Member Data Documentation

axis

SoSFEnum SoFenceSlice::axis

Extrusion axis: X, Y, or Z.

Use enum Axis. Default is Z.

Definition at line 311 of file SoFenceSlice.h.

dataSetId

SoSFInt32 SoFenceSlice::dataSetId

Specifies the SoVolumeData node to use.

This is useful when datasets of different dimensions are present in the scene graph. Please see SoMultiDataSeparator for more details.

When set to 0, the last SoVolumeData node on state is used. Default is 0.

NOTE: field available since Open Inventor 10.11.0

Definition at line 287 of file SoFenceSlice.h.

points

SoMFVec2f SoFenceSlice::points

Set of points defining a lineset.

If axis is:

• X: points are Y,Z coordinates
• Y: points are Z,X coordinates
• Z: points are X,Y coordinates

All points should be inside the 3D extent of the volume.

Definition at line 298 of file SoFenceSlice.h.

---

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

• VolumeViz/nodes/SoFenceSlice.h