SoView2DCine

InventorModule

genre	View2D
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoView2D
definition	view2d.def
inherits from	SoView2DExtension

Purpose

The module SoView2DCine provides an extended cinematic function for a 2D viewer.

Details

Additionally to the cinematic functions offered by SoView2D, this module allows for setting an increment different from 1 for slicing through the image. This can be used in combination with SoView2D’s slab for slicing through the image slab by slab.

Windows

Default Panel

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

alt: Enum	fixZOn: Bool	setEventHandled: Bool
button1: Enum	ignoreHandledEvents: Bool	shift: Enum
button2: Enum	interactionProviderID: String	Slice: Integer
button3: Enum	maskValid: Bool	Slice Increment: Integer
Cine mode is active: Bool	Max Slice: Integer	Speed: Float
clipToSlice: Bool	Max Time Point: Integer	Start: Trigger
color: Color	Min Slice: Integer	Stop: Trigger
control: Enum	Min Time Point: Integer	Time Point: Integer
createNewMode: Bool	Mode: Enum	Time Point Increment: Integer
createNewModeRequest: Trigger	needsValidVoxel: Bool	wantsAllEvents: Bool
cursorShape: Enum	renderOnSlab: Bool	wantsKeyEvents: Bool
Direction: Enum	Repeat: Enum	wantsMouseWheelEvents: Bool
drawingOn: Bool	Reset slice/time before starting: Bool
editingOn: Bool	selectionTolerance: Float

Visible Fields

Start

name: start, type: Trigger

When pressed, the cinematic function (automatically slicing through the image in determined range) is started.

Note: to record a movie of the slicing, attach a SoExaminerViewer or a SoRenderArea to the corresponding SoView2D and use the movie recording of those modules.

Stop

name: stop, type: Trigger

When pressed, the cinematic function is stopped.

Slice

name: slice, type: Integer, default: 0, minimum: :field:`minSlice`, maximum: :field:`maxSlice`

Sets and shows the current slice.

Time Point

name: timePoint, type: Integer, default: 0, minimum: :field:`minTimePoint`, maximum: :field:`maxTimePoint`

Sets and shows the current time point.

Min Slice

name: minSlice, type: Integer, default: 0, minimum: 0, maximum: :field:`maxSlice`

Sets the first slice for slicing in the z-dimension for the cinematic function.

Max Slice

name: maxSlice, type: Integer, default: 0, minimum: :field:`minSlice`

Sets the last slice for slicing in the z-dimension for the cinematic function.

Slice Increment

name: sliceIncrement, type: Integer, default: 1, minimum: 1

Sets the slice increment for slicing in the z-dimension for the cinematic function.

Min Time Point

name: minTimePoint, type: Integer, default: 0, minimum: 0, maximum: :field:`maxTimePoint`

Sets the first slice for slicing in the t-dimension for the cinematic function.

Max Time Point

name: maxTimePoint, type: Integer, default: 0, minimum: :field:`minTimePoint`

Sets the last slice for slicing in the t-dimension for the cinematic function.

Time Point Increment

name: timePointIncrement, type: Integer, default: 1, minimum: 1

Sets the slice increment for slicing in the t-dimension for the cinematic function.

Mode

name: mode, type: Enum, default: CINE_Z

Defines through which dimension the cinematic should slice.

Values:

Title	Name	Description
​Z	​CINE_Z	​Go through slices.
​T	​CINE_T	​Go through time points.
​ZT	​CINE_ZT	​Go through slices, then time points. This mode only allows for moving forward.
​TZ	​CINE_TZ	​Go through time points, then slices. This mode only allows for moving forward.

Direction

name: direction, type: Enum, default: CINE_PINGPONG

Defines the cinematic function.

Values:

Title	Name	Description
​Forward	​CINE_FORWARD	​Go forward through slices/time points. If Repeat is set to CINE_REPEAT, start from beginning when at the end.
​Pingpong	​CINE_PINGPONG	​Go forward, then backwards through slices or time points.

Repeat

name: repeat, type: Enum, default: CINE_ONCE

Defines how the cinematic function should be repeated.

Values:

Title	Name	Description
​Once	​CINE_ONCE	​Only go through slices/time points once (or twice, if Direction is set to CINE_PINGPONG).
​Repeat	​CINE_REPEAT	​Go through slices/time points until the user stops the cine mode (with Stop).

Speed

name: speed, type: Float, default: 0.1, minimum: 0.0001

Sets the speed of the cinematic function by setting the waiting time in seconds between showing consecutive slices.

Reset slice/time before starting

name: resetOnStart, type: Bool, default: TRUE

If checked, the module starts with the first slice in cine mode, no matter what slice is actually shown at that time.

Cine mode is active

name: active, type: Bool, persistent: no

Shows the status of the cinematic function.

Hidden Fields

interactionProviderID

name: interactionProviderID, type: String

see SoView2DExtension.interactionProviderID

drawingOn

name: drawingOn, type: Bool, default: TRUE

see SoView2DExtension.drawingOn

editingOn

name: editingOn, type: Bool, default: TRUE

see SoView2DExtension.editingOn

maskValid

name: maskValid, type: Bool, persistent: no

fixZOn

name: fixZOn, type: Bool, default: TRUE

color

name: color, type: Color, default: 1 1 1

see SoView2DExtension.color

selectionTolerance

name: selectionTolerance, type: Float, default: 4

needsValidVoxel

name: needsValidVoxel, type: Bool, default: TRUE

see SoView2DExtension.needsValidVoxel

button1

name: button1, type: Enum, default: IGNORED

see SoView2DExtension.button1

button2

name: button2, type: Enum, default: IGNORED

see SoView2DExtension.button2

button3

name: button3, type: Enum, default: IGNORED

see SoView2DExtension.button3

shift

name: shift, type: Enum, default: IGNORED

see SoView2DExtension.shift

control

name: control, type: Enum, default: IGNORED

see SoView2DExtension.control

alt

name: alt, type: Enum, default: IGNORED

see SoView2DExtension.alt

wantsAllEvents

name: wantsAllEvents, type: Bool, default: FALSE

wantsKeyEvents

name: wantsKeyEvents, type: Bool, default: FALSE

wantsMouseWheelEvents

name: wantsMouseWheelEvents, type: Bool, default: FALSE

setEventHandled

name: setEventHandled, type: Bool, default: FALSE

see SoView2DExtension.setEventHandled

ignoreHandledEvents

name: ignoreHandledEvents, type: Bool, default: FALSE

see SoView2DExtension.ignoreHandledEvents

createNewMode

name: createNewMode, type: Bool, default: FALSE

see SoView2DExtension.createNewMode

createNewModeRequest

name: createNewModeRequest, type: Trigger

see SoView2DExtension.createNewModeRequest

renderOnSlab

name: renderOnSlab, type: Bool, default: FALSE

clipToSlice

name: clipToSlice, type: Bool, default: FALSE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

see SoView2DExtension.cursorShape