AutoMovie API
    Preparing search index...

    Interface IAutoMovieSweep

    A lofted sweep surface: a family of closed sections travelling along a spine, shaped between them by silhouette guides and pinned by feature curves.

    The surface is a function of two parameters: u along the spine by chord length from 0 to 1, and v around it from 0 to 1, the polar angle 2 pi v in the section plane from its first axis. compileAutoMovieSweep evaluates it in four ordered layers:

    1. Sections: every station's radius by direction, interpolated along u by a C2 spline under tension, selected by its sampled overshoot policy, so curvature is continuous at interior stations. The sampled bound is not a strict extremum bound; non-positive queried radii are refused.
    2. Guides: each guide is a curve on the surface at one direction, giving the radius there at every u; stations and guides are joined as a sampled Gordon surface: guide constraints are exact at its angular grid, with linear angular reconstruction between samples, so a few stations plus guides control breadth and depth everywhere between them.
    3. Features: each feature curve in the (u, v) domain carries the radius the surface targets along it, with compact falloff in a cylindrical metric approximation. Dense-seeded local course search and overlapping bands limit exact passage and global smoothness.
    4. Scale: an optional profile along u multiplies the whole section, features included, the size control that volume preservation and local bulges use.

    Positions are metres. The section plane at u is the spine's rotation-minimizing frame, or under the fixed orientation the spine's start frame carried along without turning, in either case turned by the stations' rotations where they give one.

    interface IAutoMovieSweep {
        correspondence?: "parameter" | "direction";
        features?: IAutoMovieSweep.IFeature[];
        guides?: IAutoMovieSweep.IGuide[];
        orientation?: "transported" | "fixed";
        scale?: IAutoMovieSweep.IKnot[];
        spine: IAutoMovieSweepSpine;
        stations: IAutoMovieSweep.IStation[];
    }
    Index
    correspondence?: "parameter" | "direction"

    How stations correspond: direction pairs the points of neighbouring stations along each polar angle about the spine point, so every section must be star-shaped about it; parameter pairs points at equal curve parameters, corner k with corner k for polygons, so sections may be concave and may carry holes, while guides and features, which are read by direction, are not available. Omitted, direction.

    Feature curves targeted by compact radius fields; omitted or empty, none.

    Silhouette guides; omitted or empty, the stations alone set the form.

    orientation?: "transported" | "fixed"

    How the section plane follows the spine: transported turns it with the spine's rotation-minimizing frame, so sections stay normal to a bending path, as a tube needs; fixed keeps the start frame's axes at every u, a translational sweep whose sections stay parallel however the path bends, as a body measured in level planes needs. Station rotations turn the plane relative to this frame in both cases, so stations that all give one rotation keep that exact plane between them too. Under fixed the path must stay out of the plane it carries, or sections there collapse onto it. Omitted, transported.

    Section scale by u, applied last, to the section with its guides and features: knots as for a guide, values positive, interpolated by the same spline; omitted, 1 everywhere.

    The path the sections travel along.

    Key sections, at least one, with strictly increasing at.