AutoMovie API
    Preparing search index...

    Interface IAutoMovieSampledFormationMotion

    One sampled unit state, with the arrangement it is travelling toward.

    With no cue, or before the first cue, sampleFormationMotion returns the identity state (zero translation and facing offset, unit spacing) with reform null; between cues it holds the last finished cue's to state.

    interface IAutoMovieSampledFormationMotion {
        facingOffsetDeg: number;
        reform: IAutoMovieFormationReform | null;
        spacingScale: { depth: number; lateral: number };
        translation: IAutoMovieVector3;
    }

    Hierarchy (View Summary)

    Index
    facingOffsetDeg: number

    Heading offset added around the designed anchor, in degrees.

    The re-form under way, or null when the unit keeps its designed arrangement. Null rather than an identity re-form, because "no target" and "a target identical to the design" are different statements and only the first is what a unit with no cue is doing.

    spacingScale: { depth: number; lateral: number }

    Positive lateral and depth scale for bounded density deformation.

    Type Declaration

    • depth: number

      Front-to-back spacing multiplier.

    • lateral: number

      Left-to-right spacing multiplier.

    translation: IAutoMovieVector3

    World-space translation in meters added to the designed formation anchor.