LocalWEMLoad

MacroModule

genre	WEMPersistence
status	stable
authors	Bart De Dobbelaer, Olaf Konrad
package	MeVisLab/Standard
definition	MLWEMModules.def
see also	WEMLoad, WEMSave
keywords	WEM, load, local

Purpose

The module loads a WEM in any supported format from a relative path.

Usage

Just set the filename which can be relative to a variable and load a file.

Details

The panel offers some examples of variables to use.

The module is based internally on WEMLoad, have a look at that module for the available file formats.

Windows

Default Panel

Output Fields

outWEM

name: outWEM, type: MLBase

Output is a WEM.

Parameter Fields

Field Index

Ambient Color: Color	Edge Color: Color	Node Normal Scale: Float
Auto load: Bool	editable: Bool	Node Rendering Mode: Enum
autoUpdate: Bool	elapsedTime: Float	Point Size:: Float
Bounding Box Mode: Enum	Face Alpha:: Float	progress: Float
Color (boundingBoxColor): Color	Face Normal Scale: Float	removePreviousWEMs: Bool
Color (faceNormalsColor): Color	Face Shininess: Float	show: Bool
Color (nodeNormalsColor): Color	Generate Edges: Bool	Specular Color: Color
Color Mode: Enum	id: Integer	Status: String
Description: String	isProcessing: Bool	Triangulate Faces: Bool
Diffuse Color: Color	Label: String	True Name: String
Draw bounding boxes: Bool	Line Width:: Float	Use (useFaceSpecularColor): Bool
Draw edges: Bool	Load: Trigger	Use (useFaceAmbientColor): Bool
Draw face normals: Bool	Mirror Faces: Bool	Use coloring mode for edges: Bool
Draw Faces: Bool	Mode: Enum	useFaceDiffuseColor: Bool
Draw node normals: Bool	Name: String	usePolygonOffset: Bool
Draw nodes: Bool	Node Color: Color

Visible Fields

Color (boundingBoxColor)

name: boundingBoxColor, type: Color, default: 1 1 1

Sets the color of the bounding box.

Ambient Color

name: faceAmbientColor, type: Color, default: 0.266667008399963 0.266667008399963 0.266667008399963

Sets the ambient color of the faces.

Auto load

name: autoApply, type: Bool, default: TRUE

If checked, the module loads on start-up and on changing any parameter.

Bounding Box Mode

name: boundingBoxMode, type: Enum, default: Axis Aligned

Sets the bounding box mode.

Values:

Title	Name
Axis Aligned	Axis Aligned
Object Aligned	Object Aligned

Color (faceNormalsColor)

name: faceNormalsColor, type: Color, default: 1 1 1

Sets the color of the face normals.

Color (nodeNormalsColor)

name: nodeNormalsColor, type: Color, default: 1 1 1

Sets the color of the node normals.

Color Mode

name: colorMode, type: Enum, default: General

Sets the color mode.

Values:

Title	Name	Description
General	General	Uses the colors set on the module or the renderer.
Node Colors	Node Colors	Uses special colors stored in the nodes. Only a few modules make use of those color.
LUT Values	LUT Values	The PVL 'LUT' (which is always existing) is used for a look-up into a LUT attached to the renderer.
LUT Values Integer	LUT Values Integer	The PVL 'LUT' (which is always existing) is used for a look-up into an integer LUT attached to the renderer.

Description

name: description, type: String

A string description for free use.

Diffuse Color

name: faceDiffuseColor, type: Color, default: 0.792156994342804 0.792156994342804 0.792156994342804

Sets the diffuse face color.

Draw Faces

name: drawFaces, type: Bool, default: TRUE

If checked, the faces are rendered.

Draw bounding boxes

name: drawBoundingBoxes, type: Bool, default: FALSE

If checked, the bounding box is drawn.

Draw edges

name: drawEdges, type: Bool, default: FALSE

If checked, the edges are drawn.

Note that the WEM needs the edges set.

Draw face normals

name: drawFaceNormals, type: Bool, default: FALSE

If checked, the face normals are rendered.

Draw node normals

name: drawNodeNormals, type: Bool, default: FALSE

If checked, the node normals are rendered.

Draw nodes

name: drawNodes, type: Bool, default: FALSE

If checked, the nodes of a WEM are rendered.

Edge Color

name: edgeColor, type: Color, default: 0 0 0

Sets the color of the edges.

Face Alpha:

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

Sets the general alpha value for faces.

Face Normal Scale

name: faceNormalsScale, type: Float, default: 1

Scales the face normals.

Face Shininess

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

Sets the shininess value for faces.

Generate Edges

name: generateEdges, type: Bool, default: TRUE

If checked, edges will be generated for the output WEM in case that the loaded WEM does not yield any edges.

Label

name: label, type: String

A label string for free use.

Line Width:

name: lineWidth, type: Float, default: 1, minimum: 1

Sets the line width for rendering the edges.

Load

name: apply, type: Trigger

If pressed, the specified WEM is loaded.

Mirror Faces

name: mirrorFaces, type: Bool, default: FALSE

If checked, all faces are mirrored to compensate for some formats with a reverse order of nodes.

Mode

name: triangulationMode, type: Enum, default: Strip

Sets the triangulation scheme in case that loaded faces should be triangulated.

Values:

Title	Name
Center node	Center node
Fan	Fan
Strip	Strip

Name

name: name, type: String, default: $(DemoDataPath)/venus.off

The WEM file name, using a variable to specify a relative path.

Node Color

name: nodeColor, type: Color, default: 1 1 1

Sets the node color.

Node Normal Scale

name: nodeNormalsScale, type: Float, default: 1

Sets the normal scale factor for node normals.

Node Rendering Mode

name: nodeRenderingMode, type: Enum, default: Normal

Sets the node rendering mode.

Values:

Title	Name	Description
Normal	Normal	Renders all existing nodes.
High	High	Renders all existing nodes and extra nodes in the middle of each face
Extra High	Extra High	Renders all existing nodes, extra nodes in the middle of each face and in the middle of each edge.

Point Size:

name: pointSize, type: Float, default: 1, minimum: 1

Sets the point size for rendering nodes.

Specular Color

name: faceSpecularColor, type: Color, default: 0.0666669979691505 0.0666669979691505 0.0666669979691505

Sets the specular color for rendering faces.

Status

name: status, type: String, persistent: no

Displays the status of the module.

Triangulate Faces

name: triangulateFaces, type: Bool, default: FALSE

If checked, all non-triangle faces will be triangulated.

True Name

name: trueName, type: String, persistent: no

The true name of the WEM to load. This is the file name in the current file system.

Use (useFaceSpecularColor)

name: useFaceSpecularColor, type: Bool, default: TRUE

If checked, the specular color is used for face rendering.

Use (useFaceAmbientColor)

name: useFaceAmbientColor, type: Bool, default: TRUE

If checked, the ambient color is used for face rendering.

Use coloring mode for edges

name: useEdgeColoringMode, type: Bool, default: FALSE

If checked, the edges will be colored by the same mode as the faces ( Color Mode).

Hidden Fields

autoUpdate

name: autoUpdate, type: Bool, default: TRUE

editable

name: editable, type: Bool, default: TRUE

elapsedTime

name: elapsedTime, type: Float, default: 0.050999999

id

name: id, type: Integer, default: 0

isProcessing

name: isProcessing, type: Bool, default: FALSE

progress

name: progress, type: Float, persistent: no

removePreviousWEMs

name: removePreviousWEMs, type: Bool, default: TRUE

show

name: show, type: Bool, default: TRUE

useFaceDiffuseColor

name: useFaceDiffuseColor, type: Bool, default: TRUE

usePolygonOffset

name: usePolygonOffset, type: Bool, default: FALSE