VTKRemoteRendering

MLModule
author MeVis Medical Solutions AG
package MeVisLab/VTK
dll MLVTKRemoteRendering
definition MLVTKRemoteRendering.def
see also RemoteRendering
keywords offscreen

Purpose

The VTKRemoteRendering module allows to render a VTK visualization (represented as a vtkRenderer) using the MeVisLab remote rendering protocol.

In addition to the single vtkRenderer input, the module is also scriptable to:

  • access the render window and interactor
  • set the interactor style
  • add multiple renderers

To access the scripting API, just do:

API = ctx.object()

e.g. to add a renderer dynamically:

import vtk

ren = vtk.vtkRenderer()
ctx.object().GetRenderWindow().AddRenderer(ren)

Note: VTK cursor shapes are currently not supported, since vtkRenderWindow.SetCurrentCursor() seems to be used seldomly. If you require VTK cursors, please send a feature request.

Input Fields

inputVtkRenderer

name: inputVtkRenderer, type: VTKObjectWrapper(MLBase)

A vtkRenderer is expected.

Output Fields

output

name: output, type: RemoteRendering(MLBase)

The remote rendering base object.

For accessing this object via scripting see the Scripting Reference: MLRemoteRenderingWrapper.

Parameter Fields

Visible Fields

Enable Multi Sampling

name: enableMultiSampling, type: Bool, default: FALSE

Enable the usage of a MSAA buffer.

Multi Sampling

name: multiSampling, type: Integer, default: 16

Defines the multi sampling for MSAA buffers.

Intercept double-clicks

name: interceptDoubleClicks, type: Bool, default: FALSE

Defines if double clicks are to be intercepted.

<Double-click intercepted>

name: doubleClickIntercepted, type: Trigger

Is triggered if a double click was intercepted.

Supported

name: supported, type: Bool, persistent: no

Shows if the module is supported by the hardware (requires Pbuffers or framebuffer objects).

Use stencil buffer

name: stencilBuffer, type: Bool, default: FALSE

Enable/Disable the stencil buffer.

Suppress render updates

name: suppressUpdates, type: Bool, default: FALSE

If enabled, no render updates are propagated.

Hidden Fields

imageRendered

name: imageRendered, type: Trigger

storeTransparency

name: storeTransparency, type: Bool, default: FALSE

overrideStreamingQuality

name: overrideStreamingQuality, type: Bool, default: FALSE

interactiveImageType

name: interactiveImageType, type: Enum, default: JPG

Values:

Title Name
Jpg JPG
Png PNG
Bmp BMP
Webp Lossy WEBP_LOSSY
Webp Lossless WEBP_LOSSLESS
Jpg Alpha JPG_ALPHA

highQualityImageType

name: highQualityImageType, type: Enum, default: PNG

Values:

Title Name
Jpg JPG
Png PNG
Bmp BMP
Webp Lossy WEBP_LOSSY
Webp Lossless WEBP_LOSSLESS
Jpg Alpha JPG_ALPHA

interactiveJpgQuality

name: interactiveJpgQuality, type: Integer, default: 70

highQualityJpgQuality

name: highQualityJpgQuality, type: Integer, default: 100

imageCacheId

name: imageCacheId, type: String

clearImageCacheOnClient

name: clearImageCacheOnClient, type: Trigger