com.openinventor.volumeviz.nodes

Class SoVolumeRenderingPhysicalQuality

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.volumeviz.nodes.SoVolumeRenderingPhysicalQuality

All Implemented Interfaces:

SafeDisposable

public class SoVolumeRenderingPhysicalQuality
extends SoNode

Volume rendering physical quality property node. This node is intended to be used when one wants to achieve "out of the box" high quality volume rendering. It works the same way as a SoVolumeRenderingQuality node, in the sense that it causes subsequent SoVolumeRender nodes to be drawn with different rendering effects and/or levels of quality, the difference being that the SoVolumeRenderingQuality fields are not exposed in this node and are internally pre-selected to provide the highest possible quality:

The SoVolumeRenderingQuality fields that are internally activated are:

• SoVolumeRenderingQuality.preIntegrated = true
• SoVolumeRenderingQuality.ambientOcclusion = true
• SoVolumeRenderingQuality.deferredLighting = true

The presence of this node in the scenegraph also forces subsequent SoVolumeRender nodes to be drawn with SoVolumeRender.samplingAlignment set to SoVolumeRender.BOUNDARY_ALIGNED.

Note that, unlike SoVolumeRenderingQuality, this node does not support customization of VolumeViz shaders.

The fields exposed in this node provide control over effects that are not present in the SoVolumeRenderingQuality node. These effects include:

• Physically Based Lighting
• Ray-Traced Shadows
• Depth of Field

Physically Based Lighting

The Physically Based Lighting effect provides lighting using an advanced BRDF model. It can be seen as an enhanced version of the regular deferred lighting. In particular, it shows the same behavior regarding the current SoMaterial on the state and has the same limitations. See SoVolumeRenderingQuality.deferredLighting for a detailed list of limitations. In addition to regular deferred lighting, this effect supports HDR environment mapping and several cubemap textures are provided (see environmentMap). The field toneMapping is provided to select the Tone Mapping algorithm used to remap HDR values to low range values. A predefined material that will be applied to the shape can also be selected using the field predefinedMaterial. Any material set between this node and the SoVolumeRender node in the scenegraph will override this predefined material. Note that, just like with regular deferred lighting, the material properties will affect the lighting, and the SoMaterial.diffuseColor will be mixed with the voxel colors using a component-wise multiplication. Finally, the field shadingStyle allows to switch between this type of lighting and regular deferred lighting.

Ray-Traced Shadows

The Ray-Traced Shadows effect computes shadows inside the volume using a ray-marching based algorithm. This effect is activated and parameterized just like regular shadows using the SoShadowGroup node. The SoShadowGroup fields taken into account for this effect are SoShadowGroup.isActive, SoShadowGroup.intensity and SoShadowGroup.quality. This type of shadows supports SoROI clipping, but does not support SoClipPlane, SoVolumeClippingGroup, SoUniformGridClipping or SoUniformGridProjectionClipping. Note that this effect has a huge impact on performance. The field shadowsStyle allows to switch between this type of shadows and regular shadows.

Depth of Field

Depth Of Field is a "cinematic" effect that adds blur on regions far from the focal point of the camera. The focal point is typically the center of the scene bounding box, causing regions close to the camera and far from the camera to be blurred. The focal point is specified by the field SoCamera.focalDistance of the current camera. Only SoVolumeRender nodes are affected by the blurring. The field enableDepthOfField is used to switch it on and off, while the blurFactor field controls the amount of blur induced by this effect.

File format/default:

VolumeRenderingPhysicalQuality {

shadowsStyle	RAYTRACED
shadingStyle	PHYSICALLY_BASED
predefinedMaterial	SEMI_GLOSSY
environmentMap	UFFIZI
toneMapping	MEDIUM
enableDepthOfField	true
blurFactor	0.01

}

See also:

SoVolumeRenderingQuality, SoShadowGroup

Since:

Open Inventor 9.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoVolumeRenderingPhysicalQuality.EnvironmentMaps List of available Environment Maps for Physically Based Lighting.
static class	SoVolumeRenderingPhysicalQuality.PredefinedMaterials List of available predefined materials.
static class	SoVolumeRenderingPhysicalQuality.ShadingStyles List of available shading styles.
static class	SoVolumeRenderingPhysicalQuality.ShadowsStyles List of available types of shadows.
static class	SoVolumeRenderingPhysicalQuality.ToneMappings List of available Tone Mapping algorithms for Physically Based Lighting.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFloat	blurFactor This value controls the intensity of the blurring for the Depth Of Field effect.
static int	CUSTOM_MATERIAL Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.CUSTOM_MATERIAL instead.
SoSFBool	enableDepthOfField Enables a 'Depth of Field' effect on the volume.
SoSFEnum<SoVolumeRenderingPhysicalQuality.EnvironmentMaps>	environmentMap Specifies which Environment map is used.
static int	GLOSSY Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.GLOSSY instead.
static int	GRACE Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.GRACE instead.
static int	GROVE Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.GROVE instead.
static int	HIGH_CONTRAST Deprecated. Use SoVolumeRenderingPhysicalQuality.ToneMappings.HIGH_CONTRAST instead.
static int	MATTE Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.MATTE instead.
static int	MEDIUM Deprecated. Use SoVolumeRenderingPhysicalQuality.ToneMappings.MEDIUM instead.
static int	NO_ENVIRONMENT Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.NO_ENVIRONMENT instead.
static int	PALE Deprecated. Use SoVolumeRenderingPhysicalQuality.ToneMappings.PALE instead.
static int	PHONG Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadingStyles.PHONG instead.
static int	PHYSICALLY_BASED Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadingStyles.PHYSICALLY_BASED instead.
SoSFEnum<SoVolumeRenderingPhysicalQuality.PredefinedMaterials>	predefinedMaterial Specifies a material from a list of predefined ones.
static int	RAYTRACED Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadowsStyles.RAYTRACED instead.
static int	SEMI_GLOSSY Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.SEMI_GLOSSY instead.
SoSFEnum<SoVolumeRenderingPhysicalQuality.ShadingStyles>	shadingStyle Specifies which shading style is applied to the volume.
static int	SHADOWMAP Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadowsStyles.SHADOWMAP instead.
SoSFEnum<SoVolumeRenderingPhysicalQuality.ShadowsStyles>	shadowsStyle Specifies which kind of shadows to compute for the volume.
static int	SKY Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.SKY instead.
static int	STLAZARUS Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.STLAZARUS instead.
static int	STPETER Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.STPETER instead.
SoSFEnum<SoVolumeRenderingPhysicalQuality.ToneMappings>	toneMapping Specifies which tone mapping algorithm to apply.
static int	UFFIZI Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.UFFIZI instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVolumeRenderingPhysicalQuality()

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHADOWMAP

@Deprecated
public static final int SHADOWMAP

Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadowsStyles.SHADOWMAP instead.

RAYTRACED

@Deprecated
public static final int RAYTRACED

Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadowsStyles.RAYTRACED instead.

PHONG

@Deprecated
public static final int PHONG

Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadingStyles.PHONG instead.

PHYSICALLY_BASED

@Deprecated
public static final int PHYSICALLY_BASED

Deprecated. Use SoVolumeRenderingPhysicalQuality.ShadingStyles.PHYSICALLY_BASED instead.

SKY

@Deprecated
public static final int SKY

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.SKY instead.

GROVE

@Deprecated
public static final int GROVE

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.GROVE instead.

STPETER

@Deprecated
public static final int STPETER

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.STPETER instead.

GRACE

@Deprecated
public static final int GRACE

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.GRACE instead.

UFFIZI

@Deprecated
public static final int UFFIZI

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.UFFIZI instead.

STLAZARUS

@Deprecated
public static final int STLAZARUS

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.STLAZARUS instead.

NO_ENVIRONMENT

@Deprecated
public static final int NO_ENVIRONMENT

Deprecated. Use SoVolumeRenderingPhysicalQuality.EnvironmentMaps.NO_ENVIRONMENT instead.

PALE

@Deprecated
public static final int PALE

Deprecated. Use SoVolumeRenderingPhysicalQuality.ToneMappings.PALE instead.

MEDIUM

@Deprecated
public static final int MEDIUM

Deprecated. Use SoVolumeRenderingPhysicalQuality.ToneMappings.MEDIUM instead.

HIGH_CONTRAST

@Deprecated
public static final int HIGH_CONTRAST

Deprecated. Use SoVolumeRenderingPhysicalQuality.ToneMappings.HIGH_CONTRAST instead.

MATTE

@Deprecated
public static final int MATTE

Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.MATTE instead.

SEMI_GLOSSY

@Deprecated
public static final int SEMI_GLOSSY

Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.SEMI_GLOSSY instead.

GLOSSY

@Deprecated
public static final int GLOSSY

Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.GLOSSY instead.

CUSTOM_MATERIAL

@Deprecated
public static final int CUSTOM_MATERIAL

Deprecated. Use SoVolumeRenderingPhysicalQuality.PredefinedMaterials.CUSTOM_MATERIAL instead.

shadowsStyle

public final SoSFEnum<SoVolumeRenderingPhysicalQuality.ShadowsStyles> shadowsStyle

Specifies which kind of shadows to compute for the volume. This field allows to enable RayTraced shadows, which have a better quality than the standard shadowmap-based shadows, but take longer to compute. This field is taken into account only if the associated SoVolumeRender node is inside a SoShadowGroup and the field SoShadowGroup.isActive is set to true. . Default is RAYTRACED.

shadingStyle

public final SoSFEnum<SoVolumeRenderingPhysicalQuality.ShadingStyles> shadingStyle

Specifies which shading style is applied to the volume. . Default is PHYSICALLY_BASED.

predefinedMaterial

public final SoSFEnum<SoVolumeRenderingPhysicalQuality.PredefinedMaterials> predefinedMaterial

Specifies a material from a list of predefined ones. This field is taken into account only if shadingStyle is set to PHYSICALLY_BASED. The selected material will be applied on the object. The environment map and tone mapping algorithm are part of the predefined material properties. The value CUSTOM_MATERIAL can also be selected, in which case the properties of the applied material will be retrieved from the current material on the state. . Default is SEMI_GLOSSY.

environmentMap

public final SoSFEnum<SoVolumeRenderingPhysicalQuality.EnvironmentMaps> environmentMap

Specifies which Environment map is used. This field is taken into account only if shadingStyle is set to PHYSICALLY_BASED and if predefinedMaterial is set to CUSTOM_MATERIAL. The available environment maps are HDR cubemap textures that will be used to display reflexions of the environment on the object. This behaviour can be disabled by selecting the NO_ENVIRONMENT field value. . Default is UFFIZI.

toneMapping

public final SoSFEnum<SoVolumeRenderingPhysicalQuality.ToneMappings> toneMapping

Specifies which tone mapping algorithm to apply. This algorithm is used to remap HDR color values to low range values. This field is taken into account only if shadingStyle is set to PHYSICALLY_BASED and if predefinedMaterial is set to CUSTOM_MATERIAL. . Default is MEDIUM.

enableDepthOfField

public final SoSFBool enableDepthOfField

Enables a 'Depth of Field' effect on the volume. This effect blurs everything outside of the depth of field area, but keeps everything inside sharp. This effect is particularly useful to highlight a specific zone of a volume.

The focal point is controlled by the field SoCamera.focalDistance of the current camera. Only VolumeRender nodes are affected by the blurring. The amount of blurring applied is controlled by the blurFactor field. Default is true.

blurFactor

public final SoSFFloat blurFactor

This value controls the intensity of the blurring for the Depth Of Field effect. The physical value associated with this parameter is the camera's lens aperture. Bigger values induce a shallower depth of field. Default is 0.01.

Constructor Detail

SoVolumeRenderingPhysicalQuality

public SoVolumeRenderingPhysicalQuality()