MarkerDistanceToPlane

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MarkerPlaneAlgorithms
definition	MarkerPlaneAlgorithms.def
keywords	marker, distance, close, plane, vector, translation, front, back

Purpose

This module calculates the distances of markers in a marker list to a plane.

Usage

Connect a marker list, specify a plane and press Update.

Details

The module provides both the oriented/signed distance to the plane, as well as the translation of the marker to the plane. By convention, the distance is positive when the marker is “in front” of the plane, that is, the plane normal points towards the marker. If the inverted plane normal would point towards the marker, it is considered “behind” the plane, and the distance is negative.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

An XMarkerList.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase

An XMarkerList with copies of the input markers in order, with additional distance information.

The signed distance to the plane is stored in the U dimension of the marker. The translation from the marker to the nearest point on the plane is stored in the marker vector.

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

A plane.

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.