JuliaGeometry / JuliaGeometry/Rotations.jl
rename `AngleAxis` to `AxisAngle`?
Open
Nobody has claimed this yet.
v2.0.0
- Dominant language
- Julia
- Stars
- 188
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
As discussed in #210, it's better to follow the order of SVector.
julia> aa = AngleAxis(2.4, 0, 0, 1) # angle, x, y, z
3×3 AngleAxis{Float64} with indices SOneTo(3)×SOneTo(3)(2.4, 0.0, 0.0, 1.0):
-0.737394 -0.675463 0.0
0.675463 -0.737394 0.0
0.0 0.0 1.0
julia> Rotations.params(aa).z # this should be 1
0.0
julia> Rotations.params(aa).w # this should be 2.4
1.0
If we change the order from (theta, axis_x, axis_y, axis_z) to (axis_x, axis_y, axis_z, theta) (or just (x,y,z,angle)), then the name of the type should be changed to AxisAngle.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review issue #210 and locate the AngleAxis type and the Rotations.params entry point. Determine whether the intended change is the parameter-order change, the AxisAngle rename, or both; done means the decision and affected API behavior are reflected consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- computer-graphics
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100