SoWEMRenderer

InventorModule

genre	WEMRendering
authors	Olaf Konrad, Bart De Dobbelaer
package	MeVisLab/Standard
dll	SoWEM
definition	SoWEM.def
see also	WEMIsoSurface, WEMInfo
keywords	visualization, surface

Purpose

The SoWEMRenderer renders the faces of a WEM as an Open Inventor scene.

Usage

Just plug in a WEM into the input, and the module's output into an Inventor viewer.

Interaction

A rendered WEM can be selected in the viewer. On the module?s GUI, some information on the clicked position, the id of the hit WEMPatch, as well as some additional information on the local configuration of the hit position is displayed.

Windows

Default Panel

Input Fields

The input is the WEM to be rendered and an option LUT for coloring the WEM (only meaningful if the WEM has values stored in at least one PVL).

inWEM

name: inWEM, type: MLBase

inLUT

name: inLUT, type: MLBase

inExtensions

name: inExtensions, type: SoNode

Allows to add extension modules to the SoWEMRenderer.

Output Fields

The WEM as an Inventor scene.

self

name: self, type: SoNode

Parameter Fields

Field Index

Allow Hits: Bool	Highlight selected patch: Bool	pickCulling: Enum
Apply: Trigger	Hit Face: Integer	primitiveValueListAlphaValid: Bool
Auto Apply: Bool	Hit information valid: Bool	primitiveValueLists: String
Auto Update: Bool	Hit Patch: Integer	primitiveValueListValid: Bool
autoClear: Bool	Hit Position: Vector3	Render inside closed surfaces: Bool
boundingBoxCaching: Enum	Mode: Enum	renderCaching: Enum
Color Mode: Enum	Nearest Node: Integer	renderCulling: Enum
Face Rendering Mode: Enum	Nearest Value: Float	Use automatic polygon offset: Bool

Visible Fields

Auto Apply

name: autoApply, type: Bool, default: TRUE

If checked, all parameter changes lead to a new generation of the output scene.

Auto Update

name: autoUpdate, type: Bool, default: TRUE

If checked, all input changes lead to a new generation of the output scene.

Apply

name: apply, type: Trigger

if pressed, the module generates a new Inventor scene.

Highlight selected patch

name: useHighlightSelected, type: Bool, default: FALSE

If checked, the selected WEMPatch is highlighted by a blinking silhouette.

This costs a lot of performance, so handle with care.

Face Rendering Mode

name: faceRenderingMode, type: Enum, default: WEM_FACE_RENDERING_MODE_AUTO

Defines the rendering mode of faces.

Values:

Title	Name	Description
Auto	WEM_FACE_RENDERING_MODE_AUTO	The rendering mode is determined automatically. It will be DOUBLE_SIDE if the WEMPatch to be rendered has transparencies or holes, so that the backsides of faces are correctly rendered. Otherwise, the render mode is SINGLE_SIDE. However, the module cannot detect if a WEM is cut by a clipping plane.
Single Side	WEM_FACE_RENDERING_MODE_SINGLE_SIDE	Only the front faces are rendered. This leads to a faster rendering as there are only half the amount of primitives to be processed. However, transparencies, open WEMs (holes or clipping planes) are not rendered correctly.
Double Side	WEM_FACE_RENDERING_MODE_DOUBLE_SIDE	Both, the front and the back side of polygons are rendered. This mode always renders correctly, but always slow.

Hit Patch

name: hitPatchIndex, type: Integer, persistent: no

The index of the hit (picked) WEMPatch.

Hit Face

name: hitFaceIndex, type: Integer, persistent: no

The index of the hit (picked) face.

Nearest Node

name: hitNearestNodeIndex, type: Integer, persistent: no

The index of the nearest node to the hit position.

Nearest Value

name: hitNearestNodeValue, type: Float, persistent: no

The value of the node nearest to the hit position.

Hit Position

name: hitPosition, type: Vector3, persistent: no

The position where the picking ray first hit the surface.

Hit information valid

name: isHitInformationValid, type: Bool, persistent: no

This field is true if the hit information on the GUI is valid.

Allow Hits

name: allowHits, type: Bool, default: TRUE

If checked, the module evaluates picking information.

Color Mode

name: colorMode, type: Enum, default: WEM_COLOR_GENERAL

Determines how the WEM (faces) should be colored.

Values:

Title	Name
General	WEM_COLOR_GENERAL
Node Colors	WEM_COLOR_NODE_COLORS
Lut Values	WEM_COLOR_LUT_VALUES
Lut Values Integer	WEM_COLOR_LUT_VALUES_INTEGER
Textured	WEM_COLOR_TEXTURED

Use automatic polygon offset

name: usePolygonOffset, type: Bool, default: TRUE

If checked, the module used internal polygon offsets to enhance the visual result if edges and faces are rendered at the same time.

Mode

name: parameterOverwriteMode, type: Enum, default: OVERWRITE_MODE_ALL

Determines which visualization parameters should be overwritten by the renderer and which parameters should be taken from the input WEM.

Values:

Title	Name
None	OVERWRITE_MODE_NONE
All	OVERWRITE_MODE_ALL
Specific	OVERWRITE_MODE_SPECIFIC

Render inside closed surfaces

name: useShapeHints, type: Bool, default: FALSE

Determines if the module uses internal shape hints. If so, all external shape hint setting will be overwritten.

The internal shape hints enable double-sided rendering so polygons are rendered 'from behind' which is important if the camera is inside a closed surface or if the surface has holes.

Typically, this option is not needed and should not be turned on if not really needed, because it halves the frame rate.

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

autoClear

name: autoClear, type: Bool, default: TRUE

primitiveValueLists

name: primitiveValueLists, type: String

primitiveValueListValid

name: primitiveValueListValid, type: Bool, default: FALSE

primitiveValueListAlphaValid

name: primitiveValueListAlphaValid, type: Bool, default: FALSE