Open Inventor Release 2024.2.1
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SoVolumeDataDrawStyle Class Reference
VolumeViz » Nodes

VolumeViz Volume draw style. More...

#include <VolumeViz/nodes/SoVolumeDataDrawStyle.h>

+ Inheritance diagram for SoVolumeDataDrawStyle:

Public Types

enum  DrawStyle {
  NONE = 0 ,
  VOLUME_RENDER = 1 ,
  MASK_BOUNDARY = 1 << 1 ,
  ISOSURFACE = 1 << 2
}
 Volume rendering style. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoVolumeDataDrawStyle ()
 Creates a volume draw style node with default settings.
 
- 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 SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
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 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

SoSFBitMask style
 Set the draw style used for a volume or mask: Use enum DrawStyle.
 
SoSFMaterial boundaryMaterial
 Material used to render the mask boundary.
 
SoMFFloat isovalues
 Values of isosurfaces to display.
 
SoSFMaterial isosurfacesMaterial
 Material used to render isosurfaces.
 

Detailed Description

VolumeViz 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

Definition at line 98 of file SoVolumeDataDrawStyle.h.

Member Enumeration Documentation

◆ DrawStyle

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.

Definition at line 113 of file SoVolumeDataDrawStyle.h.

Constructor & Destructor Documentation

◆ SoVolumeDataDrawStyle()

SoVolumeDataDrawStyle::SoVolumeDataDrawStyle ( )

Creates a volume draw style node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoVolumeDataDrawStyle::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoVolumeDataDrawStyle::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ boundaryMaterial

SoSFMaterial SoVolumeDataDrawStyle::boundaryMaterial

Material used to render the mask boundary.

Default is none.

Definition at line 155 of file SoVolumeDataDrawStyle.h.

◆ isosurfacesMaterial

SoSFMaterial SoVolumeDataDrawStyle::isosurfacesMaterial

Material used to render isosurfaces.


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

Definition at line 166 of file SoVolumeDataDrawStyle.h.

◆ isovalues

SoMFFloat SoVolumeDataDrawStyle::isovalues

Values of isosurfaces to display.

Default is none.

Definition at line 160 of file SoVolumeDataDrawStyle.h.

◆ style

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.

Definition at line 150 of file SoVolumeDataDrawStyle.h.

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