WEMExtrudeCSO

MLModule

genre	WEMProcessing
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLWEMModules
definition	MLWEMModules.def
inherits from	WEMGenerator
keywords	cone, shape, prism, sweep

Purpose

This modules extrudes CSOs into surface objects, i.e. sweeps the contour along a trajectory.

Usage

Put the CSO to extrude into the inCSO field. You can also use a CSOFilter module to select the CSOs to extrude. Select the parameters for the extrusion, then press Apply (or use Auto Apply).

Details

A CSO must have a distinct plane, since Positive Offset and Negative Offset are relative to this plane. CSOs that just are a straight line can’t be extruded.

Windows

Default Panel

Input Fields

inCSO

name: inCSO, type: CSOList(MLBase)

The CSOs to extrude. Each contour will be extruded separately.

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

Output Fields

outWEM

name: outWEM, type: WEM(MLBase)

The resulting surface.

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

Parameter Fields

Field Index

Apply: Trigger	Generate Covers Separately: Bool	Number Of Sections: Integer
Auto Apply: Bool	Generate Edges: Bool	Overwrite label and description: Bool
clear: Trigger	Generate Top Cover: Bool	Positive Offset: Double
Description: String	Generate Walls: Bool	Rotation Degree Per MM: Double
Direction: Vector3	id: Integer	Rotation Origin: Vector3
elapsedTime: Float	isProcessing: Bool	shouldComputeNormals: Bool
Extrusion Mode: Enum	Label: String	updateMode: Enum
Generate Bottom Cover: Bool	Negative Offset: Double

Visible Fields

Auto Apply

name: autoApply, type: Bool, default: FALSE

Perform the extrusion automatically if the extrusion parameters change.

see also WEMGenerator.autoApply

Apply

name: apply, type: Trigger

Perform the extrusion.

see also WEMGenerator.apply

Overwrite label and description

name: overwriteLabelDescription, type: Bool, default: FALSE

If set, Label and Description will used for the generated WEM.

see also WEMGenerator.overwriteLabelDescription

Label

name: label, type: String

The label of the generated WEM (if Overwrite label and description is on).

see also WEMGenerator.label

Description

name: description, type: String

The description of the generated WEM (if Overwrite label and description is on).

see also WEMGenerator.description

Extrusion Mode

name: extrusionMode, type: Enum, default: RELATIVE

The specific type of extrusion to perform.

Values:

Title	Name	Description
Relative	RELATIVE	Direction is a direction vector in this mode. The extrusion will be performed along this vector. Positive Offset and Negative Offset are absolute distances along the normal of the CSO’s plane. Note that if Direction and the CSO’s plane normal are slanted against each other, the shape will be elongated. If they are perpendicular to each other, the module will refuse to extrude the CSO.
Relative Times Direction	RELATIVE_TIMES_DIRECTION	Direction is a direction vector in this mode. The extrusion will be performed along this vector. Positive Offset and Negative Offset are simply multiplied with Direction to get the start and end offsets of the shape.
Absolute	ABSOLUTE	Direction is an absolute point in world space this mode. The extrusion will be performed towards this point.

Direction

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

The direction of the sweep.

• If Extrusion Mode is RELATIVE, this is a direction vector.
• If Extrusion Mode is RELATIVE_TIMES_DIRECTION, this is the base offset of the extrusion, multiplied with Positive Offset and Negative Offset.
• If Extrusion Mode is ABSOLUTE, this is a point in world space towards the contour is extruded.

The distance to extrude is given by Positive Offset and Negative Offset.

Positive Offset

name: positiveOffset, type: Double, default: 10, minimum: 0

The distance by which the contour is extruded towards the direction given by Direction.

Unless the extrusion mode is RELATIVE_TIMES_DIRECTION, the distance is measured perpendicular to the CSO’s plane, that is, along the normal vector of the plane as, e.g., returned by CSOInfo.csoPlaneNormal.

Negative Offset

name: negativeOffset, type: Double, default: 0, minimum: 0

Same as Positive Offset for the opposite direction.

Number Of Sections

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

The number of sections to generate along the sweep. If you specify a rotation with Rotation Degree Per MM you should specify a high number of sections to get a smooth rotation.

Rotation Degree Per MM

name: rotationDegreePerMM, type: Double, default: 0

Specify a rotation along the sweep. The rotation will be increase with distance to the original plane.

Rotation Origin

name: rotationOrigin, type: Vector3, default: 0 0 0

The point around which to rotate. This point will be projected along with the points of the extruded contour, so it should be located in the plane of the contour.

Generate Top Cover

name: generateTopCover, type: Bool, default: TRUE

Only generate the top cover of the surface if this is true.

Generate Bottom Cover

name: generateBottomCover, type: Bool, default: TRUE

Only generate the bottom cover of the surface if this is true.

Generate Walls

name: generateWalls, type: Bool, default: TRUE

Only generate the walls of the surface if this is true.

Generate Covers Separately

name: generateCoversSeparately, type: Bool, default: FALSE

Put the top and bottom cover (if generated) into separate patches.

Generate Edges

name: generateEdges, type: Bool, default: TRUE

Generate the edge graph for the surface. This is needed for many subsequent processing steps.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, persistent: no

see WEMGenerator.isProcessing

elapsedTime

name: elapsedTime, type: Float, persistent: no

see WEMGenerator.elapsedTime

id

name: id, type: Integer, default: 0

see WEMGenerator.id

updateMode

name: updateMode, type: Enum, default: AutoUpdate

see WEMGenerator.updateMode

clear

name: clear, type: Trigger

see WEMGenerator.clear

shouldComputeNormals

name: shouldComputeNormals, type: Bool, default: FALSE

see WEMGenerator.shouldComputeNormals