FilterMarkersByPlane

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MarkerPlaneAlgorithms
definition	MarkerPlaneAlgorithms.def
keywords	filter, marker, position, plane, normal, slice, tolerance

Purpose

This module filters markers that are on a given plane.

Usage

Connect a marker list (inMarkerList), set a plane (Plane) and a distance tolerance (Distance Tolerance), and press Update.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

A marker list.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase

A marker list with copies of those input markers that are on the given plane (including tolerance).

Parameter Fields

Field Index

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

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

A plane.

Distance Tolerance

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

Distance tolerance in mm. If a marker is at most this many millimeters away from the plane, it is included in the result.

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.