CSOWorldCrop

MLModule

genre	CSOModificator
author	Jan Hendrik Moltz
package	FMEwork/ReleaseMeVis
dll	MLCSOMiscModules
definition	MLCSOMiscModules.def
see also	CSOVoxelCrop
keywords	crop, clamp, restrict, bounding, box

Purpose

Removes points outside a box in world coordinates from a CSO.

Usage

Connect a CSOList and provide start and end world coordinates of the box. Note that the box may not be aligned with the image axes. This is a CSOModificator, so you can choose to work on the input CSOList or to create a new list at the output.

Details

For cropping, the CSOs are flattened to path points. Each path point is checked for being inside the given box. Path points outside the box are discarded. Path points inside the box may form one or more CSOs that replace the original CSO. If desired, one closed CSO may be created instead of several disconnected ones.

Windows

Default Panel

Input Fields

inCSOList

name: inCSOList, type: MLBase

The input CSOList, containing CSOs to be cropped. If Work directly on input CSOList, this list is directly manipulated.

Output Fields

outCSOList

name: outCSOList, type: MLBase

The output CSOList, containing cropped CSOs.

Parameter Fields

Field Index

addCSOToGroupMode: Enum	Enable Undo/Redo: Bool	seedPointAlpha: Float
addCSOToGroupWithId: Integer	id: Integer	seedPointColor: Color
addCSOToGroupWithLabel: String	isProcessing: Bool	seedPointSize: Float
autoApply: Bool	listenToFinishingNotifications: Bool	seedPointStyle: Enum
Box end (world coordinates): Vector3	listenToSelectionNotifications: Bool	Should close CSOs: Bool
Box start (world coordinates): Vector3	Mode: Enum	Update: Trigger
changeSettingsForModifiedCSOs: Bool	pathPointAlpha: Float	voxelWriteMode: Enum
csoIdList: String	pathPointColor: Color	voxelWriteValue: Float
done: Trigger	pathPointStyle: Enum	Work directly on input CSOList: Bool
emptyGroupBeforeGeneration: Bool	pathPointWidth: Float

Visible Fields

Mode

name: updateMode, type: Enum, default: AutoClear

The way the module reacts to input changes.

Values:

Title	Name
​Off	​Off
​Auto Update	​AutoUpdate
​Auto Clear	​AutoClear

Update

name: apply, type: Trigger

Trigger to start the computation.

Work directly on input CSOList

name: workDirectlyOnInputList, type: Bool, default: TRUE

If true, the inCSOList is manipulated rather than creating a new outCSOList.

Enable Undo/Redo

name: useUndoRedo, type: Bool, default: TRUE

If true, the changes to the inCSOList can be undone.

Box start (world coordinates)

name: inBoxStart, type: Vector3, default: 0 0 0

The first corner of the box in world coordinates (inclusive).

Box end (world coordinates)

name: inBoxEnd, type: Vector3, default: 0 0 0

The other corner of the box in world coordinates (inclusive).

Should close CSOs

name: inShouldCloseCSOs, type: Bool, default: FALSE

If true, output CSOs will be closed if the corresponding input CSO was closed.

Hidden Fields

autoApply

name: autoApply, type: Bool, default: FALSE

isProcessing

name: isProcessing, type: Bool, default: FALSE

done

name: done, type: Trigger

emptyGroupBeforeGeneration

name: emptyGroupBeforeGeneration, type: Bool, default: FALSE

addCSOToGroupMode

name: addCSOToGroupMode, type: Enum, default: AddToGroupByLabel

Values:

Title	Name
​None	​AddToGroupNone
​By Label	​AddToGroupByLabel
​By Id	​AddToGroupById

addCSOToGroupWithLabel

name: addCSOToGroupWithLabel, type: String

addCSOToGroupWithId

name: addCSOToGroupWithId, type: Integer, default: -1

id

name: id, type: Integer, default: 0

pathPointStyle

name: pathPointStyle, type: Enum, default: LineStyleSolid

Values:

Title	Name
​None	​LineStyleNone
​Solid	​LineStyleSolid
​Dashed	​LineStyleDashed
​Dotted	​LineStyleDotted
​Short Dashed	​LineStyleShortDashed

pathPointWidth

name: pathPointWidth, type: Float, default: 1

pathPointColor

name: pathPointColor, type: Color, default: 1 1 0

pathPointAlpha

name: pathPointAlpha, type: Float, default: 1

seedPointStyle

name: seedPointStyle, type: Enum, default: MarkerModeRect

Values:

Title	Name
​None	​MarkerModeNone
​Rect	​MarkerModeRect
​Circle	​MarkerModeCircle
​Fixed Cirlce	​MarkerModeFixedCirlce

seedPointSize

name: seedPointSize, type: Float, default: 2

seedPointColor

name: seedPointColor, type: Color, default: 0 1 0

seedPointAlpha

name: seedPointAlpha, type: Float, default: 1

voxelWriteMode

name: voxelWriteMode, type: Enum, default: VoxelWriteModeModule

Values:

Title	Name
​Id	​VoxelWriteModeId
​Const	​VoxelWriteModeConst
​Const Plus Id	​VoxelWriteModeConstPlusId
​Module	​VoxelWriteModeModule

voxelWriteValue

name: voxelWriteValue, type: Float, default: 1024

csoIdList

name: csoIdList, type: String

changeSettingsForModifiedCSOs

name: changeSettingsForModifiedCSOs, type: Bool, default: FALSE

listenToFinishingNotifications

name: listenToFinishingNotifications, type: Bool, default: TRUE

listenToSelectionNotifications

name: listenToSelectionNotifications, type: Bool, default: TRUE