SoView2DOverlay

InventorModule

genre	View2D
author	Florian Link
package	MeVisLab/Standard
dll	SoView2D
definition	view2d.def
see also	SoView2D
keywords	extension

Purpose

The module SoView2DOverlay blends an 2D image over another one in a 2D viewer.

Note that this module is not intended to work with OrthoView2D; in this case, use a GVROrthoOverlay.

Windows

Default Panel

Input Fields

image

name: image, type: Image

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Alpha Factor: Float	createNewModeRequest: Trigger	needsValidVoxel: Bool
alt: Enum	cursorShape: Enum	Overwrite Current Time Point: Bool
applyLut: Bool	Draw checker tiles: Bool	Render On Slab: Bool
Base Color: Color	Drawing On: Bool	selectionTolerance: Float
Blend Mode: Enum	editingOn: Bool	setEventHandled: Bool
button1: Enum	Filter Mode: Enum	shift: Enum
button2: Enum	fixZOn: Bool	Tile Size: Integer
button3: Enum	ignoreHandledEvents: Bool	Timepoint: Integer
Cache Textures: Bool	Inherit filter mode from SoView2D: Bool	Use world coordinates: Bool
clipToSlice: Bool	Invert tiles: Bool	wantsAllEvents: Bool
color: Color	Lut Precision: Enum	wantsKeyEvents: Bool
control: Enum	maskValid: Bool	wantsMouseWheelEvents: Bool
createNewMode: Bool	maxTimePoint: Integer

Visible Fields

Drawing On

name: drawingOn, type: Bool, default: TRUE

If checked, the module renders its input image over another one.

Render On Slab

name: renderOnSlab, type: Bool, default: TRUE

If checked, the module can render the overlay correctly if the viewer is in slab mode (displaying multiple sequential slices). The overlay is then rendered separately on each slice within the slab. This happens before all View2D Extensions with Render On Slab set to FALSE are rendered.

Cache Textures

name: cacheTextures, type: Bool, default: TRUE

If checked, the module caches the textures that are used to build the overlay rendering.

Blend Mode

name: blendMode, type: Enum, default: BLEND_ADD

Defines the blend mode for the overlay rendering.

Values:

Title	Name
Replace	BLEND_REPLACE
Add	BLEND_ADD
Blend	BLEND_BLEND
Maximum	BLEND_MAXIMUM
Minimum	BLEND_MINIMUM
Reverse Subtract	BLEND_REVERSE_SUBTRACT
Subtract	BLEND_SUBTRACT

Overwrite Current Time Point

name: overwriteCurrentTimePoint, type: Bool, default: FALSE

If checked, the current time point is not taken from the viewer but from the field Timepoint.

Timepoint

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

Sets the time point explicitly if Overwrite Current Time Point is checked.

Filter Mode

name: filterMode, type: Enum, default: FILTER_LINEAR

Defines the filter mode (interpolation mode) of the module for fitting the voxels onto screen pixels.

Values:

Title	Name
Nearest	FILTER_NEAREST
Linear	FILTER_LINEAR
Linear Postclass	FILTER_LINEAR_POSTCLASS
Cubic Postclass	FILTER_CUBIC_POSTCLASS

Inherit filter mode from SoView2D

name: inheritFilterMode, type: Bool, default: TRUE

If checked, the filter mode (interpolation mode) of the module is inherited from the according parameter in the SoView2D.

Lut Precision

name: lutPrecision, type: Enum, default: VIEW2D_LUT_AUTO

Sets the precision of the LUT.

Values:

Title	Name	Description
Auto	VIEW2D_LUT_AUTO	The LUT precision is calculated using the input dataset's min and max values. The maximum supported LUT precision is 16 bits. If the input dataset is a floating point type, the LUT uses 12 bit.
8bit	VIEW2D_LUT_8BIT	The LUT precision is 8 bit, regardless of the input data type.
12bit	VIEW2D_LUT_12BIT	The LUT precision is 12 bit, regardless of the input data type.
16bit	VIEW2D_LUT_16BIT	The LUT precision is 16 bit, regardless of the input data type.

Alpha Factor

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

Sets the alpha factor for the overlay rendering.

Base Color

name: baseColor, type: Color, default: 1 1 1

Sets the base color for the overlay rendering.

Use world coordinates

name: useWorldCoords, type: Bool, default: FALSE

If checked, the overlay image is drawn at world coordinates.

Draw checker tiles

name: isCheckerTiling, type: Bool, default: FALSE

If checked, checkerboard tilings of the current image are drawn.

Tile Size

name: checkerTileSize, type: Integer, default: 2, minimum: 2

Sets the size of the individual checker tiles.

Invert tiles

name: areCheckerTilesInverted, type: Bool, default: FALSE

If checked, the drawing of the checker tiles is inverted.

Hidden Fields

editingOn

name: editingOn, type: Bool, default: TRUE

maskValid

name: maskValid, type: Bool, default: FALSE

fixZOn

name: fixZOn, type: Bool, default: TRUE

color

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

selectionTolerance

name: selectionTolerance, type: Float, default: 4

needsValidVoxel

name: needsValidVoxel, type: Bool, default: TRUE

button1

name: button1, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

button2

name: button2, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

button3

name: button3, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

shift

name: shift, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

control

name: control, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

alt

name: alt, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

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

ignoreHandledEvents

name: ignoreHandledEvents, type: Bool, default: FALSE

createNewMode

name: createNewMode, type: Bool, default: FALSE

createNewModeRequest

name: createNewModeRequest, type: Trigger

clipToSlice

name: clipToSlice, type: Bool, default: TRUE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

Values:

Title	Name
Undefined Cursor	UNDEFINED_CURSOR
Default Cursor	DEFAULT_CURSOR
Forbidden Cursor	FORBIDDEN_CURSOR
Pointing Hand Cursor	POINTING_HAND_CURSOR
Open Hand Cursor	OPEN_HAND_CURSOR
Closed Hand Cursor	CLOSED_HAND_CURSOR
Move All Cursor	MOVE_ALL_CURSOR
Move Hori Cursor	MOVE_HORI_CURSOR
Move Vert Cursor	MOVE_VERT_CURSOR
Move Fdiag Cursor	MOVE_FDIAG_CURSOR
Move Bdiag Cursor	MOVE_BDIAG_CURSOR
Move Inout Cursor	MOVE_INOUT_CURSOR
Rotate X Cursor	ROTATE_X_CURSOR
Rotate Y Cursor	ROTATE_Y_CURSOR
Rotate Z Cursor	ROTATE_Z_CURSOR
Rotate Xy Cursor	ROTATE_XY_CURSOR
Zoom Cursor	ZOOM_CURSOR
Zoom In Cursor	ZOOM_IN_CURSOR
Zoom Out Cursor	ZOOM_OUT_CURSOR
Cross Cursor	CROSS_CURSOR
Cross Plus Cursor	CROSS_PLUS_CURSOR
Cross Minus Cursor	CROSS_MINUS_CURSOR
Cross Move Cursor	CROSS_MOVE_CURSOR
Cross Rotate Cursor	CROSS_ROTATE_CURSOR
Cross Rect Cursor	CROSS_RECT_CURSOR
Cross Oval Cursor	CROSS_OVAL_CURSOR
Cross Vector Cursor	CROSS_VECTOR_CURSOR
Cross Freeform Cursor	CROSS_FREEFORM_CURSOR
Cross Point Cursor	CROSS_POINT_CURSOR
Cross Line Cursor	CROSS_LINE_CURSOR
Cross Curve Cursor	CROSS_CURVE_CURSOR
Cross Polyline Cursor	CROSS_POLYLINE_CURSOR
Cross Polygon Cursor	CROSS_POLYGON_CURSOR
Cross Fill Cursor	CROSS_FILL_CURSOR
Cross Link Cursor	CROSS_LINK_CURSOR
Cross 0 Cursor	CROSS_0_CURSOR
Cross 1 Cursor	CROSS_1_CURSOR
Cross 2 Cursor	CROSS_2_CURSOR
Cross 3 Cursor	CROSS_3_CURSOR
Lut Cursor	LUT_CURSOR
Slicing Cursor	SLICING_CURSOR
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR

maxTimePoint

name: maxTimePoint, type: Integer, default: 0

applyLut

name: applyLut, type: Bool, default: TRUE