SoView2DRuler¶

InventorModule¶

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

Purpose¶

The module SoView2DRuler displays a vertical and/or a horizontal ruler at the borders of the 2D scene of a SoView2D

Usage¶

The visibility of the horizontal and vertical ruler can be configured manually.

Details¶

The scale and units of the rulers depend on the zoom level of the image.

Tips¶

The vertical position can be configured to start at the top (for 3D US images) with the hidden field moveVerticalRulerToTop.

Windows¶

Default Panel¶

../../../Modules/Inventor/SoView2D/mhelp/Images/Screenshots/SoView2DRuler._default.png

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

`alt`: `Enum`	`drawingOn`: `Bool`	`needsValidVoxel`: `Bool`
`button1`: `Enum`	`editingOn`: `Bool`	`renderOnSlab`: `Bool`
`button2`: `Enum`	`fixZOn`: `Bool`	`selectionTolerance`: `Float`
`button3`: `Enum`	`Font Size`: `Integer`	`setEventHandled`: `Bool`
`clipToSlice`: `Bool`	`ignoreHandledEvents`: `Bool`	`shift`: `Enum`
`Color`: `Color`	`interactionProviderID`: `String`	`Show horizontal ruler`: `Bool`
`control`: `Enum`	`Margin (verticalRulerMarginRight)`: `Integer`	`Show vertical ruler`: `Bool`
`createNewMode`: `Bool`	`Margin (horizontalRulerMarginBottom)`: `Integer`	`wantsAllEvents`: `Bool`
`createNewModeRequest`: `Trigger`	`maskValid`: `Bool`	`wantsKeyEvents`: `Bool`
`cursorShape`: `Enum`	`moveVerticalRulerToTop`: `Bool`	`wantsMouseWheelEvents`: `Bool`

Visible Fields¶

Color¶

name: color, type: Color, default: 1 1 1¶: Sets the color of the ruler.

Show vertical ruler¶

name: verticalRuler, type: Bool, default: TRUE, deprecated name: showVerticalRuler¶: If checked, the vertical ruler is displayed.

Show horizontal ruler¶

name: horizontalRuler, type: Bool, default: FALSE, deprecated name: showHorizontalRuler¶: If checked, the horizontal ruler is displayed.

Margin (verticalRulerMarginRight)¶

name: verticalRulerMarginRight, type: Integer, default: 8¶: Sets the margin of the vertical ruler to the viewer’s right border in pixels.

Margin (horizontalRulerMarginBottom)¶

name: horizontalRulerMarginBottom, type: Integer, default: 8¶: Sets the margin of the horizontal ruler to the viewer’s bottom border in pixels.

Font Size¶

name: rulerFontSize, type: Integer, default: 12, minimum: 6, maximum: 64¶: Sets the font size of the ruler text.

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¶

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

moveVerticalRulerToTop¶

name: moveVerticalRulerToTop, type: Bool, default: FALSE, deprecated name: coupleVerticalRulerToSkinLine¶