AutoMovie API
    Preparing search index...

    Interface IAutoMovieReachAction

    Reach one hand with a compatible articulated arm. The paw gesture names a creature intent but has no reference motion; a pawing movement needs a host synthesizer or authored enact clip.

    performShot refuses a target that does not resolve to one point, which includes the relative kinds and a group naming a formation, and refuses the verb for any performer whose rig cannot bend the named arm (armChainFault), because the synthesizer would otherwise produce nothing and the shot would pass having performed no reach. The reference synthesizer (makeActorSynthesizer) solves the arm with reachPose, an analytic two-bone solve whose elbow turns only about its flexion axis and whose shoulder spends the chain's swivel staying inside the rig's declared range. A target out of range extends the arm fully toward it, and a target no in-range pose reaches yields the least-violating pose for the shot's range-of-motion gate to reject. A node target is reached at its staged placement point, not lifted to a hand or chest height. The clip eases from rest into the pose over half the span and holds it; the solve is resampled through the span when the target is a bone or the host supplies the actor's moving frame. An "auto" reach lasts 0.6 s, and with no region it drives the upper body.

    interface IAutoMovieReachAction {
        actor: string | string[];
        duration: number | "auto";
        hand: "left" | "right";
        physicsIntent?: string;
        region?: AutoMovieBodyRegion;
        repeat?: number;
        start: number;
        to: IAutoMovieActionTarget;
        verb: "reach";
    }

    Hierarchy (View Summary)

    Index
    actor: string | string[]

    The scene-node id or ids performing this action, reusing ids from staging. A list applies the same verb to several actors in unison (a chorus line, a crowd, synchronised dancers) instead of repeating the action per actor. Every id must be a staged scene node, and a list must be non-empty with no duplicates. Only a frame action names a camera, and it names exactly one as a string.

    duration: number | "auto"

    Length in seconds, finite and > 0 with start + duration inside the shot, or "auto" to let the engine pick a natural duration (a stride cadence, a punch's snap, a projectile's flight time). The reference synthesizer sizes an "auto" clip itself, while performShot's overlap check and an attachTo treat the span as running to the shot end, and a frame as running until the next camera move. An "auto" action may not start exactly at the shot end, which leaves it no span.

    hand: "left" | "right"

    Arm that reaches; the rig must be able to bend it.

    physicsIntent?: string

    Free-text acknowledgment of a deliberate physical implausibility, such as "defies-gravity" or "intentional-clip", meant to stop the engine's warning-severity plausibility feedback (see IAutoMovieConstraintViolation.severity) from re-firing on this action. No engine or production path reads this field: the plausibility detectors take their own physicsIntent argument, and no shot pipeline calls them, so setting it changes nothing today.

    The body region this action drives (AutoMovieBodyRegion). Actions whose masked content is disjoint compose concurrently (walk while waving while looking), and actions sharing content take turns. Omitted, the engine's actionRegion infers it from the verb and, for gestures, the kind: locomote is fullBody, because the shipped gaits drive hips, knees, and contralateral arms; gesture and reach are upperBody; lookAt and the nod and shake gestures are head; emote is face; the bow, crouch, kick, stagger, jump, and draw gestures and every other verb are fullBody. Overlap is judged on the content surviving those masks (root, bones, expression), so a fullBody gait still layers with a disjoint head-only lookAt. The engine masks the synthesized clip to the chosen region and performShot reports content the mask drops, so override only when the natural region is wrong for the staging. Camera (frame) and attachTo actions ignore it.

    repeat?: number

    Play the synthesized motion this many times back to back, a positive integer defaulting to 1: a step repeated on the count, an idle sway. compilePerformance concatenates the synthesized clip that many times, so the motion runs repeat clip lengths, while performShot's span and overlap checks read only start + duration.

    start: number

    Seconds into the shot when it begins, within [0, shot duration].

    Target the hand is brought to; it must resolve to one point.

    verb: "reach"

    Selects a reach as the action family.