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.

Sign up for GitHub

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

Jump to bottom

--Documentation for ArticulatedObjectAttributes and PbrShaderAttributes and JSON configurations. #2237

Merged
merged 4 commits into from
Oct 12, 2023
Merged

--Documentation for ArticulatedObjectAttributes and PbrShaderAttributes and JSON configurations. #2237

merged 4 commits into from
Oct 12, 2023

Conversation

jturner65
Copy link
Contributor

Motivation and Context

This PR augments the Attributes docs page with field-level descriptions for the ArticulatedObjectAttributes/.ao_config.json and PbrShaderAttributes/.pbr_config.json configuration structures/files.

How Has This Been Tested

Locally c++ and python tests pass. Docs seem to build

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Oct 11, 2023
@jturner65 jturner65 requested review from aclegg3 and 0mdc October 11, 2023 21:21
aclegg3
aclegg3 approved these changes Oct 11, 2023
View reviewed changes
Copy link
Contributor

@aclegg3 aclegg3 left a comment

Choose a reason for hiding this comment

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

Thanks! :)

0mdc
0mdc approved these changes Oct 12, 2023
View reviewed changes
Copy link
Contributor

@0mdc 0mdc left a comment

Choose a reason for hiding this comment

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

This is great! Thank you!

docs/pages/attributesJSON.rst Outdated
- Specifies the possible options for what will be rendered for the articulated object this configuration instantiates. Default value is "default".
- "default" : Render the articulated object using its skin if it has one, otherwise render it using the urdf-defined link meshes/primitives.
- "skin" : Render the articulated object using its skin.
- "link_visuals" : Render the articulated object using urdf-defined meshes/primitives to respresent each link.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: respresent

@jturner65 jturner65 merged commit 87acc0e into main Oct 12, 2023
1 check passed
@jturner65 jturner65 deleted the AO_PBR_Config_Docs branch October 12, 2023 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0mdc 0mdc 0mdc approved these changes

@aclegg3 aclegg3 aclegg3 approved these changes

Assignees
No one assigned
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jturner65 @aclegg3 @0mdc @facebook-github-bot