SoGVRTransformedVolume

InventorModule

genre	VolRendExtensions
status	stable
author	Florian Link
package	MeVisLab/Standard
dll	SoGVR
definition	soGVR.def

Purpose

The SoGVRTransformedVolume module allows to set an additional volume that is represented as a single 3D texture. The volume's world matrix is not restricted in respect to the world matrix of the main volume of the GVR renderer (in contrast to SoGVRSecondaryVolume), so the transformed volume can be rendered scaled/rotated/translated in respect to the main volume and this transformation can be updated interactively without requiring a reload of the volume data. NOTE: Since this module uses a single 3D texture, you should not use a volume size that does not fit on your graphics card. If you want to show large volumes, you should use SoGVRSecondaryVolume. The number of SoGVRTransformedVolume modules that can be used in a renderer are limited by the texture memory and by the number of available texture image units of your graphics board.

• Combine Mode: Defines how the transformed volume data is combined with the main volume.

Transform

Allows to transform the mask volume in world coordinates, only works if the Transform Mode is set to "Use Woorld Coordinates". This can be used to move the mask volume in the rendered volume, to e.g. highlight a region with a sphere.

• Modify world coordinates: additional transforms or world to voxel matrix replacement will only be applied if this field is set to true
• World Center: defines the new world center of the mask volume, takes the center of the mask volume and moves it to the new center
• World Rotation: defines the additional rotation (around the center of the volume)
• World Scale: defines the scaling of the mask volume in world coordinates
• Replace World To Voxel Matrix: If enabled, the world to voxel matrix of the transformed volume will be replaced by the user supplied matrix.
• Custom World To Voxel Matrix: User supplied world to voxel matrix. NOTE: The matrix must be entered according to Open Inventor convention (transposed from a ML matrix).

Windows

Default Panel

Input Fields

image

name: image, type: Image

ML image to use as transformed volume.

Output Fields

self

name: self, type: SoNode

a node that should be put in front of the SoGVRVolumeRenderer

Parameter Fields

Field Index

Associated Lut Name: String	Transform Mode: Enum
Combine Mode: Enum	Visibility: Enum
Custom World To Voxel Matrix: Matrix	Volume Name: String
Enable Rendering: Bool	World Center: Vector3
Enabled: Bool	World Rotation: Rotation
Filter Data: Bool	World Scale: Vector3
Modify World Coordinates: Bool
Replace World To Voxel Matrix: Bool

Visible Fields

Enabled

name: enabled, type: Bool, default: TRUE

Defines if the transformed volume is used/loaded.

Transform Mode

name: transformMode, type: Enum, default: UseWorldCoordinates

Defines how to transform the volume.

Values:

Title	Name	Description
Use World Coordinates	UseWorldCoordinates	Uses the world coordinates of the input volume to transform the volume relative to the main volume.
Scale To Image	ScaleToImage	Scales this volume to the extent of the main volume.

Modify World Coordinates

name: modifyWorldCoordinates, type: Bool, default: FALSE

Enables modification of the world coordinates.

World Center

name: worldCenter, type: Vector3, default: 0 0 0

The center of the world coordinate scale/rotation.

World Scale

name: worldScale, type: Vector3, default: 1 1 1

Scale the world coordinates.

World Rotation

name: worldRotation, type: Rotation, default: 0 0 1 3.14159274101257

Rotate around the World Center.

Replace World To Voxel Matrix

name: replaceWorldToVoxelMatrix, type: Bool, default: FALSE, deprecated name: useTransformationMatrix

Replace the world matrix with the Custom World To Voxel Matrix.

Custom World To Voxel Matrix

name: customWorldToVoxelMatrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1, deprecated name: transformationMatrix

Defines a custom world matrix to be used with Replace World To Voxel Matrix is enabled.

Enable Rendering

name: enableRendering, type: Bool, default: TRUE

Enables the rendering of the volume

Volume Name

name: volumeName, type: String, default: transformedVolume

Defines the unique name that will be used to address this volume (in the SoGVRShaderFunction shaders but also for SoGVRTransformedVolumeSettings)

Associated Lut Name

name: associatedLutName, type: String, default: secondaryLut

Gives the name of a SoGVRSecondaryLUT that should be applied on the volume data.

Filter Data

name: filterData, type: Bool, default: TRUE

Enables linear interpolation when sampling the data.

Visibility

name: visibility, type: Enum, default: VolumeVisibleWithSecondaryLUT

Defines the visibilty of the data.

Values:

Title	Name
Always Visible	VolumeAlwaysVisible
Same Visibility As Main Volume	VolumeSameVisibilityAsMainVolume
Visible With Secondary LUT	VolumeVisibleWithSecondaryLUT

Combine Mode

name: combineMode, type: Enum, default: CombineBlend

Defines how to combine the transformed volume with the main volume and other volumes.

Values:

Title	Name
Add	CombineAdd
Max	CombineMax
Blend	CombineBlend