feat: adding coordinate system to docs #244
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Eric-Vin
reviewed
Apr 27, 2024
There was a problem hiding this comment.
Looks great overall! A few comments:
- We should probably adjust the Orientation entry now that we have this page, maybe cleaning it up a little and linking to the coordinate systems page.
- It doesn't look like this page is available in the sidebar. Maybe we should add it under Language Reference?
- We might want to instruct users on how to manually compose rotations, i.e. that A followed by B is
A*B, which is the opposite of typical quaternions since we're using intrinsic angles. See here for more details. @dfremont any thoughts on this?
|
|
||
| 1. The :specifier:`on {region}` specifier specifies :prop:`parentOrientation` whenever the region in question has a :term:`preferred orientation`: a `vector field` (another primitive Scenic type) which defines an orientation at each point in the region. | ||
| 2. The :specifier:`ahead of` specifier only specifies :prop:`parentOrientation` *optionally*, giving it a new default value: if you want a different value, you can override that default by explicitly writing :specifier:`with parentOrientation {value}`. | ||
| 3. The general operator :scenic:`{X} relative to {Y}` can interpret vectors and orientations as being in a variety of local coordinate systems |
There was a problem hiding this comment.
We should add more detail here and/or link to the specifier page, since this specifier can be particularly confusing. Specifically, tuple syntax (e.g. (3,3,3)) are interpreted as Vectors, and can give un-intiuitive results. See here for more details.
| If you want to specify an objects coordinate system relative to other objects, there are specifiers for the :prop:`orientation` to do so. | ||
|
|
||
| 1. The :specifier:`on {region}` specifier specifies :prop:`parentOrientation` whenever the region in question has a :term:`preferred orientation`: a `vector field` (another primitive Scenic type) which defines an orientation at each point in the region. | ||
| 2. The :specifier:`ahead of` specifier only specifies :prop:`parentOrientation` *optionally*, giving it a new default value: if you want a different value, you can override that default by explicitly writing :specifier:`with parentOrientation {value}`. |
There was a problem hiding this comment.
Maybe we can generalize this? I think most position specifiers can optionally specify parentOrientation at level 3, and on does it at level 2.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As discussed, there is a need to have a single page describing the Scenic coordinate system.
Issue Link
N/A
Checklist
pytestand/or other meansAdditional Notes