Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Finish renaming cubic splines #10258

Closed
alice-i-cecile opened this issue Oct 25, 2023 · 2 comments · Fixed by #10299
Closed

Finish renaming cubic splines #10258

alice-i-cecile opened this issue Oct 25, 2023 · 2 comments · Fixed by #10299
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Code-Quality A section of code that is hard to understand or change D-Trivial Nice and easy! A great choice to get started with Bevy
Milestone
0.12

Comments

@alice-i-cecile
Copy link
Member 

          @alice-i-cecile Shouldn't this be done for all the cubic splines, not just one of them? This makes the spline naming inconsistent.

https://docs.rs/bevy/0.11.3/bevy/math/cubic_splines/index.html

Originally posted by @aevyrie in #9554 (comment)
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy C-Code-Quality A section of code that is hard to understand or change A-Math Fundamental domain-agnostic mathematical operations labels Oct 25, 2023
@aevyrie
Copy link
Member

aevyrie commented Oct 28, 2023

Would it make sense to revert that change prior to 0.12? If anything, it's made the API more confusing. Previously, all the Cubic types were the generic spline types that end users would use to generate points, etc. Now there is a Bezier type that shares this name, unlike all the other cubic spline generators.

@alice-i-cecile
Copy link
Member Author

Yep, I would like to see this API consistent, one way or another, for 0.12.

@alice-i-cecile alice-i-cecile added this to the 0.12 milestone Oct 28, 2023
@aevyrie aevyrie mentioned this issue Oct 28, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Oct 28, 2023
@aevyrie
Add Cubic prefix to all cubic curve generators (#10299)
9d088dd 
# Objective

- Fixes #10258 

## Solution

- Renamed.

---

## Changelog

- Changed: `BSpline` -> `CubicBSpline`
- Changed: `CardinalSpline` -> `CubicCardinalSpline`
- Changed: `Hermite` -> `CubicHermite`

## Migration Guide

- Rename: `BSpline` -> `CubicBSpline`
- Rename: `CardinalSpline` -> `CubicCardinalSpline`
- Rename: `Hermite` -> `CubicHermite`
ameknite pushed a commit to ameknite/bevy that referenced this issue Nov 6, 2023
@aevyrie @ameknite
Add Cubic prefix to all cubic curve generators (bevyengine#10299)
bd9d0cd 
# Objective

- Fixes bevyengine#10258 

## Solution

- Renamed.

---

## Changelog

- Changed: `BSpline` -> `CubicBSpline`
- Changed: `CardinalSpline` -> `CubicCardinalSpline`
- Changed: `Hermite` -> `CubicHermite`

## Migration Guide

- Rename: `BSpline` -> `CubicBSpline`
- Rename: `CardinalSpline` -> `CubicCardinalSpline`
- Rename: `Hermite` -> `CubicHermite`
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this issue Jan 9, 2024
@aevyrie
Add Cubic prefix to all cubic curve generators (bevyengine#10299)
94afda0 
# Objective

- Fixes bevyengine#10258 

## Solution

- Renamed.

---

## Changelog

- Changed: `BSpline` -> `CubicBSpline`
- Changed: `CardinalSpline` -> `CubicCardinalSpline`
- Changed: `Hermite` -> `CubicHermite`

## Migration Guide

- Rename: `BSpline` -> `CubicBSpline`
- Rename: `CardinalSpline` -> `CubicCardinalSpline`
- Rename: `Hermite` -> `CubicHermite`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Code-Quality A section of code that is hard to understand or change D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
0.12
Development

Successfully merging a pull request may close this issue.

Add Cubic prefix to all cubic curve generators aevyrie/bevy
2 participants
@aevyrie @alice-i-cecile