Click or drag to resize
SoVolumeRenderingPhysicalQuality Class

Volume rendering physical quality property node.

Inheritance Hierarchy

Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2024.1.2.0 (2024.1.2)
public class SoVolumeRenderingPhysicalQuality : SoNode

The SoVolumeRenderingPhysicalQuality type exposes the following members.

Public methodSoVolumeRenderingPhysicalQuality
Initializes a new instance of the SoVolumeRenderingPhysicalQuality class
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoNode.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Public propertyblurFactor

This value controls the intensity of the blurring for the Depth Of Field effect.

Public propertyenableDepthOfField

Enables a 'Depth of Field' effect on the volume.

Public propertyenvironmentMap

Specifies which Environment map is used.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypredefinedMaterial

Specifies a material from a list of predefined ones.

Public propertyshadingStyle

Specifies which shading style is applied to the volume.

Public propertyshadowsStyle

Specifies which kind of shadows to compute for the volume.

Public propertytoneMapping

Specifies which tone mapping algorithm to apply.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)

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 OIV.VolumeViz.Nodes.SoVolumeRenderingQuality node, in the sense that it causes subsequent OIV.VolumeViz.Nodes.SoVolumeRender nodes to be drawn with different rendering effects and/or levels of quality, the difference being that the OIV.VolumeViz.Nodes.SoVolumeRenderingQuality fields are not exposed in this node and are internally pre-selected to provide the highest possible quality:

The OIV.VolumeViz.Nodes.SoVolumeRenderingQuality fields that are internally activated are:

The presence of this node in the scene graph also forces subsequent OIV.VolumeViz.Nodes.SoVolumeRender nodes to be drawn with OIV.VolumeViz.Nodes.SoVolumeRender.samplingAlignment set to OIV.VolumeViz.Nodes.SoVolumeRender.SamplingAlignments.BOUNDARY_ALIGNED.

Note that, unlike OIV.VolumeViz.Nodes.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 OIV.VolumeViz.Nodes.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 OIV.Inventor.Nodes.SoPhysicalMaterial or OIV.Inventor.Nodes.SoMaterial on the state and has the same limitations. See OIV.VolumeViz.Nodes.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 OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.environmentMap). The field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.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 OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.predefinedMaterial. Any material (OIV.Inventor.Nodes.SoPhysicalMaterial or OIV.Inventor.Nodes.SoMaterial) set between this node and the OIV.VolumeViz.Nodes.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 base color will be mixed with the voxel colors using a component-wise multiplication. Finally, the field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.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 OIV.Inventor.Nodes.SoShadowGroup node. The OIV.Inventor.Nodes.SoShadowGroup fields taken into account for this effect are OIV.Inventor.Nodes.SoShadowGroup.isActive, OIV.Inventor.Nodes.SoShadowGroup.intensity and OIV.Inventor.Nodes.SoShadowGroup.quality. This type of shadows supports OIV.LDM.Nodes.SoROI clipping, but does not support OIV.Inventor.Nodes.SoClipPlane, OIV.VolumeViz.Nodes.SoVolumeClippingGroup, OIV.VolumeViz.Nodes.SoUniformGridClipping or OIV.VolumeViz.Nodes.SoUniformGridProjectionClipping. Note that this effect has a huge impact on performance. The field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.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 OIV.Inventor.Nodes.SoCamera.focalDistance of the current camera. Only OIV.VolumeViz.Nodes.SoVolumeRender nodes are affected by the blurring. The field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.enableDepthOfField is used to switch it on and off, while the OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.blurFactor field controls the amount of blur induced by this effect.


VolumeRenderingPhysicalQuality {

Note Note

Node available since Open Inventor 9.8

See Also