AutoMovie API
    Preparing search index...

    Interface IAutoMovieRelationalGoal

    A relation one subject's effector must realize against another subject's region, such as a contact, a reach or a near miss.

    The target is named, never placed: its world point is read from the target subject's actual pose when the goal resolves, frozen at the window's start (freeze) or followed through the window (track).

    interface IAutoMovieRelationalGoal {
        approach?: IAutoMovieVector3;
        lock: "freeze" | "track";
        surface: {
            bone: string;
            localDirection?: IAutoMovieVector3;
            localPoint: IAutoMovieVector3;
        };
        target: { region: string; subject: string };
        window: { end: number; start: number };
    }
    Index

    Optional unit world direction of arrival; without surface.localDirection only the point is fitted.

    lock: "freeze" | "track"

    Read the target at the window's start (freeze) or at each instant (track).

    surface: {
        bone: string;
        localDirection?: IAutoMovieVector3;
        localPoint: IAutoMovieVector3;
    }

    The performer's effector: a segment and a point and outward direction in its frame.

    Type Declaration

    • bone: string

      Segment carrying the effector.

    • OptionallocalDirection?: IAutoMovieVector3

      Optional unit effector direction in the segment frame. Orientation is fitted only when both this and approach are present.

    • localPoint: IAutoMovieVector3

      Effector point in the segment frame, metres.

    target: { region: string; subject: string }

    The named target.

    Type Declaration

    • region: string

      The target subject's region id, as its body declares regions.

    • subject: string

      Stable id of the target subject.

    window: { end: number; start: number }

    Seconds, film time, during which the relation holds; start <= end.

    Type Declaration

    • end: number

      Last active film second, inclusive. The caller supplies an ordered finite interval; the relational resolver does not validate it.

    • start: number

      First active film second, inclusive; also the target pose time for freeze mode.