docs: document smoothing value contracts

This commit is contained in:
梁薄云
2026-08-04 14:17:56 +08:00
parent 69fb09e617
commit fda84ce148
7 changed files with 104 additions and 6 deletions
@@ -5,6 +5,20 @@ namespace MultiWheelC.TrajectoryPlanning.PathSmoothing;
/// <summary>平滑空间路径上的不可变采样点;位置和长度单位为 m,航向为 rad,曲率为 1/m。</summary>
public sealed class SmoothedPathPoint
{
/// <summary>
/// 创建不显式提供曲率导数的不可变平滑路径点;曲率对弧长导数按 0 处理。
/// </summary>
/// <param name="xMeters">世界 X 坐标,单位 m。</param>
/// <param name="yMeters">世界 Y 坐标,单位 m。</param>
/// <param name="headingRadians">规范化车辆航向,单位 rad。</param>
/// <param name="unwrappedHeadingRadians">跨越 ±π 后仍连续的车辆航向,单位 rad。</param>
/// <param name="arcLengthMeters">从完整路径起点累计的弧长,单位 m。</param>
/// <param name="direction">该点所属方向段的实际行驶方向。</param>
/// <param name="geometricCurvaturePerMeter">几何曲线曲率,单位 1/m。</param>
/// <param name="vehicleCurvaturePerMeter">车辆模型使用的有符号曲率,单位 1/m。</param>
/// <param name="bodyClearanceMeters">扩大车体后的保守净空下界,单位 m。</param>
/// <param name="isGearSwitchPoint">为 <see langword="true"/> 时表示新方向段开始的精确换向点。</param>
/// <param name="source">该点在平滑流程中的来源枚举。</param>
public SmoothedPathPoint(
double xMeters,
double yMeters,
@@ -33,7 +47,19 @@ public sealed class SmoothedPathPoint
{
}
/// <summary>创建带有车辆曲率对弧长导数的不可变采样点。</summary>
/// <summary>创建带有车辆曲率对弧长导数的不可变平滑路径点。</summary>
/// <param name="xMeters">世界 X 坐标,单位 m。</param>
/// <param name="yMeters">世界 Y 坐标,单位 m。</param>
/// <param name="headingRadians">规范化车辆航向,单位 rad。</param>
/// <param name="unwrappedHeadingRadians">连续展开的车辆航向,单位 rad。</param>
/// <param name="arcLengthMeters">从完整路径起点累计的弧长,单位 m。</param>
/// <param name="direction">该点所属的前进或倒车方向。</param>
/// <param name="geometricCurvaturePerMeter">几何曲率,单位 1/m。</param>
/// <param name="vehicleCurvaturePerMeter">车辆曲率,单位 1/m。</param>
/// <param name="vehicleCurvatureDerivativePerSquareMeter">车辆曲率对弧长的导数 dκ/ds,单位 1/m²。</param>
/// <param name="bodyClearanceMeters">扩大车体后的保守净空下界,单位 m。</param>
/// <param name="isGearSwitchPoint">是否为新方向段开始的换向点。</param>
/// <param name="source">该点的平滑来源。</param>
public SmoothedPathPoint(
double xMeters,
double yMeters,