Ik Rig
Ik Rig preview
Primitive

Ik Rig

@remotionui/ik-rig

From RemotionUI

A lit, shadowed two-bone IK arm that reaches for any target or plots SVG strokes with a pen, laying ink exactly where the solved hand is; soft IK, fixed bend, animatable base

Install

npx remotion-ui@latest add ik-rig

Props (21)

  • base*Animatable<[number, number]>

    Shoulder position. Animate it to mount the arm on a rail, a vehicle or a body.

  • lengthsreadonly [number, number]= [220, 200]

    Upper arm and forearm length, px.

  • targetAnimatable<[number, number]>

    What the hand reaches for: static, keyframed or an expression. Ignored when plot is set.

  • plotIkPlot

    { d, speed?, travelSpeed?, ramp?, cornerAngle?, liftFrames?, minTravelFrames?, overshoot?, startFrame?, home?, park? } — strokes the hand draws with a pen. Each subpath is one pen-down stroke.

  • bend1 | -1= 1

    Side the elbow folds to. Fixed for the shot, so the elbow never flips.

  • softnessnumber= 0.08

    Soft IK: share of the reach over which the arm eases into full extension instead of popping straight.

  • thicknessnumber= 34

    Upper-arm width, px; the rest of the arm is proportioned from it.

  • armColorstring= "#80848f"

    Anodised body colour; lit and shaded per frame from lightAngle.

  • accentColorstring= "#2dd4bf"

    Status light on the pen head; bright while the pen is down.

  • inkColorstring= "#e8b86d"

    Ink and the hot glow at the nib.

  • inkWidthnumber= 4

    Ink stroke width, px.

  • glownumber= 0.6

    Bloom on the ink, 0–1. 0 draws flat ink.

  • lightAnglenumber= -125

    Direction the key light comes from, degrees in screen space (-90 = from above).

  • shadownumber= 0.55

    Cast-shadow opacity. Shadow offset grows with each part's height and with pen lift.

  • cableboolean= true

    Slack service cable from base to elbow (a constant-length rubber hose).

  • renderArm(pose: IkPose) => ReactNode

    Replaces the built-in arm with your own SVG, drawn from the solved pose.

  • renderUnder(pose: IkPose) => ReactNode

    SVG under the ink — paper, beds, rails.

  • renderOver(pose: IkPose) => ReactNode

    SVG over everything.

  • widthnumber= 960

    SVG width in px.

  • heightnumber= 540

    SVG height in px.

  • framenumber

    Render this frame instead of the current one.

Depends on

npm packages

Categories