SoHeightFieldRender Class Reference
[Nodes]

Heightfield rendering node. More...

#include <VolumeViz/nodes/SoHeightFieldRender.h>

Inheritance diagram for SoHeightFieldRender:

Public Types
enum	BoundaryCells { ALWAYS, SMART, NONE }
Public Member Functions
virtual SoType	getTypeId () const
	SoHeightFieldRender ()
Static Public Member Functions
static SoType	getClassTypeId ()
static SbBool	isSupported (SoState *state=NULL)
Public Attributes
SoSFBool	cellOutline
SoSFFloat	cellOutlineWidth
SoSFColor	cellOutlineColor
SoSFEnum	boundaryCells
Deprecated

enum	NormalPrecision { NORMAL, HIGH }
SoDEPRECATED SoSFEnum	normalPrecision

Detailed Description

Heightfield rendering node.

SoHeightFieldRender displays a uniform grid in the XY plane whose vertices are height (Z) values stored in 2D LDM format (any LDM data set with the Z dimension equal to 1). Adding the combination of LDM data management with advanced GPU features provides a way to handle extremely large surfaces. Just as with volume data, LDM uses tiles of data and multiple levels of resolution to enable interactive frame rates even for data sets that cannot fit in system memory.

This node is used similar to SoVolumeRender, but instead of an SoVolumeData node, you use an SoHeightFieldGeometry for the data set (height values) and one or more SoHeightFieldProperty nodes for property data sets. Generally it obeys the same rules regarding multiple data sets (see SoMultiDataSeparator). Undefined or undesired points may be excluded by setting their value to the "undefined" value in the SoHeightFieldGeometry data set. In addition, undefined or undesired cells may be excluded by specifying a binary mask using an SoHeightFieldPropertyMask node.

Data set values are converted to height values in 3D space in two ways depending on the data type:

Integer values are normalized between [0,1] ([-1,1] for signed types) based on the range of values for the specific data type. For example, for UNSIGNED BYTE values the range 0..255 is mapped to 0..1.

Floating point values are not normalized (are used "as is").

Any height values in the SoHeightFieldGeometry data set that are equal to the "undefined" value will be rendered as holes in the mesh. The undefined value can be specified during the LDM conversion using the "-u" option to the LDM converter:

      convert -u 127 -b 1 inputFile.lst

Or by setting the undefinedValue field of the SoHeightFieldGeometry node. The default value is NaN (Not a Number).

An SoHeightFieldPropertyMask node may be used to specify undefined cells in the mesh. An undefined cell effectively removes the four corresponding height values from the mesh. (SoVolumeMask does not apply to height field rendering.)

A lighted heightfield

VolumeViz provides default shaders that conveniently color the surface using a single property, as shown in the images. However it is also possible to combine multiple properties using a custom shader program, in the same way that you would combine multiple volumes.

The field cellOutline enables drawing the edges of the mesh cells. BoundaryCells are cells close to undefined value. If the boundaryCells field is set to ALWAYS, these cells must be always considered at all resolution levels to avoid artifacts. In SMART mode, the default, we don't take this into account for distant views.

Normally this node uses the OpenGL tessellation shader extension to speed up rendering and automatically adjust the number of generated triangles depending on the camera position and orientation. In this mode, to change the number of generated triangles, use an SoComplexity node. A value of 1 means a full tessellation with a maximum of 4 triangles per pixel and a value of 0.5 means a maximum of 1 triangle per pixel.

If tessellation shaders are not available, use the SoComplexity node to control and limit the number of generated triangles. Use the SoGLExtension method isAvailable( "GL_ARB_tessellation_shader" ) to check if tessellation shaders are supported.

Multidata rules apply to the creation of a scene graph using a SoHeightFieldRender. SoMultiDataSeparator must be used instead of SoSeparator. A minimal scene graph displaying a heightfield is:

EXAMPLE

   // Create nodes
   SoHeightFieldGeometry* HFGeom = new SoHeightFieldGeometry;
     HFGeom->fileName = "$OIVHOME/examples/source/VolumeViz/Data/horizon.ldm";
     HFGeom->dataSetId = 1;

   SoHeightFieldProperty* HFProp = new SoHeightFieldProperty;
     HFProp->fileName = "$OIVHOME/examples/source/VolumeViz/Data/horizon.ldm";
     HFProp->dataSetId = 2;

   // Base color
   SoMaterial* material = new SoMaterial;
     material->diffuseColor.setValue( 1, 1, 1 );

   SoTransferFunction* TF = new SoTransferFunction;
     TF->predefColorMap = SoTransferFunction::STANDARD;

   SoHeightFieldRender* HFRend = new SoHeightFieldRender;

   // Limit triangles (optional)
   SoComplexity* complexity = new SoComplexity();
     complexity->value = 0.25;

   // Build scene graph
   SoMultiDataSeparator* volSep = new SoMultiDataSeparator;
     volSep->addChild( HFGeom );
     volSep->addChild( HFProp );
     volSep->addChild( material );
     volSep->addChild( complexity );
     volSep->addChild( TF );
     volSep->addChild( HFRend );
   root->addChild( volSep );

Shaders

When used with an SoVolumeShader, a new shader function is available to compute lighting:

vec4 VVizComputeFrontColor(vec3 normal, vec4 color)): Add lighting to the color col.

The following shader code code will light a heightfield:

 vec4 VVizComputeVolumeRendering(float sf);
 float VVizCombineData(vec2 tcoord);
 vec3 VVizComputeCoordinates(const vec3);
 void VVizOutputColor(vec4 color);
 vec4 VVizComputeFrontColor(vec3 n, vec4 col);
 vec3 VVizComputeGradient(vec3 tcoord);

 void main()
 {
   vec3 tCoord0 = VVizComputeCoordinates(gl_TexCoord[0].xyz);
   vec3 grad = VVizComputeGradient(tCoord0);
   vec3 normal = normalize(gl_NormalMatrix*grad);

   float sf = VVizCombineData(tCoord0.xy);
   vec4 col = VVizComputeVolumeRendering(sf);

   col = VVizComputeFrontColor(normal, col);*
   VVizOutputColor(col);
 }

Picking:

Similar to other geometry, SoPickedPoint can return an SoDetail object specific to the SoHeightFieldRender node. The specific class is SoHeightFieldDetail.

Only GPU picking is supported. This means that the SoRayPickAction used for picking must have its scene manager initialized using the method SoAction::setSceneManager(). SoHandleEventAction does this automatically, so it is not necessary for the application to take any action when using (for example) a SoEventCallback node and calling the getPickedPoint() method. However if the application creates its own SoRayPickAction then it must set the scene manager. If no scene manager is specified, a warning message is issued.

Limitations:

At least one SoHeightFieldProperty which defines a property data set associated with the grid must be in the state.
If an SoROI is in the state, SoHeightFieldRender renders only one box of the ROI (ie: correct rendering only if SoROI's flag field is set to SUB_VOLUME)
Only SoHeightFieldGeometry data sets with a depth of 1 (Z dimension = 1) can be rendered.
The SoHeightFieldProperty and SoHeightFieldPropertyMask data sets must have exactly the same dimensions as the SoHeightFieldGeometry.
Triangle orientation after GPU tessellation cannot be controlled. Undefined value rendering is indeterministic.
For low resolution, undefined values can be taken into account in the property but not in the geometry. In such cases, coloring artifacts can appear.
Lighting is limited to directional lights and base color. Other kinds of lights can be implemented manually using a custom shader.
By default, two-sided lighting is not enabled ("back" side of surface will not be lighted). Use an SoShapeHints node to enable two-sided lighting.
The enableBumpMapping field is not supported on this node
SoHeightFieldPropertyMask and cellOutline can be used only if tesselation shaders are supported. Use the SoGLExtension method isAvailable( "GL_ARB_tessellation_shader" ) to check this support.

FILE FORMAT/DEFAULT

enableBumpMapping	FALSE
bumpScale	1.0
alternateRep	NULL
useRGBA	FALSE
normalPrecision	HIGH
cellOutline	FALSE

Member Enumeration Documentation

enum SoHeightFieldRender::BoundaryCells

Boundary cells mode.

Enumerator:

ALWAYS	Always compute boundary cells.
SMART	Compute boundary cells according to the distance to the view.
NONE	Never compute boundary cells.

enum SoHeightFieldRender::NormalPrecision

Deprecated:: Deprecated since Open Inventor 9300
No longer used. Normals are now computed on the fly on gpu.

Enumerator:

NORMAL	Normals are saved in a memory efficient format.
HIGH	Normals are saved in a high precision format but use more GPU memory.

Constructor & Destructor Documentation

SoHeightFieldRender::SoHeightFieldRender ( )

Constructor.

Member Function Documentation

static SoType SoHeightFieldRender::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from SoSlice.

virtual SoType SoHeightFieldRender::getTypeId ( ) const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoSlice.

static SbBool SoHeightFieldRender::isSupported ( SoState * state = NULL ) [static]

Returns true if graphic card can render a SoHeightFieldRender.

GPU must support geometry shaders, floating point textures and vertex buffer objects (VBO) and tessellation shaders

Member Data Documentation

SoSFEnum SoHeightFieldRender::boundaryCells

Boundary cells mode.

Setting this field to SMART will not compute boundary cells for distant views. Use enum BoundaryCells. Default is SMART.

SoSFBool SoHeightFieldRender::cellOutline

If true, draw outline of each heightField cell (default is false).

SoSFColor SoHeightFieldRender::cellOutlineColor

When cellOutline is TRUE, this value specifies the cell outline color.

Default is black : (0, 0, 0).

NOTE: field available since Open Inventor 9.7

SoSFFloat SoHeightFieldRender::cellOutlineWidth

When cellOutline is TRUE, this value specifies the cell outline width in pixels.

Default is 2 pixels.

NOTE: field available since Open Inventor 9.7

SoDEPRECATED SoSFEnum SoHeightFieldRender::normalPrecision

Deprecated:: Deprecated since Open Inventor 9300
No longer used. Normals are now computed on the fly on gpu.

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

VolumeViz/nodes/SoHeightFieldRender.h

SoHeightFieldRender Class Reference [Nodes]

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Deprecated