SoVolumeDataDrawStyle Class Reference
[Nodes]

Volume draw style. More...

#include <VolumeViz/nodes/SoVolumeDataDrawStyle.h>

Inheritance diagram for SoVolumeDataDrawStyle:

List of all members.

Public Types
enum	DrawStyle {   NONE = 0,   VOLUME_RENDER = 1,   MASK_BOUNDARY = 1 << 1,   ISOSURFACE = 1 << 2 }
Public Member Functions
virtual SoType	getTypeId () const
	SoVolumeDataDrawStyle ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFBitMask	style
SoSFMaterial	boundaryMaterial
SoMFFloat	isovalues
SoSFMaterial	isosurfacesMaterial

---

Detailed Description

Volume draw style.

This node specifies the volume rendering style for a volume or for one of the voxel regions of a volume defined by SoVolumeMask nodes. The available draw styles are hidden (not rendered), direct volume rendering, isosurface(s) rendering and the boundary surface rendering according to the style field. Volume rendering always uses the current transfer function and material in the scene graph. Isosurfaces and boundary surfaces use the current material by default, but can optionally be rendered using materials specified in the isosurfacesMaterial or boundaryMaterial fields.

Notes:

• Draw style only applies to SoVolumeRender nodes.

• See SoVolumeMask for discussion of how draw styles are associated with mask regions.

• When not using volume masks, the draw style node must be traversed before the SoVolumeData node.

• The MASK_BOUNDARY style is ignored if not using volume masks.

• The ISOSURFACE style is functionally equivalent to using an SoVolumeIsosurface node, but provides more options. The benefit of using an SoVolumeDataDrawStyle is the ability to combine different display styles (e.g. ISOSURFACE and MASK_BOUNDARY).
  The isosurface displays the boundary between 2 different values, similar to the marching cubes algorithms. In other words, a voxel is part of the isosurface if the ray entry and exit values for the voxel are different and include the specified isosurface value in their range. If you render, for example, the isosurface 100 of a volume data containing the value 100 everywhere, nothing will be rendered.

FILE FORMAT/DEFAULT

VolumeMask {

style	VOLUME_RENDER
boundaryMaterial	NULL
isosurfacesMaterial	NULL
isovalues	[]

}

SEE ALSO

SoVolumeData, SoVolumeRender, SoVolumeMask, SoVolumeMaskGroup, SoMultiDataSeparator, SoTransferFunction

See related examples:

MedicalVolumeDataDrawStyle, MedicalSimpleVolumeMask

---

Member Enumeration Documentation

enum SoVolumeDataDrawStyle::DrawStyle

Volume rendering style.

These values may be combined and are used in the style field.

Enumerator:

NONE	Display nothing.
VOLUME_RENDER	Display the volume mask using the associated transfer function. (Default)
MASK_BOUNDARY	Display only the mask boundary, using boundaryMaterial.
ISOSURFACE	Display isosurfaces using isovalues and isosurfacesMaterial. Note: The isosurfaces are always lighted, regardless of the value of the SoVolumeRenderingQuality lighting and deferredLighting fields.

---

Constructor & Destructor Documentation

SoVolumeDataDrawStyle::SoVolumeDataDrawStyle

(

)

Creates a volume draw style node with default settings.

---

Member Function Documentation

static SoType SoVolumeDataDrawStyle::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoNode.

virtual SoType SoVolumeDataDrawStyle::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

---

Member Data Documentation

SoSFMaterial SoVolumeDataDrawStyle::boundaryMaterial

Material used to render the mask boundary.

Default is none.

SoSFMaterial SoVolumeDataDrawStyle::isosurfacesMaterial

Material used to render isosurfaces.

If this field is empty, the current or default SoMaterial is used.

SoMFFloat SoVolumeDataDrawStyle::isovalues

Values of isosurfaces to display.

Default is none.

SoSFBitMask SoVolumeDataDrawStyle::style

Set the draw style used for a volume or mask: Use enum DrawStyle.

-NONE: Display nothing

-VOLUME_RENDER: Display the volume using the associated transfer function. This is the default value.

-MASK_BOUNDARY: Display only the mask boundary, don't render the masked volume.

-ISOSURFACE: Display the set of isosurfaces defined in isovalues field.

Modes can be combined.

---

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

• VolumeViz/nodes/SoVolumeDataDrawStyle.h