Particle emitter - part2 (#113)

* Particle emitter initial API.

Signed-off-by: Carlos Aguero <[email protected]>

* Tweaks

Signed-off-by: Carlos Aguero <[email protected]>

* Tweak

Signed-off-by: Carlos Aguero <[email protected]>

* CreateEmitterImpl() added.

Signed-off-by: Carlos Aguero <[email protected]>

* Register visuals

Signed-off-by: Carlos Aguero <[email protected]>

* Tweak default values

Signed-off-by: Carlos Aguero <[email protected]>

* Tweak

Signed-off-by: Carlos Aguero <[email protected]>

* Testing

Signed-off-by: Carlos Aguero <[email protected]>

* Tweak

Signed-off-by: Carlos Aguero <[email protected]>

* Remove src/ParticleEmitter.cc

Signed-off-by: Carlos Aguero <[email protected]>

* style changes

Signed-off-by: Ian Chen <[email protected]>

* Add getters and tweak SetColorRange().

Signed-off-by: Carlos Aguero <[email protected]>

* Remove [Set]LocalPose()

Signed-off-by: Carlos Aguero <[email protected]>

Co-authored-by: Ian Chen <[email protected]>

include/ignition/rendering/ParticleEmitter.hh

@@ -17,6 +17,9 @@
 #ifndef IGNITION_RENDERING_PARTICLEEMITTER_HH_
 #define IGNITION_RENDERING_PARTICLEEMITTER_HH_
 
+#include "ignition/math/Color.hh"
+#include "ignition/math/Pose3.hh"
+#include "ignition/math/Vector3.hh"
 #include "ignition/rendering/config.hh"
 #include "ignition/rendering/Export.hh"
 #include "ignition/rendering/RenderTypes.hh"
@@ -28,6 +31,22 @@ namespace ignition
   {
     inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
     //
+    /// \brief Enum for emitter types.
+    enum IGNITION_RENDERING_VISIBLE EmitterType
+    {
+      /// \brief Point emitter.
+      EM_POINT            = 0,
+
+      /// \brief Box emitter.
+      EM_BOX              = 1,
+
+      /// \brief Cylinder emitter.
+      EM_CYLINDER         = 2,
+
+      /// \brief Ellipsoid emitter.
+      EM_ELLISOID         = 3,
+    };
+
     /// \class ParticleEmitter ParticleEmitter.hh
     /// ignition/rendering/ParticleEmitter.hh
     //
@@ -36,7 +55,159 @@ namespace ignition
       public virtual Visual
     {
       /// \brief Destructor
-      public: virtual ~ParticleEmitter();
+      public: virtual ~ParticleEmitter() {}
+
+      /// \brief \brief Get the emitter type.
+      /// \return Emitter type.
+      /// \sa EmitterType.
+      /// \sa SetType.
+      public: virtual EmitterType Type() const = 0;
+
+      /// \brief \brief Set the emitter type.
+      /// Default value is EM_POINT.
+      /// \param[in] _type Emitter type.
+      /// \sa EmitterType.
+      /// \sa Type.
+      public: virtual void SetType(const EmitterType _type) = 0;
+
+      /// \brief Get the size of the emitter where the particles are sampled.
+      /// \return The emitter size. See SetEmitterSize() for the interpretation
+      /// of the dimensions depending on the emitter type.
+      /// \sa SetEmitterSize
+      public: virtual ignition::math::Vector3d EmitterSize() const = 0;
+
+      /// \brief Set the size of the emitter where the particles are sampled.
+      /// Default value is (1, 1, 1).
+      /// Note that the interpretation of the emitter area varies depending on
+      /// the emmiter type:
+      ///   - EM_POINT: The area is ignored.
+      ///   - EM_BOX: The area is interpreted as width X height X depth.
+      ///   - EM_CYLINDER: The area is interpreted as the bounding box of the
+      ///                  cilinder. The cylinder is oriented along the Z-axis.
+      ///   - EM_ELLIPSOID: The area is interpreted as the bounding box of an
+      ///                   ellipsoid shaped area, i.e. a sphere or
+      ///                   squashed-sphere area. The parameters are again
+      ///                   identical to EM_BOX, except that the dimensions
+      ///                   describe the widest points along each of the axes.
+      /// \param[in] _size Size of the emitter (width, height, depth).
+      /// \sa EmitterSize
+      public: virtual void SetEmitterSize(
+                  const ignition::math::Vector3d &_size) = 0;
+
+      /// \brief Get how many particles per second should be emitted.
+      /// \return Particles per second.
+      /// \sa SetRate
+      public: virtual double Rate() const = 0;
+
+      /// \brief Set how many particles per second should be emitted.
+      /// Default value is 10.
+      /// \param[in] _rate Particles per second.
+      /// \sa Rate
+      public: virtual void SetRate(double _rate) = 0;
+
+      /// \brief Get the number of seconds the emitter is active.
+      /// A value of 0 means infinite duration.
+      /// \return Total duration of the emitter (seconds).
+      /// \sa SetDuration
+      public: virtual double Duration() const = 0;
+
+      /// \brief Set the number of seconds the emitter is active.
+      /// A value of 0 means infinite duration.
+      /// Default value is 0.
+      /// \param[in] _duration Total duration of the emitter (seconds).
+      /// \sa Duration
+      public: virtual void SetDuration(double _duration) = 0;
+
+      /// \brief Is the particle emitter enabled?
+      /// \return True when enabled or false otherwise.
+      /// \sa SetEmitting
+      public: virtual bool Emitting() const = 0;
+
+      /// \brief This is used to turn on or off particle emission.
+      /// Default value is false.
+      /// \param[in] _enable True for enabling the emission or false otherwise.
+      /// \sa Emitting
+      public: virtual void SetEmitting(bool _enable) = 0;
+
+      /// \brief Get the particle dimensions (width, height, depth).
+      /// \return Particle dimensions.
+      /// \sa SetParticleSize
+      public: virtual ignition::math::Vector3d ParticleSize() const = 0;
+
+      /// \brief Set the particle dimensions (width, height, depth).
+      /// Default value is {100, 100, 100}.
+      /// \param[in] _size Particle dimensions.
+      /// \sa ParticleSize
+      public: virtual void SetParticleSize(
+                  const ignition::math::Vector3d &_size) = 0;
+
+      /// \brief Get the number of seconds each particle will ’live’ for before
+      /// being destroyed.
+      /// \return Lifetime of each particle (seconds).
+      /// \sa SetLifetime
+      public: virtual double Lifetime() const = 0;
+
+      /// \brief Set the number of seconds each particle will ’live’ for before
+      /// being destroyed.
+      /// Default value is 5.
+      /// \param[in] _lifetime Lifetime of each particle (seconds).
+      /// \sa Lifetime
+      public: virtual void SetLifetime(double _lifetime) = 0;
+
+      /// \brief Get the material which all particles in the emitter will use.
+      /// \return The material pointer.
+      /// \sa SetMaterial
+      public: virtual MaterialPtr Material() const = 0;
+
+      /// \brief Sets the material which all particles in the emitter will use.
+      /// \param[in] _material The material pointer.
+      /// \sa Material
+      public: virtual void SetMaterial(const MaterialPtr &_material) = 0;
+
+      /// \brief Get the minimum velocity each particle is emitted (m/s).
+      /// \return Minimum velocity.
+      /// \sa MaxVelocity
+      /// \sa SetVelocityRange
+      public: virtual double MinVelocity() const = 0;
+
+      /// \brief Get the maximum velocity each particle is emitted (m/s).
+      /// \return Maximum velocity.
+      /// \sa MinVelocity
+      /// \sa SetVelocityRange
+      public: virtual double MaxVelocity() const = 0;
+
+      /// \brief Set a velocity range and each particle is emitted with a
+      /// random velocity within this range (m/s).
+      /// Default value is 1 for both velocities.
+      /// \param[in] _minVelocity Minimum velocity.
+      /// \param[in] _maxVelocity Maximum velocity.
+      /// \sa MinVelocity
+      /// \sa MaxVelocity
+      public: virtual void SetVelocityRange(double _minVelocity,
+                                            double _maxVelocity) = 0;
+
+      /// \brief Get the starting color of the particles.
+      /// \return Start color.
+      /// \sa ColorEnd
+      /// \sa SetColorRange
+      public: virtual ignition::math::Color ColorStart() const = 0;
+
+      /// \brief Get the end color of the particles.
+      /// \return End color.
+      /// \sa ColorStart
+      /// \sa SetColorRange
+      public: virtual ignition::math::Color ColorEnd() const = 0;
+
+      /// \brief Sets a colour for all particle emitted.
+      /// The actual colour will be interpolated between these two colors.
+      /// Default values are Color::White and Color::White respectively.
+      /// \param[in] _colorStart Start color.
+      /// \param[in] _colorEnd End color.
+      /// \sa ColorStart
+      /// \sa ColorEnd
+      public: virtual void SetColorRange(
+                  const ignition::math::Color &_colorStart,
+                  const ignition::math::Color &_colorEnd) = 0;
     };
     }
   }