AutoMovie API
    Preparing search index...

    A held thing in the hand's grip frame.

    interface ITool {
        axis: IAutoMovieVector3;
        edge: IAutoMovieVector3;
        held?: IAutoMovieMotionHumanHeld.IHeld;
        length: number;
        prop?: string;
        rolls: boolean;
        side: AutoMovieHumanSide;
        span: readonly [number, number] | null;
        tip: IAutoMovieVector3;
        wields?: IAutoMovieMotionWieldedTool;
    }
    Index

    The unit direction the tool runs toward its working point, hand frame.

    The unit direction the tool cuts or sights along, square to the axis, hand frame.

    The prop as the hand holds it; absent for the bare hand.

    length: number

    The working length behind the point along the axis, metres: the distance from an explicit from, otherwise the grip's projection behind the tip; 0 for the bare hand.

    prop?: string

    The prop's subject id; absent when the bare hand is the effector.

    rolls: boolean

    Whether the tool has no edge of its own: a prop that declares no edge affordance (a bat, a club), whose edge is then only a direction square to the axis, so its roll about its own line is free to the arm. False for the bare hand, whose edge is the little finger's side.

    The holding hand.

    span: readonly [number, number] | null

    The run of the tool's edge along its axis, metres behind the working point: its end by the point, then its end by the hand, read from the edge affordance's centre and length (a sword's true edge, the length of its blade). Null when the tool declares no such edge: its working point is then all that strikes (a racket's sweetSpot, a club's strike, the bare hand's grip).

    The working point from the grip socket, in the hand bone's frame, metres.

    What the plan publishes of the held tool; absent for the bare hand.