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

[Citadel] Physics Plugin Documentation #36

Merged
merged 21 commits into from
Apr 30, 2020

Conversation

claireyywang
Copy link
Contributor

@claireyywang claireyywang commented Apr 17, 2020

This doc focuses on a couple of things about Ignition Physics

  • Brief intro to ignition physics library
  • High level concept of how physics plugin works
  • Explanation of terminology used in plugin implementation
  • Functional differences among dart, tpe
  • Entity and feature comparison among dartsim and tpe-plugin

The goal is to help users choose which physics engine to use, and gain insight in how physics plugins works and is implemented, thus also prepare them to write their own plugin.

I decided to remove Bullet from doc since it is unlikely to be merged before Blueprint EOL.

@claireyywang claireyywang added the documentation Improvements or additions to documentation label Apr 17, 2020
@claireyywang claireyywang requested review from azeey and scpeters April 17, 2020 22:44
@claireyywang claireyywang self-assigned this Apr 17, 2020
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

Thanks for writing this. I made some minor comments, but looks great overall.


#### Feature Comparison

The following is a table of implemented `Features` of Dartsim and TPE-Plugin.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following is a table of implemented `Features` of Dartsim and TPE-Plugin.
The following is a table of implemented `Features` of Dartsim, TPE-Plugin, and Bullet.


| Features | Dartsim | TPE-Plugin | Bullet |
|:-:|:-:|:-:|:-:|
| Base | ✓ | ✓ | ✓ |
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think Base is a feature.

| Features | Dartsim | TPE-Plugin | Bullet |
|:-:|:-:|:-:|:-:|
| Base | ✓ | ✓ | ✓ |
| RetrieveWorld | ✓ | ✓ | ✕ |
Copy link
Contributor

Choose a reason for hiding this comment

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

RetrieveWorld is a DART specific (maybe also TPE specific) feature used for testing internally. I'm not sure if it should be mentioned here.

| Frame | Frame | N/A | N/A |
| Model | Skeleton | Model | MultiBody |
| Joint | Joint | N/A | MultiBodyJoint |
| Link | BodyNode | Link | Scalar |
Copy link
Contributor

Choose a reason for hiding this comment

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

I think our bullet implementation does not use any specific class for links since we just index into a MultiBody. Is this what you mean by Scalar?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I got Scalar from the bullet engine source code. Should I change this to N/A then?

@claireyywang claireyywang merged commit c4fc9c2 into ign-physics2 Apr 30, 2020
@claireyywang claireyywang deleted the dart_tpe_feature_doc branch April 30, 2020 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants