AutoMovie API
    Preparing search index...

    Interface IAutoMovieMotionHumanProp

    A prop actions can aim at and hands can hold: a subject id, its world frame at rest, and its named points in that frame, such as a heavy bag's striking surface, a pad's face or a cup's handle.

    The prop stays at its rest frame, on the bone it is worn on, or at its initial mount until a hand grips it; while gripped it rides the hand, unless it is a fixture, worn it rides its bone, and it stays where the last grip released it, or flies from a launch and rests where it struck (see HumanPerformance.prop). A point's normal points out of the prop's surface.

    interface IAutoMovieMotionHumanProp {
        affordances?: readonly IAutoMovieAffordance[];
        body?: IAutoMovieBody;
        fixed?: boolean;
        frame: IAutoMovieRigidTransform;
        hasArticulations?: boolean;
        mounted?: IMounted;
        points: Readonly<
            Record<string, { normal: IAutoMovieVector3; point: IAutoMovieVector3 }>,
        >;
        shapes?: readonly IAutoMoviePhysicalShape[];
        soft?: IAutoMovieSoftBodyDomain;
        softSpan?: ISoftSpan;
        subject: string;
        tracks?: readonly IAutoMovieMotionHumanProp.ITrack[];
        worn?: IWorn;
        articulate?(
            state: Readonly<Record<string, number>>,
        ): IAutoMovieMotionHumanProp.IPosed;
        motion?(seconds: number): IAutoMovieRigidTransform;
        point?(id: string, seconds: number): IPlacedPoint | undefined;
    }
    Index
    affordances?: readonly IAutoMovieAffordance[]

    Contact frames in the prop's frame (a handle's +Y approach and +X wrapped axis), which a grasp plans from by id.

    The prop's physical data as its model declares it: its mass, which a hit it delivers in flight carries, and the contact data its flights read (HumanPropFlight). Absent when the model declares none.

    fixed?: boolean

    Whether the prop is a fixture: a thing set in the scene that bears on the floor or a wall and is never lifted, such as a ladder, a rail or a wall bar. A hand that grips a fixture bears on it, as a climber's hand on a rung, and never carries it, so it stays at its rest frame whatever grips it. Not a fixture when absent.

    The prop's world frame before any grip.

    hasArticulations?: boolean

    Whether the model declares internal articulation. Explicit false allows rigid carry even when a uniform model adapter exposes a pose reader.

    mounted?: IMounted

    The socket another prop carries this rigid prop on from the film's start. The frame follows the posed socket through the first hand closure, which takes over placement. The target affordance must be declared on the other prop. Mount chains must end at a prop with no initial mount. HumanPerformance refuses a mounted prop that also declares worn, motion, fixed: true, or soft.

    points: Readonly<
        Record<string, { normal: IAutoMovieVector3; point: IAutoMovieVector3 }>,
    >

    Named points in the prop's frame, metres, with outward unit normals.

    shapes?: readonly IAutoMoviePhysicalShape[]

    Colliders in the prop's frame, for finger closure until contact and penetration audits.

    The prop's cloth or cord lattice, for a prop that bends: a towel, a flag, a rope. Its particles are solved once over the performance from the displayed poses (HumanPerformanceSoft): its anchors may ride a performer's bone (actor-bone) or a rigid prop's frame (a node binding naming that prop's subject), its body capsules a performer's bones, and a hand's grip on the prop holds the particle nearest the hand. Its rest is in world metres. Rigid when absent.

    softSpan?: ISoftSpan

    A soft cord whose first and last anchors follow a single declared span. Absent leaves every soft anchor to its own ordinary binding.

    subject: string

    Subject id, unique in the performance.

    tracks?: readonly IAutoMovieMotionHumanProp.ITrack[]

    The prop's own movements after a trigger, each an articulation's travel from a start instant: a trebuchet's arm swinging once its pin is pulled, a door swinging shut on its closer. They share one state with the performance's drives. None when absent.

    worn?: IWorn

    The person and bone the prop is worn on from the film's start, with its frame in the bone's posed frame: a hat on the head, a holster on the hips. While worn it rides that bone and frame is not read; a grip takes it off, and an action's wears puts it on again. Not worn when absent.

    • The prop posed at stated travels of its articulations, for a prop whose parts an act moves (a door's leaf, a trigger, a bowstring): its contacts and colliders in its own frame with the parts moved. The performance reads it at the travels the drives and tracks give at a second (HumanPerformance.state), so a hand reaching a handle after the door was opened goes to where the handle is. A rigid object's model adapter can also expose this reader.

      Parameters

      • state: Readonly<Record<string, number>>

        Travel by articulation id, in each articulation's own unit; an articulation left out stays at rest.

      Returns IAutoMovieMotionHumanProp.IPosed

      The posed contacts and colliders.

      When a travel lies outside its articulation's range.

    • A named point in the world at a film second, for a prop whose parts move within it: a pedal on its crank, a stirrup on a trotting horse, a handle on a door that swings. points holds a point where it is in the prop at rest, and the prop's frame alone carries it rigidly; a point this knows is read here instead, so a foot or a hand aimed at it follows the part and not the place the part had at rest.

      Parameters

      • id: string

        The point's name, one of points.

      • seconds: number

        Film seconds.

      Returns IPlacedPoint | undefined

      The point and its outward unit normal, world metres; undefined for a point that only moves with the prop's frame.