FindCSOsOnSamePlane

MLModule

genre	CSOModule
author	Jonas Singe
package	FMEwork/ReleaseMeVis
dll	MLCSOMiscModules
definition	MLCSOMiscModules.def
keywords	cso, contour, plane, coplanar

Purpose

Checks whether any two CSOs in a CSO list are on same plane

Usage

Connect a CSOList and press update. In Coplanar CSO Ids you can see the pairs of ids that are coplanar.

Windows

Default Panel

Input Fields

inCSOList0

name: inCSOList0, type: MLBase

CSOList where coplanar CSOs should be detected

Parameter Fields

Field Index

[]: Trigger	Update: Trigger
Clear: Trigger	useEpsilonAsPlaneDistance: Bool
Coplanar CSO Ids: String
Epsilon: Double
Has Valid Output: Bool
On Input Change Behavior: Enum
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: shouldUpdateAutomatically,shouldAutoUpdate

Declares how the module should react if any input field value 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).

Epsilon

name: inEpsilon, type: Double, default: 0.0001, minimum: 0

This values is used in the comparison to check whether two CSOs are in same plane. Has to be greater than 0.0.

Coplanar CSO Ids

name: outCSOIds, type: String, persistent: no

String containing the ids of coplanar CSOs in the form (1,2) (3,4) …

Hidden Fields

useEpsilonAsPlaneDistance

name: useEpsilonAsPlaneDistance, type: Bool, default: FALSE