WEMClipPlaneToWEM¶

MLModule¶

Purpose¶

The module WEMClipPlaneToWEM clips a WEM with a given Plane and generates the resulting clipped WEM (either above or below the plane).

Sometimes, generating a cover is not possible. In this case, a warning message appears in the console, and the validWEM is set to False.

name: inWEM, type: WEM(MLBase)¶: The input WEM.

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

name: outWEM, type: WEM(MLBase)¶: The output WEM.

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

`elapsedTime`: `Float`	`progress`: `Float`	`workDirectlyOnInputWEMs`: `Bool`
`Generate Edges`: `Bool`	`PVL Default Value`: `Double`
`id`: `Integer`	`PVL Interpolation Mode`: `Enum`
`isProcessing`: `Bool`	`Result Mode`: `Enum`
`listenToFinishNotifications`: `Bool`	`shouldComputeNormals`: `Bool`
`listenToRepaintNotifications`: `Bool`	`triangulationMode`: `Enum`
`listenToSelectionChangedNotifications`: `Bool`	`validWEM`: `Bool`
`Plane`: `Plane`	`Which Output`: `Enum`

name: plane, type: Plane, default: 0 0 1 0¶: Sets the plane (in world coordinates) that is used for clipping with the WEM.

name: generateEdges, type: Bool, default: TRUE¶: If checked, edge connectivity is generated.

name: resultMode, type: Enum, default: RemainderOnly, deprecated name: closeIntersection¶: Defines what the module outputs as a result.

Values:

Title	Name	Deprecated Name	Description
Remainder Only	RemainderOnly	FALSE	The module returns only the clipped WEM patch, which is an open surface.
Remainder With Cover	RemainderWithCover	TRUE	The module returns a closed clipped WEM patch. In the rendering, there might be shading artifacts, which can be reduced by using a crease angle in `SoWEMRenderer`.
Cover Only	CoverOnly		The module returns only the cover.
Remainder And Cover In Separate Patches	RemainderAndCoverInSeparatePatches		The module returns the clipped WEM and the cover as separate patches. This is advantageous because the cover has no rendering artifacts. However, this result may not be useful for further processing, as it is no longer a single surface, and the positions of the nodes in the cover and the clipped WEM (the remainder) are duplicated.

name: whichOutput, type: Enum, default: PositiveSide¶: Defines which part of the clipped WEM is shown.

Values:

Title	Name	Description
Positive Side	PositiveSide	Outputs the WEM that lies on the positive side of the plane.
Negative Side	NegativeSide	Outputs the WEM that lies on the negative side of the plane.

name: pvlInterpolationMode, type: Enum, default: LinearInterpolatePVLValues¶: Defines the interpolation mode for PVL values at newly added nodes. Nodes can be added by clipping an edge.

Values:

Title	Name	Description
Drop	Drop	PVL values are not retained at all.
Linear	Linear	PVL values are interpolated linearly.
Nearest Neighbor	NearestNeighbor	PVL values are interpolated using the value of the nearest neighbor.
Use Default	UseDefault	A default value, set by `PVL Default Value`, is used.