AutoMovie API
    Preparing search index...
    • A trailer towed by a leader: the trailer's coupling held on the leader's hitch at every second, and its axle following as a single-axle trailer does, its heading lagging into the turns.

      The trailer is drawn by any ride, a car's, a horse's or a cart's along a course. Its axle line, the trailer's own X axis through axle, never slides sideways, so its heading turns toward the hitch at the hitch's sideways speed over the coupling's distance ahead of the axle; the heading is integrated from the leader's start, the trailer then aligned behind the hitch, by the engine's integrator (integrateMotionTrajectory), so the trailer's path depends only on the leader's and its own start. A four-wheeled wagon is two such links: its pole and front axle turn about the front axle's pivot, trailing the hitch, and its body trails the pivot on its rear axle, the front axle's articulation set to the two links' difference. The ride publishes the leader's plan and instants, and at each second the leader's course state with the trailer's placement. The lines given in lines run between the two: at every second each of their points is found on the leader's model as the leader's ride poses and places it, or on the trailer's as this ride does, so a trace or a driving line stays on both at once, whatever either does.

      Type Parameters

      • LeaderId extends string
      • LeaderDimension extends string
      • Id extends string
      • Dimension extends string

      Parameters

      • leader: IRide<LeaderId, LeaderDimension>

        The leader's ride.

      • hitch: LeaderId

        The leader's contact the trailer is hitched to.

      • trailer: Archetype<Id, Dimension>

        The trailer at rest.

      • coupling: Id

        The actual source contact held on the hitch; legacy inputs require it ahead along +Z, while declared single-axle support can tow a rear contact in reverse.

      • options: {
            axle?: IAutoMovieVector3;
            front?: IFront<Id>;
            lines?: readonly ArchetypeRide.ILine[];
            pose?: (state: ArchetypeCourse.IState) => Archetype<Id, Dimension>;
            support?: Support<Id>;
        } = {}

        support is producer-read actual axle geometry: a single axle permits body pitch, and fixedGround keeps two axles grounded with an optional actual drawbar hinge. Without it only an unchanged level coupling height is supported. Existing axle/front declarations must agree with supplied support; pose supplies current articulations and lines supplies actual inter-model spans.

      Returns ITowedRide<Id, Dimension>

      The trailer's ride.

      For inconsistent support/options, an unreachable or unsupported hitch height, an invalid support/articulation, a coupling that does not close, a nonpositive projected reach, missing contacts/line ends or front steering beyond its declared lock.