Skip to content

fix: use spatialgeometry's renamed Polyline instead of deprecated Path #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
petercorke merged 1 commit into from
Aug 9, 2026
Merged

fix: use spatialgeometry's renamed Polyline instead of deprecated Path #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/swift/public/js/shapes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,11 @@ function loadAxes(part, scene, cb) {
}

/**
* spatialgeometry.Path: a polyline through a sequence of waypoints --
* straight segments joining consecutive points, not a smoothed curve.
* spatialgeometry.Polyline (renamed from Path to avoid clashing with
* pathlib.Path -- jhavl/spatialgeometry#42; the wire-protocol stype
* string below deliberately stayed "path", see the dispatch site in
* load()): a polyline through a sequence of waypoints -- straight
* segments joining consecutive points, not a smoothed curve.
* radius == 0 renders as a single screen-space-width Line2 (mirrors
* Arrow's line-mode shaft, connecting every point in sequence); radius > 0
* renders as a real tube built from a CurvePath of straight LineCurve3
Expand Down Expand Up @@ -477,6 +480,10 @@ function load(part, scene, cb, errCb) {
else if (["cuboid", "box", "sphere", "cylinder", "ellipsoid"].includes(part.stype)) loadPrimitive(part, scene, cb);
else if (part.stype === "axes") loadAxes(part, scene, cb);
else if (part.stype === "arrow") loadArrow(part, scene, cb);
// "path" is spatialgeometry.Polyline's stype (not "polyline") -- the
// Python class was renamed (avoids clashing with pathlib.Path), but
// the wire string deliberately wasn't, to avoid a breaking protocol
// change for a rename that's purely cosmetic on the Python side.
else if (part.stype === "path") loadPath(part, scene, cb);
else {
const reason = `unsupported shape type '${part.stype}'`;
Expand Down
8 changes: 7 additions & 1 deletion tests/test_protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,13 @@ def test_add_path_sends_points_radius_and_linewidth():
browser = FakeBrowser(env, responses=["0", json.dumps([1, None])])

points = np.array([[0.0, 1.0, 2.0], [0.0, 0.0, 0.0], [0.0, 0.0, 0.0]])
path = sg.Path(points, radius=0.02, linewidth=2.0, color=[1.0, 0.0, 0.0, 1.0])
# spatialgeometry renamed the Python class Path -> Polyline (avoids
# clashing with pathlib.Path -- see jhavl/spatialgeometry#42), but
# deliberately left the wire-protocol stype string as "path" --
# changing that too would be a breaking protocol change requiring a
# matching shapes.js update, for a rename that's purely cosmetic on
# the Python side.
path = sg.Polyline(points, radius=0.02, linewidth=2.0, color=[1.0, 0.0, 0.0, 1.0])
env.add(path)

_, shape_data = browser.received[0]
Expand Down
Loading