AutoMovie API
    Preparing search index...

    Interface IAutoMovieSweepSurface

    A sweep compiled for evaluation, from compileAutoMovieSweep.

    u is the chord-length parameter along the spine and v the turn around it, both from 0 to 1. Under direction correspondence v is polar angle divided by 2*pi; under parameter correspondence it is the section curve parameter and need not be polar angle or arc-length share. Position, section and frame queries clamp u and wrap v. Differential queries require u in [0,1]; their endpoint stencil is one-sided. Every query is deterministic. Angular linear reconstruction and a local feature nearest-branch change limit the smoothness guarantees. Coordinates use the authored model frame and metres. Returned points and frames are fresh mutable records. The compiled surface retains its source declaration and coefficients; preserve authored data while using it. compileAutoMovieSweep admits authored geometry, while individual queries refuse invalid generated radii or section coordinates; finite query arguments remain the caller's responsibility.

    interface IAutoMovieSweepSurface {
        loops: number;
        path: IAutoMovieSweepPath;
        step: number;
        sweep: IAutoMovieSweep;
        along(u: number, v: number, loop?: number): IAutoMovieVector3;
        feature(index: number, t: number): { u: number; v: number };
        frame(u: number): IAutoMovieSweepFrame;
        normal(u: number, v: number, loop?: number): IAutoMovieVector3;
        point(u: number, v: number, loop?: number): IAutoMovieVector3;
        profile(u: number, v: number): number;
        radius(u: number, v: number): number;
        scale(u: number): number;
        section(u: number, v: number, loop?: number): IAutoMovieSweepSection.IPoint;
        shape(u: number, v: number, loop?: number): IAutoMovieSweepSection.IPoint;
    }
    Index
    loops: number

    Number of loops: 1 for a sweep by direction, 1 plus its holes for a sweep by parameter.

    Compiled spine in the same model frame, with polygonal chord length in metres and normalized chord-length parameterization.

    step: number

    Parameter step of the central differences normal and along take, in u and in v.

    Borrowed source declaration by identity, not a deep snapshot. Changing it after compilation can disagree with retained coefficients.

    • The defining course of a feature in the sweep's domain.

      Parameters

      • index: number

        Feature index in the sweep's declaration

      • t: number

        Clamped share of the complete centripetal knot span, 0 to 1

      Returns { u: number; v: number }

      u along the spine and v in unwrapped turns

      • u: number

        Spine-domain coordinate on the fitted feature course; the cubic can overshoot authored u knots.

      • v: number

        Unwrapped fitted angular coordinate in turns, preserving continuity through the seam.

      Error when the feature index does not exist

    • Unit normal dP/dv x dP/du from central differences of the surface, which points away from the spine where the loop runs counterclockwise in its plane.

      Parameters

      • u: number

        Along the spine

      • v: number

        Around it

      • Optionalloop: number

        0 for the section, k for hole k - 1; omitted, 0

      Returns IAutoMovieVector3

      Dimensionless model-space unit vector, or zero when the finite-difference cross product is zero; hole orientation follows its authored winding

    • Distance of the section's outer loop from the spine point before the scale profile, so radius is scale(u) * profile(u, v).

      Parameters

      • u: number

        Along the spine

      • v: number

        Around it

      Returns number

      Metres, positive for direction correspondence; parameter correspondence permits zero at an authored origin point

    • Distance of the section's outer loop from the spine point in the section plane.

      Parameters

      • u: number

        Along the spine

      • v: number

        Around it

      Returns number

      Metres, positive for direction correspondence; parameter correspondence permits zero at an authored origin point

    • Point in the section plane before scale, the shape a compiled rig caches.

      Parameters

      • u: number

        Along the spine, clamped to 0 to 1

      • v: number

        Round the loop, wrapping as the selected correspondence defines

      • Optionalloop: number

        Outer loop 0 or a hole index; omitted, 0

      Returns IAutoMovieSweepSection.IPoint

      Unscaled section-plane coordinates in metres; parameter correspondence may pass through its origin

      Error for an unknown loop or a non-finite generated shape