SoView2DGrid¶

InventorModule¶

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

Purpose¶

The SoView2DGrid renders a grid on the SoView2D. The grid is centered at the given World Position and Spacing is specified in millimeters.

Parameter Fields¶

Field Index¶

`Alpha`: `Float`	`cursorShape`: `Enum`	`selectionTolerance`: `Float`
`alt`: `Enum`	`Drawing On`: `Bool`	`setEventHandled`: `Bool`
`button1`: `Enum`	`editingOn`: `Bool`	`shift`: `Enum`
`button2`: `Enum`	`fixZOn`: `Bool`	`Spacing`: `Float`
`button3`: `Enum`	`ignoreHandledEvents`: `Bool`	`wantsAllEvents`: `Bool`
`Clip To Slice`: `Bool`	`interactionProviderID`: `String`	`wantsKeyEvents`: `Bool`
`Color`: `Color`	`Line Width`: `Float`	`wantsMouseWheelEvents`: `Bool`
`control`: `Enum`	`maskValid`: `Bool`	`World Position`: `Vector3`
`createNewMode`: `Bool`	`needsValidVoxel`: `Bool`
`createNewModeRequest`: `Trigger`	`renderOnSlab`: `Bool`

Visible Fields¶

Drawing On¶

name: drawingOn, type: Bool, default: TRUE¶

see SoView2DExtension.drawingOn

Color¶

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

see SoView2DExtension.color

Clip To Slice¶

name: clipToSlice, type: Bool, default: TRUE¶

If checked, the grid is clipped to the image.

Otherwise, the grid is visible on the entire viewer.

World Position¶

name: worldPosition, type: Vector3, default: 0 0 0¶

Sets the world position that is used as the center of the grid.

The grid is visible on all slices, regardless of the projected z position of the world position on the current slice.

Alpha¶

name: alpha, type: Float, default: 1, minimum: 0, maximum: 1¶: Sets the transparency of the given Color.

Spacing¶

name: spacing, type: Float, default: 100¶: Sets the grid spacing, given in millimeters

Line Width¶

name: lineWidth, type: Float, default: 1, minimum: 1, maximum: 16¶: Sets the line width of the grid.

Hidden Fields¶

interactionProviderID¶

name: interactionProviderID, type: String¶

see SoView2DExtension.interactionProviderID

editingOn¶

name: editingOn, type: Bool, default: FALSE¶

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¶

cursorShape¶

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR¶

see SoView2DExtension.cursorShape