SoPathTracerVolumeInstance

InventorModule

author	MeVis Medical Solutions AG
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.

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

Windows

Default Panel

Input Fields

inMaterial

name: inMaterial, type: SoNode

see SoPathTracerVolumeBase.inMaterial

inLUT

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

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Enable Clipping: Bool	Mask Volume Name: String	Use world positions: Bool
Enable Volume Rendering: Bool	Matrix: Matrix	Volume Name: String
enabled: Bool	Self Shadowing Offset: Float	World End Position: Vector3
Flip Clipping: Bool	Shader Type: Enum	World Start Position: Vector3
Gradient Factor: Float	Source Volume Name: String	X (subVolumeStartX): Integer
Mask Alpha0: Float	Step Size Factor: Float	X (subVolumeEndX): Integer
Mask Alpha1: Float	Step Size Factor Shadow: Float	Y (subVolumeStartY): Integer
Mask Color0: Color	Tag Volume Name: String	Y (subVolumeEndY): Integer
Mask Color1: Color	Time Point: Integer	Z (subVolumeStartZ): Integer
Mask Tag0: Integer	Tracing Method: Enum	Z (subVolumeEndZ): Integer
Mask Tag1: Integer	Transpose matrix: Bool

Visible Fields

Enable Volume Rendering

name: enableVolumeRendering, type: Bool, default: TRUE

see SoPathTracerVolumeBase.enableVolumeRendering

Volume Name

name: volumeName, type: String, default: instance

see SoPathTracerVolumeBase.volumeName

Mask Volume Name

name: maskVolumeName, type: String, default: mask

see SoPathTracerVolumeBase.maskVolumeName

Tag Volume Name

name: tagVolumeName, type: String, default: tags

see SoPathTracerVolumeBase.tagVolumeName

Time Point

name: timePoint, type: Integer, default: 0

see SoPathTracerVolumeBase.timePoint

Mask Color0

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

see SoPathTracerVolumeBase.maskColor0

Mask Color1

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

see SoPathTracerVolumeBase.maskColor1

Mask Alpha0

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

see SoPathTracerVolumeBase.maskAlpha0

Mask Alpha1

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

see SoPathTracerVolumeBase.maskAlpha1

Mask Tag0

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

see SoPathTracerVolumeBase.maskTag0

Mask Tag1

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

see SoPathTracerVolumeBase.maskTag1

Step Size Factor

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

see SoPathTracerVolumeBase.stepSizeFactor

Step Size Factor Shadow

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

see SoPathTracerVolumeBase.stepSizeFactorShadow

Self Shadowing Offset

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

see SoPathTracerVolumeBase.selfShadowingOffset

Transpose matrix

name: transposeAdditionalMatrix, type: Bool, default: TRUE

see SoPathTracerVolumeBase.transposeAdditionalMatrix

Matrix

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

see SoPathTracerVolumeBase.additionalMatrix

Enable Clipping

name: enableClipping, type: Bool, default: TRUE

see SoPathTracerVolumeBase.enableClipping

Flip Clipping

name: flipClipping, type: Bool, default: FALSE

see SoPathTracerVolumeBase.flipClipping

X (subVolumeStartX)

name: subVolumeStartX, type: Integer, default: 0

see SoPathTracerVolumeBase.subVolumeStartX

Y (subVolumeStartY)

name: subVolumeStartY, type: Integer, default: 0

see SoPathTracerVolumeBase.subVolumeStartY

Z (subVolumeStartZ)

name: subVolumeStartZ, type: Integer, default: 0

see SoPathTracerVolumeBase.subVolumeStartZ

X (subVolumeEndX)

name: subVolumeEndX, type: Integer, default: 999999

see SoPathTracerVolumeBase.subVolumeEndX

Y (subVolumeEndY)

name: subVolumeEndY, type: Integer, default: 999999

see SoPathTracerVolumeBase.subVolumeEndY

Z (subVolumeEndZ)

name: subVolumeEndZ, type: Integer, default: 999999

see SoPathTracerVolumeBase.subVolumeEndZ

Use world positions

name: subVolumeUseWorldPositions, type: Bool, default: FALSE

see SoPathTracerVolumeBase.subVolumeUseWorldPositions

World Start Position

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

see SoPathTracerVolumeBase.subVolumeWorldStart

World End Position

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

see SoPathTracerVolumeBase.subVolumeWorldEnd

Tracing Method

name: tracingMethod, type: Enum, default: Tracing_RayMarching

see SoPathTracerVolumeBase.tracingMethod

Shader Type

name: shaderType, type: Enum, default: Shader_Hybrid

see SoPathTracerVolumeBase.shaderType

Gradient Factor

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

see SoPathTracerVolumeBase.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 SoPathTracerVolumeBase.enabled