SoView2DVectorFieldView

InventorModule

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

Purpose

The module SoView2DVectorFieldView overlays an image with vector data (vec2 or vec3) as vector glyphs.

Details

The visualized vectors consist of a midpoint, the vector itself and an arrow tip.

The midpoint can be considered the starting point of the vector and it is placed in the midpoint of a voxel.

The vector part reflects the length and direction of the image value vector. Note that by the optional normalization the length is set to 1 for each vector and the vector’s length can additionally be scaled by a single factor.

The arrow tip consists of a triangle at the end tip of the vector, emphasizing the direction of the vector.

If the vector parts are not displayed in fixed mode, all the width and length parameters are evaluated as percent of visible voxel sizes.

Windows

Default Panel

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

alt: Enum	drawingOn: Bool	setEventHandled: Bool
Arrow Tip Color: Color	editingOn: Bool	shift: Enum
Arrow Tip Height: Float	fixZOn: Bool	Step Width: Integer
Arrow Tip Width: Float	ignoreHandledEvents: Bool	Use Comps2And3: Bool
button1: Enum	interactionProviderID: String	Vector Color: Color
button2: Enum	maskValid: Bool	Vector fixed width: Bool
button3: Enum	Midpoint Color: Color	Vector Length: Float
clipToSlice: Bool	Midpoint fixed width: Bool	Vector Min Length: Float
color: Color	Midpoint Segments: Integer	Vector Width: Float
control: Enum	Midpoint Size: Float	wantsAllEvents: Bool
createNewMode: Bool	needsValidVoxel: Bool	wantsKeyEvents: Bool
createNewModeRequest: Trigger	Normalize Vectors: Bool	wantsMouseWheelEvents: Bool
cursorShape: Enum	renderOnSlab: Bool
Draw Arrow Tips: Bool	selectionTolerance: Float

Visible Fields

Midpoint Size

name: midpointSize, type: Float, default: 0.059999999

Sets the radius of the center point.

Vector Width

name: vectorWidth, type: Float, default: 0.1

Sets the width of the vectors.

Vector Length

name: vectorLength, type: Float, default: 1

Set the length of the vectors.

Vector Min Length

name: vectorMinLength, type: Float, default: 0

Sets the minimum length a vector requires to be rendered.

Midpoint Segments

name: midpointSegments, type: Integer, default: 10

Sets the number of segments of the individual midpoints.

Midpoint fixed width

name: midpointAbsoluteSize, type: Bool, default: FALSE

If checked, an absolute value is used for the midpoint size.

Vector fixed width

name: vectorAbsoluteSize, type: Bool, default: TRUE

If checked, the vector width is set to 1 voxel.

Vector Color

name: vectorColor, type: Color, default: 1 0 0

Sets the color of the individual vectors.

Midpoint Color

name: midpointColor, type: Color, default: 1 1 1

Sets the color of the center points.

Step Width

name: stepWidth, type: Integer, default: 1, minimum: 1

Sets the step distance between shown vectors.

Draw Arrow Tips

name: drawArrowTips, type: Bool, default: FALSE

If checked, arrow tips are drawn.

Arrow Tip Color

name: arrowTipColor, type: Color, default: 0 1 0

Sets the color of the arrow tips.

Arrow Tip Width

name: arrowTipWidth, type: Float, default: 0.2

Sets the width of the arrow tips.

Arrow Tip Height

name: arrowTipHeight, type: Float, default: 0.2

Sets the height of the arrow tips.

Normalize Vectors

name: normalizeVectors, type: Bool, default: TRUE

If checked, all vectors are normalized.

Use Comps2And3

name: useComps2And3, type: Bool, default: FALSE

If checked, the components 2 and 3 are used as x and y components for the vectors.

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