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.

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

EXT_mesh_features: Language and clarity updates #21

Conversation

donmccurdy
Copy link

See rendered markdown preview.

This PR does not include any (intentional) technical changes, but does specify some restrictions that were probably intended but not previously explicit. I've updated terminology in the illustrations, but haven't altered illustrations much otherwise. I've tried to introduce concepts "in order", but early references to later topics are necessary in a few places and I've tried to include links accordingly.

Written descriptions of properties are not exhaustive — hopefully this is a good balance of providing enough detail without duplicating content from the Core Metadata specification. Each section now links to a schema file, which does include exhaustive property references.

@donmccurdy
Copy link
Author

/cc @lilleyse @ptrgags a bit delayed, but here's where I've gotten with the language/clarity pass on EXT_mesh_features.

@donmccurdy
Copy link
Author

A number of helpful comments in #4 as well — I think many are covered here, but the common themes are worth keeping in mind when reviewing:

  • try not to allude to things before defining them
  • use consistent terminology throughout (e.g. properties vs. metadata vs. information)
  • decouple the "why" from the "what/how"

Copy link

@ptrgags ptrgags left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@donmccurdy did a review pass. No major changes, mostly just minor wording tweaks.

extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
Co-authored-by: Peter Gagliardi <ptrgags@gmail.com>
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
Copy link
Author

@donmccurdy donmccurdy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed an update addressing most feedback – I went ahead and listed allowed values for type and componentType exhaustively in the "Class Properties" section, but left the other properties in the schema file out, trying to find the right balance there...

extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
@ptrgags
Copy link

ptrgags commented Oct 5, 2021

That was weird, I just refreshed the page and GH acted like I submitted the review? 🤷‍♂️ Oh well, @donmccurdy I was done making comments anyway, there's a few things to update and discuss

Copy link
Author

@donmccurdy donmccurdy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still need to implement the changes suggested in the last round, but wanted to go ahead and follow up on a couple of the comment threads that are still open.

/cc @ptrgags

extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
- Expand raster format description.
- Relax byte alignment requirements to match component size, not strictly 8-byte.
- Clarify that GPU instancing does not allow property textures at the node level.
Copy link
Author

@donmccurdy donmccurdy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest commits should address open comments — I've also added myself to the contributors section (happy to adjust that if needed though).

extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
extensions/2.0/Vendor/EXT_mesh_features/README.md Outdated Show resolved Hide resolved
Copy link

@ptrgags ptrgags left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@donmccurdy almost there, just a few last things. I think we can knock this out today

@ptrgags ptrgags deleted the branch CesiumGS:3d-tiles-next-rev October 11, 2021 18:25
@ptrgags ptrgags closed this Oct 11, 2021
@ptrgags
Copy link

ptrgags commented Oct 11, 2021

Whoops, looks like GH closed this automatically rather than updating the base branch...

@donmccurdy after making updates could you open a new PR?

Copy link
Author

@donmccurdy donmccurdy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining feedback addressed in a new PR, #25.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants