@willcgage/module-schematic 0.29.0 → 0.30.0

package/dist/index.d.cts

@@ -281,6 +281,19 @@ interface SchematicSection {
      * the module outline. Absent = the section has no shape of its own yet (it's
      * described only by the joints in `sectionBreaks`). */
     outline?: BenchworkPoint[] | null;
+    /** How far this board runs along the main, inches. The module's length is the
+     * SUM of these — it isn't authored separately (#108). */
+    lengthInches?: number | null;
+    /** This board's own shape: straight | curve | corner_45 | corner_90 | offset |
+     * dead_end. Geometry belongs to the SECTION, not the module — a module like
+     * One Mile is 384″ of mostly-straight boards with two 24″ CURVED sections in
+     * the middle, which no single module-level geometry can describe (#108).
+     * Absent = straight. */
+    geometryType?: string | null;
+    /** Degrees turned, for curve/corner sections. */
+    geometryDegrees?: number | null;
+    /** Lateral jog, for offset sections. */
+    geometryOffsetInches?: number | null;
 }
 /** The authored benchwork outline, or null when a module hasn't drawn one
  * (renderers then fall back to a band derived from the endplate widths). A
@@ -390,6 +403,35 @@ interface ModuleFootprint {
  * An authored `mainPath` wins — the owner drew the real shape; otherwise the
  * centre-line is derived from the geometry fields (length + type/degrees/offset). */
 declare function moduleCenterline(input: ModuleFootprintInput): BenchworkPoint[];
+/** The module's length as the SUM of its sections, or null when it has none
+ * (then the authored module length still speaks). */
+declare function moduleLengthFromSections(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): number | null;
+/** Where each section starts and ends along the main, inches from endplate A.
+ * This is what `sectionBreaks` used to author by hand — now derived, so a
+ * length is just a number you type and nothing steals from its neighbour. */
+declare function sectionSpans(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): {
+    id: string;
+    name?: string;
+    fromPos: number;
+    toPos: number;
+}[];
+/** The joints implied by the sections — the interior boundaries, in inches from
+ * endplate A. Replaces the authored `sectionBreaks` for a sectioned module. */
+declare function sectionBreaksFromSections(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): number[];
+/** The module's centre-line built by CHAINING its sections — each board starts
+ * where the previous one ended, at the heading it ended on. This is what makes
+ * a module like One Mile expressible: straight boards with two 24″ curved ones
+ * in the middle, which no single module-level geometry can describe (#108).
+ * Returns [] when the module has no sections with lengths. */
+declare function sectionedCenterline(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): BenchworkPoint[];
 /** Benchwork band: the centre-line offset ±half-width, tapering widthA→widthB. */
 declare function benchworkBand(center: BenchworkPoint[], widthA?: number, widthB?: number, offsetA?: number, offsetB?: number): BenchworkPoint[];
 /** The two endplate faces (the band's flat ends): [A end at widthA, B end at widthB]. */
@@ -878,4 +920,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OutlineFace, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionFootprints, stateToDoc, trackPath };
+export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OutlineFace, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionBreaksFromSections, sectionFootprints, sectionSpans, sectionedCenterline, stateToDoc, trackPath };

package/dist/index.d.ts

@@ -281,6 +281,19 @@ interface SchematicSection {
      * the module outline. Absent = the section has no shape of its own yet (it's
      * described only by the joints in `sectionBreaks`). */
     outline?: BenchworkPoint[] | null;
+    /** How far this board runs along the main, inches. The module's length is the
+     * SUM of these — it isn't authored separately (#108). */
+    lengthInches?: number | null;
+    /** This board's own shape: straight | curve | corner_45 | corner_90 | offset |
+     * dead_end. Geometry belongs to the SECTION, not the module — a module like
+     * One Mile is 384″ of mostly-straight boards with two 24″ CURVED sections in
+     * the middle, which no single module-level geometry can describe (#108).
+     * Absent = straight. */
+    geometryType?: string | null;
+    /** Degrees turned, for curve/corner sections. */
+    geometryDegrees?: number | null;
+    /** Lateral jog, for offset sections. */
+    geometryOffsetInches?: number | null;
 }
 /** The authored benchwork outline, or null when a module hasn't drawn one
  * (renderers then fall back to a band derived from the endplate widths). A
@@ -390,6 +403,35 @@ interface ModuleFootprint {
  * An authored `mainPath` wins — the owner drew the real shape; otherwise the
  * centre-line is derived from the geometry fields (length + type/degrees/offset). */
 declare function moduleCenterline(input: ModuleFootprintInput): BenchworkPoint[];
+/** The module's length as the SUM of its sections, or null when it has none
+ * (then the authored module length still speaks). */
+declare function moduleLengthFromSections(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): number | null;
+/** Where each section starts and ends along the main, inches from endplate A.
+ * This is what `sectionBreaks` used to author by hand — now derived, so a
+ * length is just a number you type and nothing steals from its neighbour. */
+declare function sectionSpans(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): {
+    id: string;
+    name?: string;
+    fromPos: number;
+    toPos: number;
+}[];
+/** The joints implied by the sections — the interior boundaries, in inches from
+ * endplate A. Replaces the authored `sectionBreaks` for a sectioned module. */
+declare function sectionBreaksFromSections(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): number[];
+/** The module's centre-line built by CHAINING its sections — each board starts
+ * where the previous one ended, at the heading it ended on. This is what makes
+ * a module like One Mile expressible: straight boards with two 24″ curved ones
+ * in the middle, which no single module-level geometry can describe (#108).
+ * Returns [] when the module has no sections with lengths. */
+declare function sectionedCenterline(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined): BenchworkPoint[];
 /** Benchwork band: the centre-line offset ±half-width, tapering widthA→widthB. */
 declare function benchworkBand(center: BenchworkPoint[], widthA?: number, widthB?: number, offsetA?: number, offsetB?: number): BenchworkPoint[];
 /** The two endplate faces (the band's flat ends): [A end at widthA, B end at widthB]. */
@@ -878,4 +920,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OutlineFace, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionFootprints, stateToDoc, trackPath };
+export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OutlineFace, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionBreaksFromSections, sectionFootprints, sectionSpans, sectionedCenterline, stateToDoc, trackPath };

package/dist/index.js

@@ -19,10 +19,17 @@ function moduleSections(doc) {
   return (doc?.sections ?? []).filter((sec) => sec && typeof sec.id === "string" && sec.id !== "").map((sec) => {
     const outline = benchworkOutline({ outline: sec.outline });
     const name = typeof sec.name === "string" ? sec.name.trim() : "";
+    const len = sec.lengthInches;
+    const deg = sec.geometryDegrees;
+    const off = sec.geometryOffsetInches;
     return {
       id: sec.id,
       ...name ? { name } : {},
-      ...outline ? { outline } : {}
+      ...outline ? { outline } : {},
+      ...typeof len === "number" && Number.isFinite(len) && len > 0 ? { lengthInches: len } : {},
+      ...sec.geometryType ? { geometryType: sec.geometryType } : {},
+      ...typeof deg === "number" && Number.isFinite(deg) ? { geometryDegrees: deg } : {},
+      ...typeof off === "number" && Number.isFinite(off) ? { geometryOffsetInches: off } : {}
     };
   });
 }
@@ -126,6 +133,8 @@ var DEG_FP = Math.PI / 180;
 function moduleCenterline(input) {
   const drawn = trackPath(input.mainPath);
   if (drawn) return samplePath(drawn);
+  const chained = sectionedCenterline(input);
+  if (chained.length >= 2) return chained;
   if (!input.geometryType) return [];
   const L = input.lengthInches > 0 ? input.lengthInches : 24;
   const gt = input.geometryType;
@@ -143,6 +152,73 @@ function moduleCenterline(input) {
   }
   return pts;
 }
+function sectionCenterlineLocal(sec) {
+  const L = typeof sec.lengthInches === "number" && sec.lengthInches > 0 ? sec.lengthInches : 0;
+  const gt = sec.geometryType || "straight";
+  if (L <= 0) return { points: [{ x: 0, y: 0 }], endX: 0, endY: 0, endHeadingDeg: 0 };
+  if (gt === "offset") {
+    const dy = sec.geometryOffsetInches ?? 0;
+    return { points: [{ x: 0, y: 0 }, { x: L, y: dy }], endX: L, endY: dy, endHeadingDeg: 0 };
+  }
+  const turn = gt === "corner_45" ? 45 : gt === "corner_90" ? 90 : gt === "curve" ? sec.geometryDegrees ?? 0 : 0;
+  if (turn === 0) return { points: [{ x: 0, y: 0 }, { x: L, y: 0 }], endX: L, endY: 0, endHeadingDeg: 0 };
+  const t = turn * DEG_FP;
+  const r = L / t;
+  const steps = 12;
+  const points = [];
+  for (let i = 0; i <= steps; i++) {
+    const a = t * i / steps;
+    points.push({ x: r * Math.sin(a), y: r * (1 - Math.cos(a)) });
+  }
+  const last = points[points.length - 1];
+  return { points, endX: last.x, endY: last.y, endHeadingDeg: turn };
+}
+function moduleLengthFromSections(doc) {
+  const secs = moduleSections(doc).filter(
+    (sec) => typeof sec.lengthInches === "number" && sec.lengthInches > 0
+  );
+  if (!secs.length) return null;
+  return secs.reduce((a, sec) => a + sec.lengthInches, 0);
+}
+function sectionSpans(doc) {
+  let acc = 0;
+  const out = [];
+  for (const sec of moduleSections(doc)) {
+    const L = typeof sec.lengthInches === "number" && sec.lengthInches > 0 ? sec.lengthInches : 0;
+    if (L <= 0) continue;
+    out.push({ id: sec.id, ...sec.name ? { name: sec.name } : {}, fromPos: acc, toPos: acc + L });
+    acc += L;
+  }
+  return out;
+}
+function sectionBreaksFromSections(doc) {
+  const spans = sectionSpans(doc);
+  return spans.slice(0, -1).map((sp) => sp.toPos);
+}
+function sectionedCenterline(doc) {
+  const secs = moduleSections(doc).filter(
+    (sec) => typeof sec.lengthInches === "number" && sec.lengthInches > 0
+  );
+  if (!secs.length) return [];
+  const out = [];
+  let ox = 0;
+  let oy = 0;
+  let heading = 0;
+  for (const sec of secs) {
+    const local = sectionCenterlineLocal(sec);
+    const c = Math.cos(heading * DEG_FP);
+    const sn = Math.sin(heading * DEG_FP);
+    for (let i = 0; i < local.points.length; i++) {
+      if (i === 0 && out.length) continue;
+      const p = local.points[i];
+      out.push({ x: ox + p.x * c - p.y * sn, y: oy + p.x * sn + p.y * c });
+    }
+    ox += local.endX * c - local.endY * sn;
+    oy += local.endX * sn + local.endY * c;
+    heading += local.endHeadingDeg;
+  }
+  return out;
+}
 function centerlineNormals(center) {
   return center.map((_, i) => {
     const a = center[Math.max(0, i - 1)];
@@ -1116,6 +1192,6 @@ function poseOverridesFromDoc(doc) {
   return out;
 }
 
-export { FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionFootprints, stateToDoc, trackPath };
+export { FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionBreaksFromSections, sectionFootprints, sectionSpans, sectionedCenterline, stateToDoc, trackPath };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map