SoPathTracerVolume

InventorModule
author Florian Link
package MeVisLab/Standard
dll SoPathTracer
definition SoPathTracer.def
inherits from SoPathTracerVolumeBase
keywords volume, rendering, ray, casting, woodcock

Purpose

The SoPathTracerVolume module allows to load and render a volume in a SoPathTracer scene. The volume can render itself when Enable Volume Rendering is enabled, or it can be rendered/used by other modules like SoPathTracerVolumeInstance, SoPathTracerIsoSurface or SoPathTracerSlice.

The same volume can be rendered with different LUTs, transformation, clipping, masking, tagging and subvolume settings using multiple SoPathTracerVolumeInstance.

The SoPathTracer supports an unlimited (except for GPU limits) number of volumes and allows arbitrary affine transformations of the volumes. All volumes and geometry cast shadows on each other and are correctly integrated.

Restriction: In the current implementation, translucent overlapping volumes are not combined physically correct, but the current implementation works fine for surface-like volumes/LUTs without large highly transparent regions.

../../../Projects/MeVisPathTracer/SoPathTracer/Modules/mhelp/Images/motor5.jpg

Windows

Default Panel

../../../Projects/MeVisPathTracer/SoPathTracer/Modules/mhelp/Images/Screenshots/SoPathTracerVolume._default.png

Input Fields

inMaterial

name: inMaterial, type: SoNode

see inMaterial

inLUT

name: inLUT, type: MLBase, deprecated name: inDiffuseLUT

inVolume

name: inVolume, type: Image

The input dataset.

Parameter Fields

Visible Fields

Enabled

name: enabled, type: Bool, default: TRUE

see enabled

Enable Volume Rendering

name: enableVolumeRendering, type: Bool, default: TRUE

see enableVolumeRendering

Volume Name

name: volumeName, type: String, default: main

see volumeName

Mask Volume Name

name: maskVolumeName, type: String, default: mask

see maskVolumeName

Tag Volume Name

name: tagVolumeName, type: String, default: tags

see tagVolumeName

Time Point

name: timePoint, type: Integer, default: 0

see timePoint

Mask Color0

name: maskColor0, type: Color, default: 1 0 0

see maskColor0

Mask Color1

name: maskColor1, type: Color, default: 1 1 1

see maskColor1

Mask Alpha0

name: maskAlpha0, type: Float, default: 0, minimum: 0, maximum: 1

see maskAlpha0

Mask Alpha1

name: maskAlpha1, type: Float, default: 1, minimum: 0, maximum: 1

see maskAlpha1

Mask Tag0

name: maskTag0, type: Integer, default: 0, minimum: 0, maximum: 1

see maskTag0

Mask Tag1

name: maskTag1, type: Integer, default: 0, minimum: 0, maximum: 1

see maskTag1

Step Size Factor

name: stepSizeFactor, type: Float, default: 3, minimum: 1, maximum: 10

see stepSizeFactor

Step Size Factor Shadow

name: stepSizeFactorShadow, type: Float, default: 3, minimum: 1, maximum: 10

see stepSizeFactorShadow

Self Shadowing Offset

name: selfShadowingOffset, type: Float, default: 1, minimum: 0, maximum: 10

see selfShadowingOffset

Transpose matrix

name: transposeAdditionalMatrix, type: Bool, default: TRUE

see transposeAdditionalMatrix

Matrix

name: additionalMatrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1

see additionalMatrix

Enable Clipping

name: enableClipping, type: Bool, default: TRUE

see enableClipping

Flip Clipping

name: flipClipping, type: Bool, default: FALSE

see flipClipping

X (subVolumeStartX)

name: subVolumeStartX, type: Integer, default: 0

see subVolumeStartX

Y (subVolumeStartY)

name: subVolumeStartY, type: Integer, default: 0

see subVolumeStartY

Z (subVolumeStartZ)

name: subVolumeStartZ, type: Integer, default: 0

see subVolumeStartZ

X (subVolumeEndX)

name: subVolumeEndX, type: Integer, default: 999999

see subVolumeEndX

Y (subVolumeEndY)

name: subVolumeEndY, type: Integer, default: 999999

see subVolumeEndY

Z (subVolumeEndZ)

name: subVolumeEndZ, type: Integer, default: 999999

see subVolumeEndZ

Use world positions

name: subVolumeUseWorldPositions, type: Bool, default: FALSE

see subVolumeUseWorldPositions

World Start Position

name: subVolumeWorldStart, type: Vector3, default: 0 0 0

see subVolumeWorldStart

World End Position

name: subVolumeWorldEnd, type: Vector3, default: 0 0 0

see subVolumeWorldEnd

Tracing Method

name: tracingMethod, type: Enum, default: Tracing_RayMarching

see tracingMethod

Shader Type

name: shaderType, type: Enum, default: Shader_Hybrid

see shaderType

Gradient Factor

name: gradientFactor, type: Float, default: 3, minimum: 0, maximum: 20

see gradientFactor

Hidden Fields

precomputeGradients

name: precomputeGradients, type: Bool, default: FALSE

If enabled, the gradients of the volume are precomputed. This requires additional GPU memory and should only be used for debugging the on-the-fly gradients or if the on-the-fly gradients provide a bad quality.