docs: document smoothing processing core

2026-08-04 14:29:51 +08:00
parent 4a7dd875a4
commit 8f6e97e88f
17 changed files with 153 additions and 11 deletions
@@ -6,6 +6,16 @@ namespace MultiWheelC.TrajectoryPlanning.PathSmoothing.LocalG2;
 /// <summary>同一方向原语边界两侧车辆曲率的离散跳变。</summary>
 internal sealed class CurvatureTransition
 {
+    /// <summary>记录同一方向段内相邻粗路径采样点之间的车辆曲率跳变。</summary>
+    /// <param name="segmentIndex">所属方向段在预处理路径中的从零开始索引。</param>
+    /// <param name="leftCoarsePathIndex">跳变左侧粗路径采样点索引。</param>
+    /// <param name="rightCoarsePathIndex">跳变右侧粗路径采样点索引，必须等于左索引加一。</param>
+    /// <param name="localArcLengthMeters">跳变位置在方向段内的局部弧长，单位 m。</param>
+    /// <param name="x">跳变位置世界 X 坐标，单位 m。</param>
+    /// <param name="y">跳变位置世界 Y 坐标，单位 m。</param>
+    /// <param name="vehicleHeadingRadians">跳变位置的车辆航向，单位 rad。</param>
+    /// <param name="leftVehicleCurvaturePerMeter">左侧车辆曲率，单位 1/m。</param>
+    /// <param name="rightVehicleCurvaturePerMeter">右侧车辆曲率，单位 1/m。</param>
    internal CurvatureTransition(
        int segmentIndex,
        int leftCoarsePathIndex,