XMarkerModify

MLModule
genre Marker
author Florian Weiler
package FMEwork/ReleaseMeVis
dll MLXMarkerUtils
definition MLXMarkerUtils.def
keywords translate, vector, scale, swap, raster, type, position

Purpose

This module allows to transform XMarkers using a variety of different modes.

Usage

Attach an XMarkerList to the input, select a transformation mode, and press update (or activate auto-update / auto-apply). The module will generate a modified copy of the input list.

Windows

Default Panel

../../../Modules/ML/MLXMarkerUtils/mhelp/Images/Screenshots/XMarkerModify._default.png

Input Fields

inXMarkerList

name: inXMarkerList, type: MLBase

The input list.

Output Fields

outXMarkerList

name: outXMarkerList, type: MLBase

A modified copy of the input list.

Parameter Fields

Field Index

Auto Apply: Bool
Auto Update: Bool
Mode: Enum
Scalar Parameter: Double
Update: Trigger
Vector Parameter:: Vector6

Visible Fields

Mode

name: modes, type: Enum, default: Translate By Vector

Define how to modify the input XMarkerList.

Values:

Title Name Description
Translate By Vector Translate By Vector Translate all XMarkers by the direction defined by its internal vector. An additional scaling factor can be applied.
Translate by normalized Vector Translate by normalized Vector Translate all XMarkers by the direction defined by its normalized internal vector. An additional scaling factor can be applied.
Scale Vector Scale Vector Scale the internal vector of each marker by a given factor.
Set Vector Length Set Vector Length Set the length of each vector to a constant value. Setting each vectors length to 1 will normalize the vectors.
Swap Vector & Position Swap Vector & Position Swap a Markers Position and Vector. Note: An XMarkers Vector is of type vec3, whereas the position if of type vec6. When swapping these two, the c- t- and u-dimension of the XMarkers position will consequently get lost.
Translate by constant Vector Translate by constant Vector Translates all XMarkers positions by a constant vector.
Translate relative to position Translate relative to position Translates all XMarkers relative to a given reference position (ref + (pos - ref)*scale). The difference between the reference position and a XMarkers position defines the direction of transformation. A scaling factor different than 1 needs to be set in order to actually perform the transformation.
Add constant Vector to Vector Add constant Vector to Vector Add a constant vector to the internal vector of each marker.
Snap to raster Snap to raster Snaps marker positions to a raster defined by Vector Parameter:
Change type Change type Sets the type of each marker to the scalar parameter.
Set Vector pointing to next Marker Set Vector pointing to next Marker Sets the vector such that it points to the next marker. The vector of the last marker will have the length 0.

Scalar Parameter

name: scalarParameter, type: Double, default: 0

The scalar parameter is used to control the scaling factor and also to define the fixed length for a markers vector.

Vector Parameter:

name: vectorParameter, type: Vector6, default: 0 0 0 0 0 0

The vector parameter is used only for the modes Translate by constant Vector and Translate relative to position.

Auto Apply

name: autoApply, type: Bool, default: FALSE

Defines whether an update should be performed on field changes.

Auto Update

name: autoUpdate, type: Bool, default: FALSE

Defines whether an update should be performed on changes to the input XMarkerList.

Update

name: update, type: Trigger

Manually trigger an update.