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

Improve the documentation for UsdSkelRoot #2695

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

cameronwhite
Copy link
Contributor

Description of Change(s)

These are a couple fixes and improvements to the SkelRoot docs, from https://forum.aousd.org/t/getting-different-results-with-computeworldbound-for-when-root-is-xform-vs-skelroot/409

  • Document that SkelRoot has an extent computation which is used when the extents are not authored, and add a recommendation that the extents should be pre-authored for better performance.

  • Fix incorrect code snippet, which used UsdGeomTransform rather than UsdGeomXform. For C++ code, UsdSkel.Root was also incorrect and should be just UsdSkelRoot

Fixes Issue(s)

N/A

  • I have verified that all unit tests pass with the proposed changes
  • I have submitted a signed Contributor License Agreement

- Document that SkelRoot has an extent computation which is used when
  the extents are not authored, and add a recommendation that the
  extents should be pre-authored for better performance.

- Fix incorrect code snippet, which used `UsdGeomTransform` rather than
  `UsdGeomXform`. For C++ code, `UsdSkel.Root` was also incorrect and
  should be just `UsdSkelRoot`
@jesschimein
Copy link
Contributor

Filed as internal issue #USD-8709

@pixar-oss pixar-oss merged commit f02c6da into PixarAnimationStudios:dev Jul 26, 2024
34 of 36 checks passed
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.

3 participants