Skip to content
weSkelDOCUMENTATION
Documentation/Rigging/Arm

Procedural modules

Arm

FK/IK arm with deformation options and mirroring.

BipedFK / IKL / R

Arm builds an arm from shoulder to wrist in FK, IK, or both modes, with deformation options and left/right mirroring.

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

1Side & Mirror 2Colors 3Topology 4IK Options 5Helpers 6Design
Arm · CONFIGURATION · Poseidon theme.
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 Enable FK, IK, or both. At least one branch must remain active.
4 · IK Options Adds IK Offset, Twist, Stretch and Soft IK. These options require the IK branch.
5 · Helpers Shoulder Unroll and Wrist Twist each add one deformation output and joint per side.
6 · Design SHAPE and COLOR set the appearance of FK Chain, IK Targets, Pole Vector, Blend and Options.

All options are enabled by default. On an existing instance, configuration changes require Rebuild; shapes and colors apply immediately.

The three placers form the Shoulder → Elbow → Wrist chain. Their scale is locked.

Placer Role
Shoulder Shoulder position and orientation: free translation and rotation.
Elbow Upper-arm length and rest bend: Translate Y and Rotate X only.
Wrist Forearm length and wrist orientation: Translate Y and all three rotations.

Pole Vector and Blend also have editable placement parents in the Outliner to adjust their rest position.

Controller Role
FK Chain Three chained controls: Shoulder, Elbow, Wrist.
IK Wrist position and orientation target.
IK Offset Additional adjustment under IK; hidden by default.
Pole Vector Orients the elbow bend plane through translation.
Blend Hosts FK / IK when both branches exist. Binary selection, default FK.
Options Helper weights and IK Offset visibility.

To change modes while preserving the pose, use Switch FK/IK. The FK / IK selector alone does not match the controls.

Module Preview
Arm · Module Preview · Poseidon theme.

On the IK control, depending on enabled options. IK Offset exposes the same settings.

Setting Effect
Twist Rotates the arm’s bend plane. Default: 0°.
Stretch Blends extension towards the target, from 0 to 1. Default: 1.
Soft IK Softens the approach to full extension, from 0 to 2. Default: 0, with no softening.
Elbow Adjust Redistributes length between upper arm and forearm without changing their sum. 0 is neutral; a positive value lengthens the upper arm and shortens the forearm.

In the Options control’s Channel Box. Module Manager switches add the helpers; the values below control their effect.

Setting Effect
Shoulder Unroll Blends shoulder twist compensation on the helper, from 0 to 1. Default: 1.
Wrist Twist Blends the wrist’s twist into the helper, from 0 to 1. Default: 1.
Show IK Offset Shows IK Offset curves; hiding them does not disable its effect. Off by default.

These settings appear when their corresponding option is built.

Each built side has its own ports. base and the three main outputs expose driver and reference; the two helpers expose driver only.

Direction Port Role
Input base Incoming motion for the arm, including IK and Pole Vector controls.
Output shoulder Shoulder result in the active mode.
Output elbow Elbow result in the active mode.
Output wrist Wrist result in the active mode; connection point for the hand.
Output shoulder_unroll Optional shoulder twist compensation helper.
Output wrist_twist Optional wrist twist helper.

Each output drives its deformation joint: 3 joints per side, or 5 with both helpers. Rebuild blocks removal of a helper that still has consumers.