IntersectCSOWithPlane

MLModule
author Lennart Tautz
package FMEwork/ReleaseMeVis
dll IntersectCSOWithPlane
definition mlIntersectCSOWithPlane.def
see also FilterMarkersByPlane
keywords CSO, contour, intersection, cut, plane

Purpose

This module calculates the intersection points of a plane and the CSOs in the given CSOList.

Usage

Connect a CSOList, set a plane and press Update.

Windows

Default Panel

../../../Projects/IntersectCSOWithPlane/Modules/mhelp/Images/Screenshots/IntersectCSOWithPlane._default.png

Input Fields

inCSOList

name: inCSOList, type: MLBase

A list of CSOs.

Output Fields

outIntersectionPoints

name: outIntersectionPoints, type: MLBase

An XMarker list containing all points where the CSOs intersect with the given plane.

The marker type of an intersection is set to the CSO id, and CSO time points are retained. CSOGroups have no effect on the marker properties.

Parameter Fields

Field Index

[]: Trigger Update: Trigger
Clear: Trigger  
doNotClearOnFailedUpdate: Bool  
Has Valid Output: Bool  
On Input Change Behavior: Enum  
Plane: Plane  
Status Code: Enum  
Status Message: String  

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldAutoUpdate,shouldUpdateAutomatically

Declares how the module should react if a value of an input field changes.

Values:

Title Name Deprecated Name
Update Update TRUE
Clear Clear FALSE

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title Name
Ok Ok
Invalid input object Invalid input object
Invalid input parameter Invalid input parameter
Internal error Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Plane

name: inPlane, type: Plane, default: 0 0 0 0

The plane to intersect with.

Hidden Fields

doNotClearOnFailedUpdate

name: doNotClearOnFailedUpdate, type: Bool, persistent: no

Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.