Tutorial loading physics plugin #115
Merged
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
Signed-off-by: anindex <[email protected]>
tutorials/05_plugin_loading.md
Outdated
| be used in our code. After the `std` C++ libraries are the `Loader.hh` and | ||
| `PluginPtr.hh`, which provides main functionalities for loading physics plugins | ||
| and plugin pointers. Next includes from \ref ignition::physics are the tools for | ||
| retrieving "Features" and "Entities" from physics plugins. |
There was a problem hiding this comment.
Provide definitions for Features and Entities, FeaureLists, linking to content in this section https://github.com/ignitionrobotics/ign-physics/blame/main/tutorials/03_physics_plugins.md#L16
tutorials/05_plugin_loading.md
Outdated
|
|
||
| Assuming the correct path, our loader will instantiate all plugins that are | ||
| available in the path using @ref ignition::plugin::Loader::Instantiate member function. Then for each instantiated plugin, it will request an engine | ||
| using @ref ignition::physics::RequestEngine3d<Features>::From function. |
There was a problem hiding this comment.
worth explaining/linking to the definition of FeaturePolicy https://github.com/ignitionrobotics/ign-physics/blame/main/tutorials/03_physics_plugins.md#L36 here, since features can be 2d or 3d or any custom dimensions
tutorials/05_plugin_loading.md
Outdated
| } | ||
| ``` | ||
|
|
||
| ### Example setup CMakeLists.txt file for Dome release |
There was a problem hiding this comment.
We could add a link to CMake tutorials https://cmake.org/cmake/help/latest/guide/tutorial/index.html to provide extra clarity and resource
tutorials/05_plugin_loading.md
Outdated
|
|
||
| ### Load existing plugins | ||
|
|
||
| For example, if you have the Ignition Physics plugin for DART compiled, find |
There was a problem hiding this comment.
DART can point to either the repo or a documentation related to the physics engine just so user can have more context
tutorials/05_plugin_loading.md
Outdated
| ### Load existing plugins | ||
|
|
||
| For example, if you have the Ignition Physics plugin for DART compiled, find | ||
| where it is installed with (you may need sudo right): |
There was a problem hiding this comment.
Suggested change
| where it is installed with (you may need sudo right): | |
| where it is installed with (you may need administrative rights: `sudo` on Linux platform): |
tutorials/05_plugin_loading.md
Outdated
| engine name: dartsim-6.10.0 | ||
| ``` | ||
|
|
||
| At the time of writing, Ignition Physics is shipped with `DART` and `TPE` |
There was a problem hiding this comment.
again, links to each physics engine repo/documentation
Signed-off-by: anindex <[email protected]>
…ndex/ign-physics into tutorials-hello-world-loader
claireyywang
added a commit
that referenced
this pull request
Jan 7, 2021
* Initial draft for loading plugin tutorial Signed-off-by: anindex <[email protected]> * Resolve comments Signed-off-by: anindex <[email protected]> Co-authored-by: anindex <[email protected]> Co-authored-by: Louise Poubel <[email protected]> Co-authored-by: Claire Wang <[email protected]>
claireyywang
added a commit
that referenced
this pull request
Jan 7, 2021
* Initial draft for loading plugin tutorial Signed-off-by: anindex <[email protected]> * Resolve comments Signed-off-by: anindex <[email protected]> Co-authored-by: anindex <[email protected]> Co-authored-by: Louise Poubel <[email protected]> Co-authored-by: Claire Wang <[email protected]>
chapulina
added a commit
that referenced
this pull request
Jan 21, 2021
* Initial draft for loading plugin tutorial Signed-off-by: anindex <[email protected]> * Resolve comments Signed-off-by: anindex <[email protected]> Co-authored-by: anindex <[email protected]> Co-authored-by: Louise Poubel <[email protected]> Co-authored-by: Claire Wang <[email protected]>
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.
Signed-off-by: anindex [email protected]