AutoMovie API
    Preparing search index...

    Interface IAutoMovieSweepSpine

    The path a sweep's sections travel along: a curve through points, such as the centre line of a tube or the joint centres of a bone chain.

    The curve passes through every point and is parameterized by chord length, u = 0 at the first point and u = 1 at the last, each point at its share of the polygon's length. The curve is the centripetal Catmull-Rom spline through the points, which has no cusp or loop within a segment, so a bone chain bends smoothly through its joints and runs straight along its bones. Sections are placed in rotation-minimizing frames transported from normal at the start, so the path itself adds no twist. tangents can set the directions the path leaves its first point and reaches its last, as a curve that must meet a surface tangentially does.

    interface IAutoMovieSweepSpine {
        normal: IAutoMovieVector3;
        points: IAutoMovieVector3[];
        tangents?: { end?: IAutoMovieVector3; start?: IAutoMovieVector3 };
    }
    Index

    Direction of the section plane's first axis at the start, in metres' frame; its component along the path's first tangent is removed, so it must not be parallel to that tangent.

    Points the path passes through, in metres, at least two, no two consecutive ones equal.

    tangents?: { end?: IAutoMovieVector3; start?: IAutoMovieVector3 }

    Directions the path leaves its first point along and arrives at its last point along; each replaces the spline's own end direction and keeps its speed, so only the end segment's shape changes. Omitted, the spline's own.

    Type Declaration

    • Optionalend?: IAutoMovieVector3

      Direction at the last point, not zero; omitted, the spline's own.

    • Optionalstart?: IAutoMovieVector3

      Direction at the first point, not zero; omitted, the spline's own.