Node reference¶
One page per operator: what it does, how to wire it, every
parameter, and a minimal animated example. Each example stage
lives in examples and plays in usdview via
bin\launch_usdview.bat; the GIF on each page is rendered
live from that stage by docs/render_media.py, an offscreen
Storm viewport with the rig guides on.
Concepts¶
| Page | About | |
|---|---|---|
| How operators fire | The mental model and the evaluation order behind every rig in usdRig — who reads what, who writes what, and when. | |
| Evaluation and independent checks | One production operation graph for native, frozen and runtime evaluation, with optional independent judges. | |
| What warming does | The per-frame cache in one page: what warms, what you see, what it costs, and the switches. | |
| Tutorial: a rolling ball rig | Hand-build a rolling ball in usdview and Noodles, with a complete video and a screenshot for every step. | |
| Compression-driven wrinkles | How compression and a stable fold guide produce quasistatic wrinkles, with pins, attachment bounds, and local collision planes. | |
| Secondary motion and cloth | How the harmonics constraint and the cloth mover read the frames before the current one, inside the one evaluation loop, live, in background caches and in .rigexec playback. | |
| RigLogic behaviours | RigLogic's radial-basis solvers, ML morph deformer and animated maps in RigExec, where each one comes from, and the examples that show them. | |
| Tutorial: Godot and baked rigs | Build the ball in usdview, bake one self-contained rig asset, and drive its exposed controllers in Godot, with GIF checkpoints. | |
| External mover plugins | Build and register point movers from a separate repository for native, frozen and .rigexec playback. | |
| Live evaluator inspection | Attach the optional rigExec_viz tool to usdview and read a session's operation graph and per-operation thread timings. | |
| Paths and walking | Drive a rig along a BasisCurves path by arc length, author and edit the path, and steer a baked program with a moving window. | |
| 2D skeletons, binding and smart-bone step tables | Flat cut-out rigs: bones, the skeleton solve, binding artwork to bones, and dials whose step tables drive whole action frames. | |
| Weight display in usdview | Choose volume guides and surface color mappings for resolved weight fields. | |
| Licensing and provenance | What the project MIT license covers, which files keep upstream terms, and how the legal texts travel to installs and archives. |
Rig¶
| Node | Does | |
|---|---|---|
| Rig Root | The prim that makes a namespace a rig: partition, discovery root, evaluation unit. |
Transform providers¶
| Node | Does | |
|---|---|---|
| Control | The animator's handle: animation is authored on its avars. | |
| Joint | A posed output of the rig: solvers write it, movers read it. | |
| Space Switch | Gives a control a labelled list of parent spaces, selected or blended by an index. | |
| Auto Clavicle | Carries the shoulder with the arm's swing in FK or IK. | |
| Bone Frame | Evaluates joint channels with explicit scale and location inheritance. | |
| Copy Frame | Copies a live frame, optionally retaining incoming translation. | |
| Mapped Frame | Transfers source rest-to-pose motion onto a target rest frame. | |
| Skin Influence | Builds an explicit owner-follow and rest-to-pose skin matrix. | |
| Armature Parent | Applies a source rest-to-pose map over an incoming owner frame. |
Solvers¶
| Node | Does | |
|---|---|---|
| FK Chain | Composes per-control local animation down a joint hierarchy. | |
| Two-Bone IK | Aims a two-segment limb at an effector with pole-vector control. | |
| Spline IK | Lays a joint chain along a curve built from three controls. | |
| Blend Point Frames | Blends two solver poses per joint under one weight. | |
| Twist Distribution | Unwinds roll between two frames across N interpolated frames. | |
| Ribbon | Samples a driver curve into transported frames for wrap deformers. | |
| Joint Group | API schema that makes a prim (conventionally a Scope) a group of alternative chains among a solver's joints: exactly one member chain is active at a time. |
2D skeletons¶
| Node | Does | |
|---|---|---|
| Skeleton 2D | Solves a flat cut-out skeleton: bone channels, flips, locks and targets, one frame per bone. | |
| Bone 2D | API schema that makes a joint one bone of a 2D skeleton. |
Constraints¶
| Node | Does | |
|---|---|---|
| Aim Constraint | Rotates targets so a local axis points at blended sources. | |
| Position Constraint | Moves one provider to the weighted average of its sources' origins. | |
| Rotation Constraint | Copies orientation from blended sources, leaving position alone. | |
| Scale Constraint | Copies blended source scale onto one target, per axis. | |
| Parent Constraint | Carries a target with its sources — position and rotation — under a per-source offset; weight attaches and releases. | |
| Single-Chain IK Constraint | Re-poses an existing joint chain of any length onto an effector goal. | |
| IK/FK Match Constraint | Keeps a switchable limb's inactive half on its joints and publishes the values a switch authors. | |
| Harmonics Constraint | Secondary motion: overshoot, lag and jiggle of one joint or control from the frames before the current one. | |
| Constraint Frame | Computes ordered affine constraints in explicit owner and target spaces. |
Geometry movers¶
| Node | Does | |
|---|---|---|
| Matrix Mover | Carries points by a provider's rigid delta under a weight field. | |
| Skin Mover | Blends many influences per point in one pass, UsdSkel-style. | |
| Layered Skin Mover | Applies masked linear or dual-quaternion skin over a point revision. | |
| Blendshape Mover | Sums sculpted blend channels into one delta pass. | |
| Curve Mover | Transports points through a solver's frame array, follows a NURBS wire curve, or emits frame origins. | |
| Lattice Mover | Deforms points through a legacy cage or a regular interpolation grid. | |
| Surface Mover | Drapes points onto an animated driver surface. | |
| Surface Binding Mover | Follows fixed barycentric attachments with vector offsets. | |
| Patch Mover | Sticks points onto a NURBS patch at controller-drivable UV coordinates. | |
| Smooth Mover | Relaxes points with uniform Laplacian smoothing. | |
| Delta Mush Mover | Smooths deformation and restores transported rest detail. | |
| Wrinkle Mover | Solves coherent compression-driven folds on an already deformed mesh. | |
| Cloth Mover | Cloth with painted anisotropic materials, attachments and contact, simulated over the frames before the current one. | |
| Volume Correct Mover | Pulls a deformation back toward its rest bound volume. | |
| ML Mover | A neural morph deformer: a small network maps the pose to morph weights. | |
| ML Output | One output of an ML mover's network, and the float it publishes. |
Blend channels¶
| Node | Does | |
|---|---|---|
| Blend Input | One weighted channel of sculpted targets inside a blendshape pass. | |
| Blend Sample | One sculpted target at a fixed channel activation. |
Pose space¶
| Node | Does | |
|---|---|---|
| Pose Interpolator | Turns a driver's rotation into one float per authored pose. | |
| Pose | One place the driver can be, and the float it publishes when the driver gets there. | |
| Animated Maps | RigLogic's animated maps: [0, 1] mask values from control values, for shaders, or unclamped step tables. | |
| Animated Map | One conditional table of an Animated Maps node, and its value. |
Weights¶
| Node | Does | |
|---|---|---|
| Static Weight | A painted, time-invariant weight field over moved points. | |
| Dynamic Weight | The joint is frozen; only the painted field is animated. | |
| Sphere Weight | A ball of influence: radial falloff generated from a placed volume. | |
| Plane Weight | A half-space gradient: everything past the placed plane is weighted in. | |
| Curve Weight | A tube of influence around a curve's control polygon. | |
| Combine Weight | Folds several weight fields into one under a single mode. |
Property math¶
| Node | Does | |
|---|---|---|
| Float Math Mover | Arithmetic on one scalar channel: add, clamp, remap, blend, curve, quantize, path. | |
| Vec3f Math Mover | Component-wise arithmetic on one vector-valued property. | |
| Matrix Math Mover | Multiplies or blends one matrix channel. |
Shading¶
| Node | Does | |
|---|---|---|
| Surface Projector | Publishes a frame riding a deforming surface to its shader, as a matrix primvar. |
Interface¶
| Node | Does | |
|---|---|---|
| Picker | A character's control picker panel, shipped as scene data. | |
| Picker Panel | One sub-tab of a picker: a 2D canvas of buttons. | |
| Picker Button | One clickable shape: selects controls, flips a switch, or decorates. | |
| Touch Regions | Named face sets that turn the model itself into the control picker. | |
| Touch Region | A named set of mesh faces that selects the control posing them. |
Implementation and design notes live in specs.