Particle emitter - part3 #117

caguero · 2020-07-24T16:48:41Z

Here's the particle implementation for Ogre2.

Open questions:

SetMaterial(): Right now, we create an unlit internal material because this is the type that seems to work with the particle system. Then, when we call ParticleEmitter::SetMaterial() we should copy some of the properties of the material. I think Unlit and PBS don't share the same attributes. Should we copy the common ones? Maybe at least the texture?

Reference: https://ogrecave.github.io/ogre/api/2.1/class_ogre_1_1_hlms_unlit_datablock.html
This PR doesn't implement the SetType() and SetEmitterSize() yet because the default particle emitters are contained inside the ParticleFX Ogre2 plugin. I don't think our FindIgnRendering for Ignition CMake is ready to use this plugin. Did anyone has experience using ParticleFX?

How to test it? Compile the particles_demo example and run it. You should see something similar to this:

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

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

iche033 · 2020-07-25T01:22:42Z

I made some changes in 2eb5cc2. Materials / textures should work now.

iche033 · 2020-07-27T21:48:22Z

looked a little bit into loading ParticleFX plugin. The ~/.ignition/rendering/ogre2.log shows that the ParticleFX plugin is loaded. Did you have a linker error? We're not linking against it since it's a plugin. Could you push the changes you have for setting type and emitter size to a different branch?

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

This reverts commit e9ba80a.

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

caguero · 2020-07-27T22:50:32Z

looked a little bit into loading ParticleFX plugin. The ~/.ignition/rendering/ogre2.log shows that the ParticleFX plugin is loaded. Did you have a linker error? We're not linking against it since it's a plugin. Could you push the changes you have for setting type and emitter size to a different branch?

I created a minimum example in the particles_part3_affectors branch. It instantiates one of the default affectors defined in /usr/include/OGRE-2.1/Plugins/ParticleFX/OgreColourImageAffector.h. The code seems to compile but when running the example I get an undefined symbol error:

Error while loading the library [/usr/lib/x86_64-linux-gnu/libignition-rendering4-ogre2.so]: /usr/lib/x86_64-linux-gnu/libignition-rendering4-ogre2.so: undefined symbol: _ZTIN4Ogre19ColourImageAffectorE

Here's extra info:

nm -D /usr/lib/x86_64-linux-gnu/OGRE-2.1/OGRE/Plugin_ParticleFX.so | grep ColourImageAffector | grep _ZTIN4Ogre19ColourImageAffectorE
0000000000236dd8 V _ZTIN4Ogre19ColourImageAffectorE

Maybe I'm using it wrong...

caguero · 2020-07-27T23:24:14Z

looked a little bit into loading ParticleFX plugin. The ~/.ignition/rendering/ogre2.log shows that the ParticleFX plugin is loaded. Did you have a linker error? We're not linking against it since it's a plugin. Could you push the changes you have for setting type and emitter size to a different branch?

I created a minimum example in the particles_part3_affectors branch. It instantiates one of the default affectors defined in /usr/include/OGRE-2.1/Plugins/ParticleFX/OgreColourImageAffector.h. The code seems to compile but when running the example I get an undefined symbol error:
Error while loading the library [/usr/lib/x86_64-linux-gnu/libignition-rendering4-ogre2.so]: /usr/lib/x86_64-linux-gnu/libignition-rendering4-ogre2.so: undefined symbol: _ZTIN4Ogre19ColourImageAffectorE
Here's extra info:
nm -D /usr/lib/x86_64-linux-gnu/OGRE-2.1/OGRE/Plugin_ParticleFX.so | grep ColourImageAffector | grep _ZTIN4Ogre19ColourImageAffectorE
0000000000236dd8 V _ZTIN4Ogre19ColourImageAffectorE
Maybe I'm using it wrong...

It seems that the affectors are supposed to be used in a different way. See the next block:

Ogre::ParticleAffector *plane = this->dataPtr->ps->addAffector("DeflectorPlane");
  plane->setParameter("plane_point", "0 -50 0");
  plane->setParameter("plane_normal", "0 1 0");
  plane->setParameter("bounce", "1");

(Using the base class with setParameter)

caguero · 2020-07-27T23:29:22Z

looked a little bit into loading ParticleFX plugin. The ~/.ignition/rendering/ogre2.log shows that the ParticleFX plugin is loaded. Did you have a linker error? We're not linking against it since it's a plugin. Could you push the changes you have for setting type and emitter size to a different branch?

I created a minimum example in the particles_part3_affectors branch. It instantiates one of the default affectors defined in /usr/include/OGRE-2.1/Plugins/ParticleFX/OgreColourImageAffector.h. The code seems to compile but when running the example I get an undefined symbol error:
Error while loading the library [/usr/lib/x86_64-linux-gnu/libignition-rendering4-ogre2.so]: /usr/lib/x86_64-linux-gnu/libignition-rendering4-ogre2.so: undefined symbol: _ZTIN4Ogre19ColourImageAffectorE
Here's extra info:
nm -D /usr/lib/x86_64-linux-gnu/OGRE-2.1/OGRE/Plugin_ParticleFX.so | grep ColourImageAffector | grep _ZTIN4Ogre19ColourImageAffectorE
0000000000236dd8 V _ZTIN4Ogre19ColourImageAffectorE
Maybe I'm using it wrong...
It seems that the affectors are supposed to be used in a different way. See the next block:
Ogre::ParticleAffector *plane = this->dataPtr->ps->addAffector("DeflectorPlane");
  plane->setParameter("plane_point", "0 -50 0");
  plane->setParameter("plane_normal", "0 1 0");
  plane->setParameter("bounce", "1");
(Using the base class with setParameter)

I think I figured it out, I'll update the PR with new changes.

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

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

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

caguero · 2020-07-28T23:06:52Z

@iche033, all API calls should be implemented in Ogre2 now. Could you take another look please?

iche033

looking good! Just a comment about setting type. Others are minor

iche033 · 2020-07-28T23:52:40Z

include/ignition/rendering/ParticleEmitter.hh

+      /// the image is used.
+      /// \param[in] _image The color image name.
+      /// \sa ColorImage
+      public: virtual void SetColorImage(const std::string &_image) = 0;


What do you think about calling this SetColorRangeImage. It's doing something very similar to SetColorRange but from an image. Another reason is to avoid confusion with setting the actual particle texture that they supplied when calling SetMaterial

I also noticed that this overrides SetColorRange and vice versa depending on which function is called last. Maybe we can add that to the documentation.

It makes sense. It would even make more sense to overload the functions but C++ doesn't allow us to overload two functions just based on the return value :/ 571a08f.

iche033 · 2020-07-28T23:54:17Z

ogre2/src/Ogre2ParticleEmitter.cc

+  public: Ogre::ParticleEmitter *emitter = nullptr;
+
+  // \brief Ogre colour image affector.
+  public: Ogre::ParticleAffector *colourImageAffector = nullptr;


should we keep spelling consistent with others in ign? i.e. colour -> color. No strong opinion here since the public API uses color which is consistent.

Done in 571a08f. We have to be careful with the strings passed to Ogre because they need to be "colour".

iche033 · 2020-07-29T00:04:46Z

ogre2/src/Ogre2ParticleEmitter.cc

+  {
+    case EmitterType::EM_POINT:
+    {
+      this->dataPtr->ps->removeAllEmitters();


I think with the remove call here, calling SetType will remove existing emitter settings, e.g. size, duration, rate, etc?

Oh that was a bug, good catch. Fixed in 571a08f.

In order to make it work, we now keep an array of emitters, one of each supported type. When an attribute is set, we set it in each emitter but only one is visible at a time. When the function SetType() is called we switch to the appropriate emitter.

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

caguero · 2020-07-29T17:16:09Z

I think this is ready for prime time, I'm removing the draft part. Maybe I can create a tutorial in another PR.

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

iche033 · 2020-07-30T20:49:16Z

made a couple of updates in fa3c8e4

added Destroy function to clean up the particle emitter
also added the color image texture path to ogre resource manager. Needed when the texture is stored in a directory different from the Ogre2Material texture.

iche033 · 2020-07-30T20:50:40Z

There are a couple of expectations failing when running the test with ogre2, e.g.

RENDER_ENGINE_VALUES=ogre2 ./build/ignition-rendering4/bin/UNIT_ParticleEmitter_TEST

I think it is failing because the values are invalid and so they are never set. Could you take a look?

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

caguero · 2020-07-30T21:48:07Z

made a couple of updates in fa3c8e4

added Destroy function to clean up the particle emitter

also added the color image texture path to ogre resource manager. Needed when the texture is stored in a directory different from the Ogre2Material texture.

Thanks!

caguero · 2020-07-30T21:48:38Z

There are a couple of expectations failing when running the test with ogre2, e.g.
RENDER_ENGINE_VALUES=ogre2 ./build/ignition-rendering4/bin/UNIT_ParticleEmitter_TEST
I think it is failing because the values are invalid and so they are never set. Could you take a look?

Fixed in 9ac9812.

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

iche033 · 2020-07-30T22:50:04Z

there is a minor issue with DCO, otherwise looks good!

caguero added 3 commits July 20, 2020 17:07

Particles demo boilerplate.

d899799

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

Style

8fb7062

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

Better particle emitter demo and custom material.

85c1c07

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

github-actions bot added the 🔮 dome Ignition Dome label Jul 24, 2020

osrf-triage added this to Inbox in Core development Jul 24, 2020

texture working

2eb5cc2

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

caguero moved this from Inbox to In review in Core development Jul 27, 2020

chapulina requested a review from iche033 July 27, 2020 18:05

caguero added 3 commits July 28, 2020 00:42

Testing ColourImage affector.

e9ba80a

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

Revert "Testing ColourImage affector."

e26c55e

This reverts commit e9ba80a.

Trying to use ColourImage affector.

9c7c50f

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

caguero and others added 3 commits July 28, 2020 01:38

Emitters working

56396a2

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

test fixing particle alpha

dfc28f2

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

Add affectors and tweaks

4b4b087

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

iche033 reviewed Jul 29, 2020

View reviewed changes

Replace ColorImage with ColorRangeImage and other tweaks.

571a08f

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

caguero marked this pull request as ready for review July 29, 2020 17:16

cleanup, add resource search path

fa3c8e4

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

Fix tests

9ac9812

Signed-off-by: Carlos Aguero <caguero@openrobotics.org>

fix homebrew warnings

648ead7

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

iche033 approved these changes Jul 30, 2020

View reviewed changes

caguero merged commit 8bb934d into master Jul 30, 2020

Core development automation moved this from In review to Done Jul 30, 2020

caguero deleted the particles_part3 branch July 30, 2020 22:51

j-rivero removed this from Done in Core development May 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Particle emitter - part3 #117

Particle emitter - part3 #117

caguero commented Jul 24, 2020 •

edited

iche033 commented Jul 25, 2020 •

edited

iche033 commented Jul 27, 2020

caguero commented Jul 27, 2020 •

edited

caguero commented Jul 27, 2020 •

edited

caguero commented Jul 27, 2020

caguero commented Jul 28, 2020

iche033 left a comment

iche033 Jul 28, 2020

caguero Jul 29, 2020

iche033 Jul 28, 2020

caguero Jul 29, 2020

iche033 Jul 29, 2020

caguero Jul 29, 2020 •

edited

caguero commented Jul 29, 2020 •

edited

iche033 commented Jul 30, 2020

iche033 commented Jul 30, 2020

caguero commented Jul 30, 2020

caguero commented Jul 30, 2020

iche033 commented Jul 30, 2020

Particle emitter - part3 #117

Particle emitter - part3 #117

Conversation

caguero commented Jul 24, 2020 • edited

iche033 commented Jul 25, 2020 • edited

iche033 commented Jul 27, 2020

caguero commented Jul 27, 2020 • edited

caguero commented Jul 27, 2020 • edited

caguero commented Jul 27, 2020

caguero commented Jul 28, 2020

iche033 left a comment

Choose a reason for hiding this comment

iche033 Jul 28, 2020

Choose a reason for hiding this comment

caguero Jul 29, 2020

Choose a reason for hiding this comment

iche033 Jul 28, 2020

Choose a reason for hiding this comment

caguero Jul 29, 2020

Choose a reason for hiding this comment

iche033 Jul 29, 2020

Choose a reason for hiding this comment

caguero Jul 29, 2020 • edited

Choose a reason for hiding this comment

caguero commented Jul 29, 2020 • edited

iche033 commented Jul 30, 2020

iche033 commented Jul 30, 2020

caguero commented Jul 30, 2020

caguero commented Jul 30, 2020

iche033 commented Jul 30, 2020

caguero commented Jul 24, 2020 •

edited

iche033 commented Jul 25, 2020 •

edited

caguero commented Jul 27, 2020 •

edited

caguero commented Jul 27, 2020 •

edited

caguero Jul 29, 2020 •

edited

caguero commented Jul 29, 2020 •

edited