MarkerListToWEMPlane¶
- MLModule¶
genre
author
package
dll
definition
keywords
Purpose¶
The module MarkerListToWEMPlane generates a deformed WEM plane from markers.
Details¶
The module generates a WEM plane based on a marker list using PCA (principal component analysis). The basic plane is oriented such that the shortest axis of the PCA serves as the normal of the basic plane, while the longest axis of the PCA defines the size of the basic plane (Relative Size = 1).
The basic plane can be deformed by another set of markers. For both tasks, the same set of markers can, of course, be used.
Windows¶
Default Panel¶
Input Fields¶
inPCAMarkerList¶
- name: inPCAMarkerList, type: XMarkerList(MLBase)¶
The markers of this marker list are used to establish the PCA, which influences the main orientation and size of the WEM plane.
For accessing this object via scripting, see the Scripting Reference:
MLXMarkerListWrapper.
inDeformMarkerList¶
- name: inDeformMarkerList, type: XMarkerList(MLBase)¶
The markers of this marker list influence the deformation of the WEM plane.
For accessing this object via scripting, see the Scripting Reference:
MLXMarkerListWrapper.
Output Fields¶
outWEM¶
- name: outWEM, type: WEM(MLBase)¶
For accessing this object via scripting, see the Scripting Reference:
MLWEMWrapper.
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Visible Fields¶
Auto Apply¶
- name: autoApply, type: Bool, default: TRUE¶
If checked, the module computes anew on a change of any fields on the panel.
Update Mode¶
- name: updateMode, type: Enum, default: AutoUpdate, deprecated name: autoUpdate¶
Defines how this module should react on any input field change.
Values:
Title |
Name |
Deprecated Name |
Description |
|---|---|---|---|
Off |
Off |
FALSE |
The output WEM is left unchanged. |
Auto Update |
AutoUpdate |
TRUE |
The output WEM is computed anew. |
Auto Clear |
AutoClear |
The output WEM is cleared (made empty). |
Apply¶
- name: apply, type: Trigger¶
When pressed, the module generates the WEM plane anew.
Clear¶
- name: clear, type: Trigger, deprecated name: clearOutput¶
When pressed, the output WEM is cleared and attached modules are notified.
Overwrite label and description¶
- name: overwriteLabelDescription, type: Bool, default: FALSE¶
If checked, label and description strings are set in the output WEM to
LabelandDescription.
Label¶
- name: label, type: String¶
Sets a label string in the output WEM.
Description¶
- name: description, type: String¶
Sets a description string in the output WEM.
Generation Mode¶
- name: generationMode, type: Enum, default: Quads¶
Defines the output WEM generation mode.
Values:
Title |
Name |
Description |
|---|---|---|
Quads |
Quads |
Quads are generated. |
Triangles |
Triangles |
Triangles are generated. |
Relative Size¶
- name: relativeSize, type: Float, default: 1.2, minimum: 1.1, maximum: 3¶
Sets the relative size of the initial plane, which is always a square.
A size of 1 means that the plane’s width and height are equal to the largest axis of the PCA.
Grid Resolution¶
- name: gridResolution, type: Integer, default: 40, minimum: 1, maximum: 300¶
Sets the resolution of the grid or the number of quads per row and column.
Smoothing Passes¶
- name: smoothingPasses, type: Integer, default: 150, minimum: 1, maximum: 300¶
Sets the amount of smoothing passes of the Laplacian smoothing.
Global Normal¶
- name: globalNormal, type: Vector3, persistent: no¶
Shows the global normal of the generated plane.