Skip to content

Commit 9aed4c9

Browse files
committed
Update api docs, remove latex in cubic bezier
1 parent 0603aac commit 9aed4c9

2 files changed

Lines changed: 5 additions & 11 deletions

File tree

docs/api/pathing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Pathing API
2-
explanation
2+
The Pathing API defines a unified interface for representing and sampling 2D paths used in motion planning and trajectory generation. It provides both discrete and parametric path abstractions, making it easy to describe anything from a set of waypoints to smooth Bézier splines.
33
- [DiscretePath](@ref rz::DiscretePath)
4-
- [ParametricPath](@ref rz::ParametricPath)
4+
- [ParametricPath](@ref rz::ParametricPath)
5+
- [CubicBezier](@ref rz::CubicBezier)
6+
- [PiecewiseCubicBezier](@ref rz::PiecewiseCubicBezier)

include/RaidZeroLib/api/Pathing/CubicBezier.hpp

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ namespace rz {
88
* @brief Cubic Bézier parametric path segment.
99
*
1010
* A `CubicBezier` represents a smooth parametric curve defined by four control points:
11-
* \f[
12-
* P(t) = (1-t)^3 c_0 + 3(1-t)^2 t c_1 + 3(1-t)t^2 c_2 + t^3 c_3, \quad t \in [0, 1].
13-
* \f]
11+
* P(t) = (1-t)^3 c_0 + 3(1-t)^2 t c_1 + 3(1-t)t^2 c_2 + t^3 c_3.
1412
*
1513
* Each segment is constructed from two knots, which encode both position
1614
* and tangent direction/length at their endpoints. The constructor expands those into
@@ -99,10 +97,7 @@ class CubicBezier : public ParametricPath {
9997
/**
10098
* @brief Computes the first derivative dP/dt at parameter t.
10199
*
102-
* The derivative is given by:
103-
* \f[
104100
* P'(t) = 3(1-t)^2 (c_1 - c_0) + 6(1-t)t (c_2 - c_1) + 3t^2 (c_3 - c_2)
105-
* \f]
106101
*
107102
* @param t Normalized parameter ∈ [0, 1].
108103
* @return Velocity vector (meters per unit t).
@@ -112,10 +107,7 @@ class CubicBezier : public ParametricPath {
112107
/**
113108
* @brief Computes the second derivative d²P/dt² at parameter t.
114109
*
115-
* The expression is:
116-
* \f[
117110
* P''(t) = 6(1-t)(c_2 - 2c_1 + c_0) + 6t(c_3 - 2c_2 + c_1)
118-
* \f]
119111
*
120112
* @param t Normalized parameter ∈ [0, 1].
121113
* @return Acceleration vector (meters per unit t²).

0 commit comments

Comments
 (0)