SoPathTracerVolumeInstance

InventorModule
author Florian Link
package MeVisLab/Standard
dll SoPathTracer
definition SoPathTracer.def
inherits from SoPathTracerVolumeBase

Purpose

The SoPathTracerVolumeInstance module allows to render a volume that is given by a SoPathTracerVolume as an instance of that volume (without requiring a copy of the volume data on the GPU).

The instance can have a different LUT, tag volume, mask volume, clipping behavior, subvolume, transformation and shading type. This allows to use it to create various effects, like using a different LUT on different subvolumes, transforming subvolumes.

Have a look at the example network to see how it can be used.

The instance has a Source Volume Name name which specified with volume it should render. It also has a Volume Name, which specified the name of the instanced volume. This allows other modules like SoPathTracerIsoSurface and SoPathTracerSlice to work on instances as well.

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

In this rendering, three volume instances of the same dataset are used, each using a different transformation, LUT and material.

Windows

Default Panel

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

Input Fields

inMaterial

name: inMaterial, type: SoNode

see inMaterial

inLUT

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

Output Fields

self

name: self, type: SoNode

Parameter Fields

Visible Fields

Enable Volume Rendering

name: enableVolumeRendering, type: Bool, default: TRUE

see enableVolumeRendering

Volume Name

name: volumeName, type: String, default: instance

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

Source Volume Name

name: sourceVolumeName, type: String, default: main, deprecated name: sourceVolume

The name of the source volume to use. The SoPathTracer will search for a SoPathTracerVolume with the specified name.

Hidden Fields

enabled

name: enabled, type: Bool, default: TRUE

see enabled