SoView2DOverlayDecoration

InventorModule

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

Purpose

The module SoView2DOverlayDecoration renders rulers all around an image slice.

The ruler ticks can be adjusted in color and precision.

Windows

Default Panel

Input Fields

image

name: image, type: Image

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

alt: Enum	cursorShape: Enum	renderOnSlab: Bool
Border: Bool	Draw Border Outside: Bool	Right Ruler: Bool
Border Blend: Float	drawingOn: Bool	Ruler Blend: Float
Border Color: Color	editingOn: Bool	Ruler Color: Color
Bottom Ruler: Bool	fixZOn: Bool	Ruler Shadow: Bool
button1: Enum	ignoreHandledEvents: Bool	Ruler Shadow Color: Color
button2: Enum	interactionProviderID: String	selectionTolerance: Float
button3: Enum	Left Ruler: Bool	setEventHandled: Bool
clipToSlice: Bool	Long Mark Length: Float	shift: Enum
color: Color	Magnify Factor: Float	Top Ruler: Bool
control: Enum	Mark Length: Float	wantsAllEvents: Bool
createNewMode: Bool	maskValid: Bool	wantsKeyEvents: Bool
createNewModeRequest: Trigger	needsValidVoxel: Bool	wantsMouseWheelEvents: Bool

Visible Fields

Magnify Factor

name: magnifyFactor, type: Float, default: 1, minimum: 1e-05

Sets a factor that is applied to the rulers, e.g., connect from Magnify module.

Border

name: border, type: Bool, default: TRUE

If checked, a border is rendered around the slice.

Border Color

name: borderColor, type: Color, default: 1 1 1

Sets the color of the border.

Border Blend

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

Sets the alpha factor for the border.

Draw Border Outside

name: drawBorderOutside, type: Bool, default: FALSE

If checked, the border is rendered on the voxel edge (instead of the voxel center).

Ruler Color

name: rulerColor, type: Color, default: 1 1 1

Sets the color of the ruler.

Ruler Shadow

name: rulerShadow, type: Bool, default: TRUE

If checked, the a shadow is rendered behind the rulers.

Ruler Shadow Color

name: rulerShadowColor, type: Color, default: 0 0 0

Sets the color of the shadows of the rulers.

Ruler Blend

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

Sets the alpha factor for the rulers.

Mark Length

name: rulerMarkLength, type: Float, default: 4

Sets the length of the short ticks.

Long Mark Length

name: rulerLongMarkLength, type: Float, default: 8

Sets the length of the long ticks.

Left Ruler

name: leftRuler, type: Bool, default: TRUE

If checked, the ruler on the left hand side of the viewer is shown.

Right Ruler

name: rightRuler, type: Bool, default: TRUE

If checked, the ruler on the right hand side of the viewer is shown.

Top Ruler

name: topRuler, type: Bool, default: TRUE

If checked, the ruler on the top side of the viewer is shown.

Bottom Ruler

name: bottomRuler, type: Bool, default: TRUE

If checked, the ruler on the bottom side of the viewer is shown.

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: TRUE

wantsKeyEvents

name: wantsKeyEvents, type: Bool, default: TRUE

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: TRUE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

see SoView2DExtension.cursorShape