search

sourcebots / robot-api

(Legacy) API to interface with robotd
http://docs.sourcebots.co.uk/api/
MIT License
4 stars 1 forks source link

Improve the docstrings for polar co-ordinates #82

Closed Adimote closed 6 years ago

Adimote commented 6 years ago

Currently they're #TODOs

PeterJCLaw commented 6 years ago

The polar coordinates are deprecated and (deliberately) undocumented. I'm not sure I see the point in this?

PeterJCLaw commented 6 years ago

See https://github.com/sourcebots/docs/pull/67#discussion_r165389391 for the previous investigation into the current polar coordinates; I've summarised the interesting part below since I suspect that comment will be collapsed if you click through.

sb-vision's polar_x and polar_y are calculated by cartesian_to_polar and translate to rot_x... and rot_y... respectively on the robot-api side. These values are not really in the right pace to be used (they're the wrong side of the triangle) and they also express a "rotation along the {x,y} axis" rather than "rotation about the {x,y} axis".

vision-reference-current-polar-implementation

kierdavis commented 6 years ago

Oops, I assumed this PR was regarding spherical coordinates rather than polar when I looked over it earlier.

I concur with @PeterJCLaw here - now that spherical is shipped and polar is officially deprecated, why are we still caring about this?

Adimote commented 6 years ago

Good point, I're replaced them all with Deprecated