MarkerDistanceToPoint

MLModule

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

Purpose

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

Usage

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

Details

Marker distance is calculated in 3D only, the C/T/U coordinates of the input markers are ignored.

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 distance to the point is stored in the U dimension of the marker. The translation from the marker to the point 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
Point: Vector3
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).

Point

name: inPoint, type: Vector3, default: 0 0 0

A 3D point.

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.