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

Add Custom Render Plugin Example #154

Merged
merged 16 commits into from
Oct 13, 2020

Conversation

JShep1
Copy link

@JShep1 JShep1 commented Oct 1, 2020

The last piece to getting the custom render engine issue (#100) resolved.

This example simply adds a mock render engine plugin that the user can load with --render-engine HelloWorldPlugin, it won't display anything to the scene as there is actually no implementation, this just serves as a template for any future user desiring to write their own render engine plugin.

Signed-off-by: John Shepherd john@openrobotics.org

Depends on gazebosim/gz-sim#373

John Shepherd added 5 commits September 23, 2020 14:29
Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
@osrf-triage osrf-triage added this to Inbox in Core development Oct 1, 2020
Signed-off-by: John Shepherd <john@openrobotics.org>
@chapulina chapulina moved this from Inbox to In progress in Core development Oct 1, 2020
@iche033
Copy link
Contributor

iche033 commented Oct 1, 2020

The changes here allows the plugin to load in the ign-rendering side. It's now just failing in RenderUtil on the in-gazebo side since there are several places that assume a non-null scene..

@JShep1
Copy link
Author

JShep1 commented Oct 1, 2020

The changes here allows the plugin to load in the ign-rendering side. It's now just failing in RenderUtil on the in-gazebo side since there are several places that assume a non-null scene..

Can you make the PR? Mainly so I can approve. Also, I made an additional PR for ign-gazebo here adding additional null checks. I'm still getting a seg fault when attempting to run the mock render engine plugin, and gdb actually isn't helpful at all so I'm trying to figure out where exactly is occurring.

I found where the seg faults were occurring in Scene3D, I'm getting a successfully loaded plugin displaying a blank screen now. I also accidentally added to your branch thinking this one was currently checked out 😅

@JShep1 JShep1 marked this pull request as ready for review October 1, 2020 08:04
@JShep1 JShep1 requested a review from iche033 as a code owner October 1, 2020 08:04
@iche033
Copy link
Contributor

iche033 commented Oct 1, 2020

created pull request #156 containing the null checks, and your changes :)

iche033 and others added 4 commits October 1, 2020 12:10
Add null checks and docs

Signed-off-by: Ian Chen <ichen@osrfoundation.org>

Co-authored-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
…_binary_name_support

Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
@JShep1
Copy link
Author

JShep1 commented Oct 1, 2020

This is ready for a review whenever you have time. @iche033

Copy link
Contributor

@iche033 iche033 left a comment

Choose a reason for hiding this comment

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

Nice it's working for me! I am able load the hello world plugin following the instructions in the README.md. Just some minor style and doc comments

examples/hello_world_plugin/HelloWorldPlugin.cc Outdated Show resolved Hide resolved
examples/hello_world_plugin/HelloWorldPlugin.cc Outdated Show resolved Hide resolved
examples/hello_world_plugin/README.md Outdated Show resolved Hide resolved
@chapulina chapulina added the 🏰 citadel Ignition Citadel label Oct 3, 2020
@chapulina chapulina moved this from In progress to In review in Core development Oct 5, 2020
Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
Base automatically changed from jshep1/add_engine_binary_name_support to ign-rendering3 October 12, 2020 17:46
@codecov
Copy link

codecov bot commented Oct 12, 2020

Codecov Report

Merging #154 into ign-rendering3 will increase coverage by 0.03%.
The diff coverage is 75.00%.

Impacted file tree graph

@@                Coverage Diff                 @@
##           ign-rendering3     #154      +/-   ##
==================================================
+ Coverage           50.44%   50.48%   +0.03%     
==================================================
  Files                 129      129              
  Lines               11709    11740      +31     
==================================================
+ Hits                 5907     5927      +20     
- Misses               5802     5813      +11     
Impacted Files Coverage Δ
src/base/BaseRenderEngine.cc 73.80% <75.00%> (-4.09%) ⬇️
...e/ignition/rendering/base/BaseGaussianNoisePass.hh 100.00% <0.00%> (+3.33%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ce57034...35a3c5b. Read the comment docs.

Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

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

👍

src/base/BaseRenderEngine.cc Outdated Show resolved Hide resolved
John Shepherd added 2 commits October 13, 2020 10:53
…/ignitionrobotics/ign-rendering into jshep1/add_custom_plugin_example

Signed-off-by: John Shepherd <john@openrobotics.org>
Signed-off-by: John Shepherd <john@openrobotics.org>
@JShep1 JShep1 merged commit 8876d6a into ign-rendering3 Oct 13, 2020
Core development automation moved this from In review to Done Oct 13, 2020
@JShep1 JShep1 deleted the jshep1/add_custom_plugin_example branch October 13, 2020 20:57
@j-rivero j-rivero removed this from Done in Core development May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants