PolarVectorScaling

MLModule

genre	AnalysisMain
authors	Stefan Wirtz, Christian Kanthak
package	FMEstable/ReleaseMeVis
dll	MLAffineMatrix
definition	MLAffineMatrix.def
see also	AffineMatrixDecomposition, AffineMatrixComposition
keywords	polar, vector, composition, matrix, decomposition

Purpose

The PolarVectorScaling module allows for sense- and meaningful scaling of quaternion vectors for translation, rotation, scale and stretch.

Usage

Connect vectors for translation, rotation, scale and stretch, apply scale factors and if no auto update is checked, press update.

Windows

Default Panel

Parameter Fields

Field Index

[]: Trigger	Scaling Factor for Rotation: Double	Translation (inTranslation): Vector4
Clear: Trigger	Scaling Factor for Scale: Double	Translation (outTranslation): Vector4
Has Valid Output: Bool	Scaling Factor for Stretch: Double	Update: Trigger
On Input Change Behavior: Enum	Scaling Factor for Translation: Double
Rotation (inRotation): Vector4	Status Code: Enum
Rotation (outRotation): Vector4	Status Message: String
Scale (inScale): Vector4	Stretch (inStretch): Vector4
Scale (outScale): Vector4	Stretch (outStretch): Vector4

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 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).

Translation (inTranslation)

name: inTranslation, type: Vector4, default: 0 0 0 1

Quaternion vector representing the translation component.

Rotation (inRotation)

name: inRotation, type: Vector4, default: 0 0 0 1

Quaternion vector representing the rotation component.

Scale (inScale)

name: inScale, type: Vector4, default: 1 1 1 1

Quaternion vector representing the scale component.

Stretch (inStretch)

name: inStretch, type: Vector4, default: 0 0 0 1

Quaternion vector representing the stretch component.

Scaling Factor for Translation

name: inScalingFactorTranslation, type: Double, default: 1

Scale factor for scaling the translation component.

Scaling Factor for Rotation

name: inScalingFactorRotation, type: Double, default: 1

Scale factor for scaling the rotation component.

Scaling Factor for Scale

name: inScalingFactorScale, type: Double, default: 1

Scale factor for scaling the scale component.

Scaling Factor for Stretch

name: inScalingFactorStretch, type: Double, default: 1

Scale factor for scaling the stretch component.

Translation (outTranslation)

name: outTranslation, type: Vector4, persistent: no

Quaternion vector representing the translation component.

Rotation (outRotation)

name: outRotation, type: Vector4, persistent: no

Quaternion vector representing the rotation component.

Scale (outScale)

name: outScale, type: Vector4, persistent: no

Quaternion vector representing the scale component.

Stretch (outStretch)

name: outStretch, type: Vector4, persistent: no

Quaternion vector representing the stretch component.