SoVolumeMaskGroup Class Reference

VolumeViz Volume mask group. More...

#include <VolumeViz/nodes/SoVolumeMaskGroup.h>

Inheritance diagram for SoVolumeMaskGroup:
SoGroup SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.


struct  BoundaryPalette

Public Member Functions

virtual SoType getTypeId () const
 SoVolumeMaskGroup ()

Static Public Member Functions

static SoType getClassTypeId ()

Static Public Attributes



struct SetBoundsColorsAndStyles

Detailed Description

VolumeViz Volume mask group.

This node is used to define a collection of one or more volume masks. See SoVolumeMask for details about using volume masks. Every volume mask node in the scene graph must have an SoVolumeMaskGroup as its parent node. The SoVolumeMaskGroup node, as well as the SoVolumeData node, must be the child of an SoMultiDataSeparator node because the masks are effectively multiple data volumes.

This class also defines the constant TRANSFERFUNCTION_INTERSECTION_ID. If a transfer function (SoTransferFunction) with this id exists in the traversal state, that transfer function will be used to color voxels which belong to more than one mask. See SoVolumeMask for details about the regions defined by volume masks.

Note that when not using volume masks, the traversal order of transfer functions is important, because each VolumeViz rendering node uses the current (last traversed) transfer function independent of the transfer function ids. However if an SoVolumeMaskGroup node is traversed before the rendering node (regardless of whether there are any SoVolumeMask nodes in the group), the volume will only be rendered using the transfer function (if any) with the same id value as the volume data node.



SoVolumeDataDrawStyle, SoVolumeRender, SoVolumeMask, SoMultiDataSeparator, SoTransferFunction

See related examples:

SimpleVolumeMask, SimpleVolumeMaskEditing

Constructor & Destructor Documentation

SoVolumeMaskGroup::SoVolumeMaskGroup (  ) 


Member Function Documentation

static SoType SoVolumeMaskGroup::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoGroup.

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

Returns the type identifier for this specific instance.

Reimplemented from SoGroup.

Friends And Related Function Documentation

friend struct SetBoundsColorsAndStyles [friend]

Member Data Documentation

Intersections between masks will be rendered with the transfer function with id = TRANSFERFUNCTION_INTERSECTION_ID.

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

Open Inventor Toolkit reference manual, generated on 12 Sep 2022
Copyright © Thermo Fisher Scientific All rights reserved.