FilterMarkersByDistanceToPlane

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MarkerPlaneAlgorithms
definition	MarkerPlaneAlgorithms.def
see also	FilterMarkersByPlane
keywords	filter, marker, position, plane, normal, slice, distance, half, space

Purpose

This module filters markers by their distance to a plane.

Usage

Connect a marker list, set minimum and maximum distances and press Update.

Details

Minimum distance must not be larger than the maximum distance.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

An XMarkerList.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase

An XMarkerList with copies of all input markers that are in the given distance interval from the given plane.

Parameter Fields

Field Index

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

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.

Minimum Distance

name: inMinimumDistance, type: Double, default: 0

Minimum distance.

Maximum Distance

name: inMaximumDistance, type: Double, default: 0

Maximum distance.

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.