Animation support for emitters and collider sets in Python (#229)

* [WIP] Animation support for emitters

* Adding collider set and tests

* More tests and fixes

Author: doyubkim

include/jet/volume_particle_emitter2.h

@@ -12,6 +12,7 @@
 #include <jet/implicit_surface2.h>
 #include <jet/particle_emitter2.h>
 #include <jet/point_generator2.h>
+
 #include <limits>
 #include <memory>
 #include <random>
@@ -33,9 +34,11 @@ class VolumeParticleEmitter2 final : public ParticleEmitter2 {
     //! the particle generation region.
     //!
     //! \param[in]  implicitSurface         The implicit surface.
-    //! \param[in]  bounds                  The max region.
+    //! \param[in]  maxRegion               The max region.
     //! \param[in]  spacing                 The spacing between particles.
-    //! \param[in]  initialVel              The initial velocity.
+    //! \param[in]  initialVel              The initial velocity of new particles.
+    //! \param[in]  linearVel               The linear velocity of the emitter.
+    //! \param[in]  angularVel              The angular velocity of the emitter.
     //! \param[in]  maxNumberOfParticles    The max number of particles to be
     //!                                     emitted.
     //! \param[in]  jitter                  The jitter amount between 0 and 1.
@@ -46,9 +49,11 @@ class VolumeParticleEmitter2 final : public ParticleEmitter2 {
     //!
     VolumeParticleEmitter2(
         const ImplicitSurface2Ptr& implicitSurface,
-        const BoundingBox2D& bounds,
+        const BoundingBox2D& maxRegion,
         double spacing,
         const Vector2D& initialVel = Vector2D(),
+        const Vector2D& linearVel = Vector2D(),
+        double angularVel = 0.0,
         size_t maxNumberOfParticles = kMaxSize,
         double jitter = 0.0,
         bool isOneShot = true,
@@ -65,6 +70,18 @@ class VolumeParticleEmitter2 final : public ParticleEmitter2 {
     //!
     void setPointGenerator(const PointGenerator2Ptr& newPointsGen);
 
+    //! Returns source surface.
+    const ImplicitSurface2Ptr& surface() const;
+
+    //! Sets the source surface.
+    void setSurface(const ImplicitSurface2Ptr& newSurface);
+
+    //! Returns max particle gen region.
+    const BoundingBox2D& maxRegion() const;
+
+    //! Sets the max particle gen region.
+    void setMaxRegion(const BoundingBox2D& newBox);
+
     //! Returns jitter amount.
     double jitter() const;
 
@@ -117,6 +134,18 @@ class VolumeParticleEmitter2 final : public ParticleEmitter2 {
     //! Returns the initial velocity of the particles.
     void setInitialVelocity(const Vector2D& newInitialVel);
 
+    //! Returns the linear velocity of the emitter.
+    Vector2D linearVelocity() const;
+
+    //! Sets the linear velocity of the emitter.
+    void setLinearVelocity(const Vector2D& newLinearVel);
+
+    //! Returns the angular velocity of the emitter.
+    double angularVelocity() const;
+
+    //! Sets the linear velocity of the emitter.
+    void setAngularVelocity(double newAngularVel);
+
     //! Returns builder fox VolumeParticleEmitter2.
     static Builder builder();
 
@@ -127,6 +156,8 @@ class VolumeParticleEmitter2 final : public ParticleEmitter2 {
     BoundingBox2D _bounds;
     double _spacing;
     Vector2D _initialVel;
+    Vector2D _linearVel;
+    double _angularVel = 0.0;
     PointGenerator2Ptr _pointsGen;
 
     size_t _maxNumberOfParticles = kMaxSize;
@@ -152,6 +183,8 @@ class VolumeParticleEmitter2 final : public ParticleEmitter2 {
         Array1<Vector2D>* newVelocities);
 
     double random();
+
+    Vector2D velocityAt(const Vector2D& point) const;
 };
 
 //! Shared pointer for the VolumeParticleEmitter2 type.
@@ -178,6 +211,12 @@ class VolumeParticleEmitter2::Builder final {
     //! Returns builder with initial velocity.
     Builder& withInitialVelocity(const Vector2D& initialVel);
 
+    //! Returns builder with linear velocity.
+    Builder& withLinearVelocity(const Vector2D& linearVel);
+
+    //! Returns builder with angular velocity.
+    Builder& withAngularVelocity(double angularVel);
+
     //! Returns builder with max number of particles.
     Builder& withMaxNumberOfParticles(size_t maxNumberOfParticles);
 
@@ -204,7 +243,9 @@ class VolumeParticleEmitter2::Builder final {
     bool _isBoundSet = false;
     BoundingBox2D _bounds;
     double _spacing = 0.1;
-    Vector2D _initialVel{0, 0};
+    Vector2D _initialVel;
+    Vector2D _linearVel;
+    double _angularVel = 0.0;
     size_t _maxNumberOfParticles = kMaxSize;
     double _jitter = 0.0;
     bool _isOneShot = true;

include/jet/volume_particle_emitter3.h

@@ -11,6 +11,7 @@
 #include <jet/implicit_surface3.h>
 #include <jet/particle_emitter3.h>
 #include <jet/point_generator3.h>
+
 #include <limits>
 #include <memory>
 #include <random>
@@ -32,9 +33,11 @@ class VolumeParticleEmitter3 final : public ParticleEmitter3 {
     //! the particle generation region.
     //!
     //! \param[in]  implicitSurface         The implicit surface.
-    //! \param[in]  bounds                  The max region.
+    //! \param[in]  maxRegion               The max region.
     //! \param[in]  spacing                 The spacing between particles.
     //! \param[in]  initialVel              The initial velocity.
+    //! \param[in]  linearVel               The linear velocity of the emitter.
+    //! \param[in]  angularVel              The angular velocity of the emitter.
     //! \param[in]  maxNumberOfParticles    The max number of particles to be
     //!                                     emitted.
     //! \param[in]  jitter                  The jitter amount between 0 and 1.
@@ -45,9 +48,11 @@ class VolumeParticleEmitter3 final : public ParticleEmitter3 {
     //!
     VolumeParticleEmitter3(
         const ImplicitSurface3Ptr& implicitSurface,
-        const BoundingBox3D& bounds,
+        const BoundingBox3D& maxRegion,
         double spacing,
         const Vector3D& initialVel = Vector3D(),
+        const Vector3D& linearVel = Vector3D(),
+        const Vector3D& angularVel = Vector3D(),
         size_t maxNumberOfParticles = kMaxSize,
         double jitter = 0.0,
         bool isOneShot = true,
@@ -64,6 +69,18 @@ class VolumeParticleEmitter3 final : public ParticleEmitter3 {
     //!
     void setPointGenerator(const PointGenerator3Ptr& newPointsGen);
 
+    //! Returns source surface.
+    const ImplicitSurface3Ptr& surface() const;
+
+    //! Sets the source surface.
+    void setSurface(const ImplicitSurface3Ptr& newSurface);
+
+    //! Returns max particle gen region.
+    const BoundingBox3D& maxRegion() const;
+
+    //! Sets the max particle gen region.
+    void setMaxRegion(const BoundingBox3D& newBox);
+
     //! Returns jitter amount.
     double jitter() const;
 
@@ -116,6 +133,18 @@ class VolumeParticleEmitter3 final : public ParticleEmitter3 {
     //! Returns the initial velocity of the particles.
     void setInitialVelocity(const Vector3D& newInitialVel);
 
+    //! Returns the linear velocity of the emitter.
+    Vector3D linearVelocity() const;
+
+    //! Sets the linear velocity of the emitter.
+    void setLinearVelocity(const Vector3D& newLinearVel);
+
+    //! Returns the angular velocity of the emitter.
+    Vector3D angularVelocity() const;
+
+    //! Sets the linear velocity of the emitter.
+    void setAngularVelocity(const Vector3D& newAngularVel);
+
     //! Returns builder fox VolumeParticleEmitter3.
     static Builder builder();
 
@@ -126,6 +155,8 @@ class VolumeParticleEmitter3 final : public ParticleEmitter3 {
     BoundingBox3D _bounds;
     double _spacing;
     Vector3D _initialVel;
+    Vector3D _linearVel;
+    Vector3D _angularVel;
     PointGenerator3Ptr _pointsGen;
 
     size_t _maxNumberOfParticles = kMaxSize;
@@ -151,6 +182,8 @@ class VolumeParticleEmitter3 final : public ParticleEmitter3 {
         Array1<Vector3D>* newVelocities);
 
     double random();
+
+    Vector3D velocityAt(const Vector3D& point) const;
 };
 
 //! Shared pointer for the VolumeParticleEmitter3 type.
@@ -177,6 +210,12 @@ class VolumeParticleEmitter3::Builder final {
     //! Returns builder with initial velocity.
     Builder& withInitialVelocity(const Vector3D& initialVel);
 
+    //! Returns builder with linear velocity.
+    Builder& withLinearVelocity(const Vector3D& linearVel);
+
+    //! Returns builder with angular velocity.
+    Builder& withAngularVelocity(const Vector3D& angularVel);
+
     //! Returns builder with max number of particles.
     Builder& withMaxNumberOfParticles(size_t maxNumberOfParticles);
 
@@ -203,7 +242,9 @@ class VolumeParticleEmitter3::Builder final {
     bool _isBoundSet = false;
     BoundingBox3D _bounds;
     double _spacing = 0.1;
-    Vector3D _initialVel{0, 0, 0};
+    Vector3D _initialVel;
+    Vector3D _linearVel;
+    Vector3D _angularVel;
     size_t _maxNumberOfParticles = kMaxSize;
     double _jitter = 0.0;
     bool _isOneShot = true;

src/examples/python_examples/collider_emitter_anim_example.py

@@ -31,7 +31,11 @@ def main():
     # Setup emitter
     sphere = Sphere3(center=(0.5, 1.0, 0.5), radius=0.15)
     emitter = VolumeParticleEmitter3(
-        implicitSurface=sphere, spacing=1.0 / (2 * resX), isOneShot=False, initialVelocity=(0, 0, 0))
+        implicitSurface=sphere,
+        maxRegion=solver.gridSystemData.boundingBox,
+        spacing=1.0 / (2 * resX),
+        isOneShot=False,
+        initialVelocity=(0, 0, 0))
     solver.particleEmitter = emitter
 
     # Setup collider
@@ -62,6 +66,10 @@ def updatefig(*args):
         # Stop emitter after frame 100
         if frame.index == 100:
             emitter.isOneShot = True
+        # Animate emitter's position (and thus the velocity which is its derivative)
+        emitter.surface.transform = Transform3(translation=(0.1 * math.sin(5 * frame.timeInSeconds()), 0, 0))
+        emitter.linearVelocity = (0.5 * math.cos(5 * frame.timeInSeconds()), 0, 0)
+
         # Animate collider's position (and thus the velocity which is its derivative)
         collider.surface.transform = Transform3(translation=(0.2 * math.sin(10 * frame.timeInSeconds()), 0, 0))
         collider.linearVelocity = (2.0 * math.cos(10 * frame.timeInSeconds()), 0, 0)