SoPathTracerVolumeBase

InventorModule
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll SoPathTracer
definition SoPathTracer.def

Purpose

The SoPathTracerVolumeBase provides basic settings for volumes and volume instances.

Input Fields

inMaterial

name: inMaterial, type: SoNode

The input material scene. Typically it consists of a single SoPathTracerMaterial, but in case of per-tag materials, it can also contain a SoGroup with multiple SoPathTracerMaterial modules. The materials are assigned per tag, starting with 0 in the order they appear in the SoGroup.

inDiffuseLUT

name: inDiffuseLUT, type: MLBase

The input LUT.

inEmissionLUT

name: inEmissionLUT, type: MLBase

Parameter Fields

Hidden Fields

enabled

name: enabled, type: Bool, default: TRUE

Enables the loading of the volume.

enableVolumeRendering

name: enableVolumeRendering, type: Bool, default: TRUE

Enables the volume rendering of the volume. When the volume should only be used by other modules like SoPathTracerVolumeInstance, SoPathTracerIsoSurface or SoPathTracerSlice, it makes sense to set this to false and let the other modules do the rendering.

volumeName

name: volumeName, type: String

The name of the volume. Other rendering modules like SoPathTracerVolumeInstance, SoPathTracerIsoSurface and SoPathTracerSlice can use this name to specify which volume they want to render.

maskVolumeName

name: maskVolumeName, type: String, default: mask

Selects the name of the mask volume to use. The renderer looks for a SoPathTracerMaskVolume with such a volumeName and uses it if it is found.

tagVolumeName

name: tagVolumeName, type: String, default: tags

Selects the name of the tag volume to use. The renderer looks for a SoPathTracerTagVolume with such a volumeName and uses it if it is found.

timePoint

name: timePoint, type: Integer, default: 0

Selects the time point of the input dataset.

maskColor0

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

Selects the outside mask color.

maskColor1

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

Selects the inside mask color.

maskAlpha0

name: maskAlpha0, type: Float, default: 0

Selects the outside mask alpha.

maskAlpha1

name: maskAlpha1, type: Float, default: 1

Selects the inside mask alpha.

maskTag0

name: maskTag0, type: Integer, default: 0

Selects the tag offset that should be added to the tag value when being outside of the mask. This allows using per-tag effects on the inside/outside of the mask volume.

maskTag1

name: maskTag1, type: Integer, default: 0

Selects the tag offset that should be added to the tag value when being inside of the mask. This allows using per-tag effects on the inside/outside of the mask volume.

stepSizeFactor

name: stepSizeFactor, type: Float, default: 3

The step size for ray marching (1 = best quality).

stepSizeFactorShadow

name: stepSizeFactorShadow, type: Float, default: 3

The step size for shadow rays (1 = best quality)

selfShadowingOffset

name: selfShadowingOffset, type: Float, default: 1

The shadow offset that is used to avoid self-shadowing.

transposeAdditionalMatrix

name: transposeAdditionalMatrix, type: Bool, default: TRUE

Transposes the additional matrix, to allow both Inventor and ML matrices.

additionalMatrix

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

An additional transformation matrix. This matrix can be update without performance impact and thus allows arbitrary affine transformations of the volume (e.g. for registration purposes).

enableClipping

name: enableClipping, type: Bool, default: TRUE

If enabled, Open Inventor clipping planes affect the volume.

flipClipping

name: flipClipping, type: Bool, default: FALSE

If enabled, the Open Inventor clipping planes are flipped before being applied to the volume.

subVolumeStartX

name: subVolumeStartX, type: Integer, default: 0

The sub volume (in voxels).

subVolumeStartY

name: subVolumeStartY, type: Integer, default: 0

The sub volume (in voxels).

subVolumeStartZ

name: subVolumeStartZ, type: Integer, default: 0

The sub volume (in voxels).

subVolumeEndX

name: subVolumeEndX, type: Integer, default: 999999

The sub volume (in voxels).

subVolumeEndY

name: subVolumeEndY, type: Integer, default: 999999

The sub volume (in voxels).

subVolumeEndZ

name: subVolumeEndZ, type: Integer, default: 999999

The sub volume (in voxels).

subVolumeUseWorldPositions

name: subVolumeUseWorldPositions, type: Bool, default: FALSE

Selects if subvolume is given in world or voxel positions.

subVolumeWorldStart

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

Specified world start point of subvolume.

subVolumeWorldEnd

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

Selects world end point of subvolume.

tracingMethod

name: tracingMethod, type: Enum, default: Tracing_RayMarching

Selects the tracing method.

Values:

Title Name Description
Woodcock Tracing_Woodcock Use woodcock/delta tracking.
Ray Marching Tracing_RayMarching Use ray marching.

shaderType

name: shaderType, type: Enum, default: Shader_Hybrid

Selects the shader type. This can be overwritten in a SoPathTracerMaterial.

Values:

Title Name Description
Phase Shader_Phase Use the isotropic phase function (gradients of the volume are not used).
Brdf Shader_Brdf Use the material BRDF (gradients of the volume are used for shading).
Hybrid Shader_Hybrid Switch between phase function and BRDF depending on gradient magnitude. The gradient magnitude is scaled by the gradientFactor parameter.

gradientFactor

name: gradientFactor, type: Float, default: 3

The gradient factor that scales with the gradient magnitude, this only affects the hybrid shading mode.