LinePlaneIntersection

MLModule

genre	Geometry
author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MLLinePlaneIntersection
definition	MLLinePlaneIntersection.def
see also	IntersectionGeometry
keywords	intersection, point, line, plane

Purpose

This module calculates the intersection of a line and a plane.

Usage

Enter a plane and two points defining a line, and press Update. If the line does not intersect the plane, the field Line intersects plane? will be false.

Windows

Default Panel

Parameter Fields

Field Index

[]: Trigger	On Input Change Behavior: Enum
Clear: Trigger	Plane: Plane
doNotClearOnFailedUpdate: Bool	Status Code: Enum
Has Valid Output: Bool	Status Message: String
Intersection Point: Vector3	Update: Trigger
Line End Position: Vector3
Line intersects plane?: Bool
Line Start Position: Vector3

Visible Fields

Update

name: update, type: Trigger

Calculate the intersection point.

Clear

name: clear, type: Trigger

Clear the results.

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 1 0, deprecated name: plane

The plane to intersect.

Line Start Position

name: inLineStartPosition, type: Vector3, default: 0 0 0, deprecated name: lineStartPosition

Start point on the line.

Line End Position

name: inLineEndPosition, type: Vector3, default: 0 0 0, deprecated name: lineEndPosition

End point on the line.

Line intersects plane?

name: outLineIntersectsPlane, type: Bool, persistent: no, deprecated name: lineIntersectsPlane

True if the line intersects the plane, false if the line is parallel to the plane or the entered line points are equal.

Intersection Point

name: outIntersectionPoint, type: Vector3, persistent: no, deprecated name: intersectionPoint

Intersection point. Zero if the line does not intersect the 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.