So3DMarkerRenderer

InventorModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	So3DXMarker
definition	So3DMarkerEditor.def
see also	XMarkerListContainer, SoView2DMarkerEditor
keywords	markerlist, vector, interaction, SoMarker, SoXMarker

Purpose

The So3DMarkerRenderer allows for rendering markers from an XMarkerList. It supports various optimized rendering methods for rendering points, point sprites, spheres, and vectors.

It does not allow interaction (picking, editing of markers), for this you should use So3DMarkerEditor.

Windows

Default Panel

Input Fields

inMarkers

name: inMarkers, type: XMarkerList(MLBase)

The XMarkerList.

For accessing this object via scripting, see the Scripting Reference: MLXMarkerListWrapper.

inStylePalette

name: inStylePalette, type: StylePalette(MLBase)

The optional StylePalette, which is used for per-marker coloring.

inLUT

name: inLUT, type: LUTFunction(MLBase)

The optional LUT, which is used for per-marker coloring. If both, valid StylePalette and LUT are connected, the StylePalette will be used.

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Ambient Color: Color	Marker Render Mode: Enum	Timepoint to Render (-1=all): Integer
Arrow Cylinder Radius: Float	Marker Size: Float	Vector Render Mode: Enum
Arrow Head Size: Float	pickCulling: Enum	Vector Scale: Float
boundingBoxCaching: Enum	Plane Normal: Vector3
Color Mode: Enum	renderCaching: Enum
Diffuse Color: Color	renderCulling: Enum
Geometry Complexity: Enum	Shininess: Float
Line Width: Float	Specular Color: Color

Visible Fields

Marker Render Mode

name: markerRenderMode, type: Enum, default: PointSprite

Defines how markers should be rendered.

Values:

Title	Name	Description
​Point	​Point	​As square 2D points.
​Point Sprite	​PointSprite	​As shaded spheres using SoPointSpriteRenderer.
​Sphere	​Sphere	​As geometric spheres.
​No Marker	​NoMarker	​No markers at all.

Vector Render Mode

name: vectorRenderMode, type: Enum, default: NoVector

Defines how the vector component of the markers should be rendered.

Values:

Title	Name	Description
​No Vector	​NoVector	​No vector should be drawn.
​Line	​Line	​Draws lines.
​Line With Arrow	​LineWithArrow	​Draws lines with a cone as arrow head.
​Cylinder	​Cylinder	​Draws cylinders.
​Cylinder With Arrow	​CylinderWithArrow	​Draws a cylinder with a cone as arrow head.

Geometry Complexity

name: geometryComplexity, type: Enum, default: LOW

Defines the complexity of the geometry tessellation.

Values:

Title	Name
​Very Low	​VERY_LOW
​Low	​LOW
​Medium	​MEDIUM
​High	​HIGH
​Very High	​VERY_HIGH

Color Mode

name: colorMode, type: Enum, default: COLOR_BY_TYPE

Defines the color mode, which is only used when a StylePalette or LUT is connected. If a LUT is connected, all modes are supported. If the StylePalette is used, only COLOR_BY_TYPE, COLOR_BY_INDEX, and COLOR_BY_ID are supported.

Values:

Title	Name	Description
​Type	​COLOR_BY_TYPE	​Color is determined by XMarker type.
​Index	​COLOR_BY_INDEX	​Color is determined by XMarker index.
​Id	​COLOR_BY_ID	​Color is determined by XMarker ID.
​Vector Length	​COLOR_BY_VECTOR_LENGTH	​Color is determined by length of XMarker vector component. Only available if LUT is used.
​Vector Angle	​COLOR_BY_VECTOR_ANGLE	​Color is determined by the angle between the XMarker vector component and the planeNormal. Only available if LUT is used.
​Signed Vector Length	​COLOR_BY_SIGNED_VECTOR_LENGTH	​Color is used by the length of the XMarker vector component. The sign is determined using the planeNormal. If the XMarker vector component and the planeNormal are pointing in opposite directions, sign will be negative. Only available if LUT is used.

Diffuse Color

name: diffuseColor, type: Color, default: 1 1 1

Sets the global diffuse color. This will have no effect if a StylePalette is used.

Ambient Color

name: ambientColor, type: Color, default: 0.200000002980232 0.200000002980232 0.200000002980232

Sets the global ambient color.

Specular Color

name: specularColor, type: Color, default: 0.200000002980232 0.200000002980232 0.200000002980232

Sets the global specular color.

Shininess

name: shininess, type: Float, default: 0.2

Sets the shininess of the objects.

Marker Size

name: markerSize, type: Float, default: 1

Sets the size of the geometry. In case of points, this is the GL point size. In case of Spheres, this is the radius of the spheres.

Line Width

name: lineWidth, type: Float, default: 1

Sets the line width, which is used for vector lines.

Vector Scale

name: vectorScale, type: Float, default: 1

Sets a scale factor, which scales the vectors.

Arrow Head Size

name: arrowHeadSize, type: Float, default: 1

Sets the size of the arrow head (cone radius).

Arrow Cylinder Radius

name: arrowCylinderRadius, type: Float, default: 0.1

Sets the radius of the cylinders.

Timepoint to Render (-1=all)

name: timepointToRender, type: Integer, default: -1

Sets the time point from which XMarkers should be rendered. If set to -1, all XMarkers will be rendered.

Plane Normal

name: planeNormal, type: Vector3, default: 0 0 1

Sets an optional Vector3 that specifies a plane normal used for colorMode COLOR_BY_VECTOR_ANGLE and COLOR_BY_SIGNED_VECTOR_LENGTH.

Hidden Fields

renderCaching

name: renderCaching, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

boundingBoxCaching

name: boundingBoxCaching, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

renderCulling

name: renderCulling, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

pickCulling

name: pickCulling, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO