SoView2DCurrentState¶

InventorModule¶

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

Purpose¶

The SoView2DCurrentState allows for receiving view dependent parameters from a currently rendered SoView2D to use them in scripting. Note that this will not work on SoOrthoView2D or when the SoView2D is used in mosaic mode.

Parameter Fields¶

Field Index¶

`alt`: `Enum`	`editingOn`: `Bool`	`selectionTolerance`: `Float`
`button1`: `Enum`	`fixZOn`: `Bool`	`setEventHandled`: `Bool`
`button2`: `Enum`	`ignoreHandledEvents`: `Bool`	`shift`: `Enum`
`button3`: `Enum`	`Image Device Rect0`: `Vector2`	`Visible Device Rect0`: `Vector2`
`clipToSlice`: `Bool`	`Image Device Rect1`: `Vector2`	`Visible Device Rect1`: `Vector2`
`color`: `Color`	`interactionProviderID`: `String`	`Visible World Rect0`: `Vector3`
`control`: `Enum`	`maskValid`: `Bool`	`Visible World Rect1`: `Vector3`
`createNewMode`: `Bool`	`needsValidVoxel`: `Bool`	`wantsAllEvents`: `Bool`
`createNewModeRequest`: `Trigger`	`Pixel Spacing X`: `Float`	`wantsKeyEvents`: `Bool`
`cursorShape`: `Enum`	`Pixel Spacing Y`: `Float`	`wantsMouseWheelEvents`: `Bool`
`drawingOn`: `Bool`	`renderOnSlab`: `Bool`

Visible Fields¶

Pixel Spacing X¶

name: pixelSpacingX, type: Float, persistent: no¶

Shows the pixel spacing (zoom) in millimeters.

This defines the size of a single pixel in world coordinates. Typically, Pixel Spacing Y has the same value because SoView2D respects the voxel size. However, the values may differ if one of the special scale modes is used.

Pixel Spacing Y¶

name: pixelSpacingY, type: Float, persistent: no¶

Shows the pixel spacing (zoom) in millimeters.

This defines the size of a single pixel in world coordinates. Typically, Pixel Spacing X has the same value because SoView2D respects the voxel size. However, the values may differ if one of the special scale modes is used.

Visible Device Rect0¶

name: visibleDeviceRect0, type: Vector2, persistent: no¶

Shows the top-left point of the visible device rectangle of the viewer.

This refers to the entire area of the viewer, regardless of where the image is shown or zoomed.

Visible Device Rect1¶

name: visibleDeviceRect1, type: Vector2, persistent: no¶

Shows the bottom-right point of the visible device rectangle of the viewer.

This refers to the entire area of the viewer, regardless of where the image is shown or zoomed.

Image Device Rect0¶

name: imageDeviceRect0, type: Vector2, persistent: no¶

Shows the top-left point of the image.

This point can be outside the visible device rectangle if the image is zoomed in.

Image Device Rect1¶

name: imageDeviceRect1, type: Vector2, persistent: no¶

Shows the bottom-right point of the image.

This point can be outside the visible device rectangle if the image is zoomed in.

Visible World Rect0¶

name: visibleWorldRect0, type: Vector3, persistent: no¶

Shows the uppermost left point of the image that is visible in the viewer, in world coordinates.

This can, for example, be fed into a SoView2DRectangle to indicate the visible portion of the image on an overview image.

Visible World Rect1¶

name: visibleWorldRect1, type: Vector3, persistent: no¶

Shows the lowermost right point of the image that is visible in the viewer, in world coordinates.

This can, for example, be fed into a SoView2DRectangle to indicate the visible portion of the image on an overview image.

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