AutoMovie API
    Preparing search index...

    Interface IAutoMovieSurfaceRig

    A surface network compiled at one tier for posing, from rigAutoMovieSurfaceNetwork: the rest cage, and a per-pose update that writes the posed cage's control positions into a caller buffer.

    Everything that does not depend on the pose is computed once when the rig compiles: the cage's topology, UVs, coordinates and rings, every sample's parameters and shape before the scale profile, Coons and bridge weights, the limit-fit stencils and the rest volumes. pose then moves only what bones move: spines, section planes, joint scales, curves, blends and the fit. It allocates nothing; its only caches are the rig's own buffers, fixed in size by the network and tier when the rig compiles and released with the rig, and each sweep's row cache of compileAutoMovieSweep, which the rig fills while compiling and pose does not touch.

    interface IAutoMovieSurfaceRig {
        bones: readonly AutoMovieHumanoidBone[];
        cage: IAutoMovieSurfaceCage;
        construction: readonly IAutoMovieSurfaceConstruction[];
        pose(
            posed: readonly IAutoMovieResolvedBone[],
            positions: Float64Array,
            targets?: Float64Array<ArrayBufferLike>,
        ): number;
    }
    Index
    bones: readonly AutoMovieHumanoidBone[]

    The rest bones' names, in the order pose expects; empty for a rig without bones.

    The cage at rest: topology, UVs, coordinates, rings, targets and fitted positions.

    construction: readonly IAutoMovieSurfaceConstruction[]

    Requested rest construction polylines, after the girth solve; empty when not requested. These unfiltered generating curves stay at rest after pose updates.

    • Write the posed cage's control positions.

      Parameters

      • posed: readonly IAutoMovieResolvedBone[]

        The rest bones in the same order, posed; ignored by a rig without bones

      • positions: Float64Array

        Receives the packed control positions, cage.cage.positions.length numbers, metres

      • Optionaltargets: Float64Array<ArrayBufferLike>

        Optionally receives the packed limit targets, the same length

      Returns number

      The largest distance between a fitted vertex's limit point and its target, metres; 0 without the fit

      Error when a buffer has the wrong length, the posed bones differ from the rest bones, or a sweep or curve refuses the pose