Skip to content
weSkelDOCUMENTATION
Documentation/Rigging/Ribbon

Procedural modules

Ribbon

Three-input deformation ribbon with control layers and tangents.

LayersL / R

Ribbon distributes a joint chain between three inputs. Its control layers shape the ribbon, from overall motion to local corrections.

In Module Manager, choose Ribbon in Module Bank, or its instance in Scene Modules.

1Side & Mirror 2Colors 3Topology 4Primary 5Tangents 6Layers
Ribbon · CONFIGURATION · Poseidon theme. 3 layers with tangents enabled.
Reference Purpose
1 · Side & Mirror Choose the source side, L or R. Mirror, enabled by default, builds both sides.
2 · Colors Main Color regenerates the source-side palette; Output Color sets the deformation joint color.
3 · Topology Layers selects 1 to 5 layers, including Primary. Outputs independently sets the joint count per side: 3, 5, 7…, with no imposed maximum. Default: 3 layers and 9 outputs.
4 · Primary Primary always has 3 controls. Ends sets the appearance of both endpoints; Mid, that of the middle control.
5 · Tangents Tangents adds 4 controls to the last active layer. Enabled by default; excluded from the Layers count.
6 · Layers Secondary, Tertiary, Quaternary and Quinary activate in this order. Each COUNT is independent: odd, 5 minimum. Initial counts: 5 / 9 / 17 / 33.

DEGREE selects Linear, Quadratic or Cubic interpolation. The automatic choice adapts to the layer, its control count and tangents; Fixed forces one of the available degrees.

Topology or degree changes require Rebuild on an existing instance. SHAPE and COLOR apply immediately.

Ribbon has no placers. The matrices of the start, mid and end inputs define its three anchors. Connect them to the motion the ribbon should follow; controls then add their local adjustments.

Each side has its own inputs, including with Mirror enabled. Arm or leg outputs can provide these anchors, for example.

Controller Role
Primary Three controls follow Start, Mid and End and shape the ribbon as a whole.
Secondary → Quinary Successive correction layers. Each layer follows the previous one; the last drives the final deformation.
Tangents Adjust curvature near the endpoints and on either side of the center.
Options Shows or hides the additional layers and tangents.

Deformation controls allow translation, twist and scale. The other two rotation axes are locked: adjust curvature by moving the controls.

Module Preview
Ribbon · Module Preview · Poseidon theme.

In the Options Channel Box, LOD settings are visibility toggles. Off at creation, they hide the corresponding controls without disabling their effect on the ribbon.

Setting Effect
Secondary / Tertiary / Quaternary / Quinary LOD Shows the corresponding layer, if built.
Tangent LOD Shows the four Tangents controls, if this option is built.

Each side has three driver-only inputs. Deformation outputs expose driver and reference.

Direction Port Role
Input start Start anchor.
Input mid Middle anchor.
Input end End anchor.
Outputs deformation_01… Ordered outputs along the ribbon, each with its deformation joint. Their count follows Outputs, independently of the control layers.

Default: 9 joints per side, or 18 with Mirror.