particlefx2d 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb24e46327d94431dae7018d29abc79159b71fbae358cccd270dc4aa2a16db7d
-  data.tar.gz: 7286c7ce9812eb236765129b30c5755876917ceb0fd456d0a108cec8f9a164d3
+  metadata.gz: 1a4c412bb853340b776b082712a935a838b2625da52865bb3a057d2f1c143f70
+  data.tar.gz: dc8ee5d7b28a1ecc8604edfde8a5669b2beb717bd06be3cece36f197f11f51ba
 SHA512:
-  metadata.gz: 52260a8afa4d7fead08320e9726dc3d33a032a4e9af8d70e6ba9936388e0296048479f1053eb924d874f4aaf038d1a85f5d40e19e4115a7750677e0d847ef039
-  data.tar.gz: cd55c2e8c789b9a026c5fae7408ecf2b95b0ed07e7048a34d7602b2b9d290eafd411f32854d1dcc48ff3abe63b70c2a48e6984bca61f773723ce0556cbc80dcd
+  metadata.gz: f7ff0578c86b82b90f4542913c147b4b5c6a639aaf995083a1d7364b9ab164786901781a7cb12325821971cdc46d6cfdb0a09cbef558f00d56d7dad0c62561ae
+  data.tar.gz: 757f4ed5a8be932bdcddd2a3b4e2bfc7611f43d4d7505f08237d7e2dc8bd02d50a595336d239c9a32b457b3c075ab7b7bda50b16ba91fbac86059095994ff1eb

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 - None so far
 
+## [0.4.0]
+
+- Added [Math2D](https://github.com/UalaceCafe/math2d) runtime dependency for vector maths
+- Tweaked `CanvasRendererFactory` to detect `fill_rectangle` if present
+
 ## [0.3.0]
 
 - Defined `Renderer` and `RendererFactory` modules to define how particles are displayed

data/Gemfile

@@ -4,5 +4,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in particlefx2d.gemspec
 gemspec
-
-gem 'ruby2d', '~> 0.11.3'

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    particlefx2d (0.3.0)
+    particlefx2d (0.4.0)
+      math2d (~> 1.4, >= 1.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    math2d (1.4.1)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -44,7 +46,6 @@ GEM
     rubocop-rspec (2.9.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    ruby2d (0.11.3)
     unicode-display_width (2.1.0)
     webrick (1.7.0)
     yard (0.9.27)
@@ -60,7 +61,6 @@ DEPENDENCIES
   rubocop
   rubocop-rake
   rubocop-rspec
-  ruby2d (~> 0.11.3)
   yard
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,7 @@
 # ParticleFX2D
 
+[![Gem Version](https://badge.fury.io/rb/particlefx2d.svg)](https://badge.fury.io/rb/particlefx2d)
+
 This is a 2D particle effects API for use with any Ruby graphics API.
 
 > **Caution**
@@ -83,8 +85,8 @@ The gem includes a couple of pre-defined particle renderer factories for Ruby2D:
 
 | `ShapeRendererFactory`                                                                                                                  | `CanvasRendererFactory`                                                                                     |
 | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| [fx_white_red_smoke](example/ruby2d/fx_white_red_smoke.rb) ![white red smoke](example/images/fx_white_red_smoke.png)                    | [fx_square_burst](example/ruby2d/fx_square_burst.rb) ![fx_square_burst](example/images/fx_square_burst.png) |
-| [fx_blue_swirling_smoke](example/ruby2d/fx_blue_swirling_smoke.rb) ![fx_blue_swirling_smoke](example/images/fx_blue_swirling_smoke.png) |
+| [fx_white_red_smoke](example/ruby2d/fx_white_red_smoke.rb) ![white red smoke](example/images/fx_white_red_smoke.gif)                    | [fx_square_burst](example/ruby2d/fx_square_burst.rb) ![fx_square_burst](example/images/fx_square_burst.gif) |
+| [fx_blue_swirling_smoke](example/ruby2d/fx_blue_swirling_smoke.rb) ![fx_blue_swirling_smoke](example/images/fx_blue_swirling_smoke.gif) |
 
 The above are screenshots from running the various examples included. The first one with the red-white smoke is implemented in the complete example below.
 

data/Rakefile

@@ -16,4 +16,10 @@ end
 
 RuboCop::RakeTask.new
 
+desc 'Uninstall gem'
+task :uninstall do
+  puts 'Uninstalling'
+  system 'gem uninstall particlefx2d --executables'
+end
+
 task default: %i[spec rubocop]

data/example/ruby2d/fx_square_burst.rb

@@ -4,7 +4,7 @@ require 'ruby2d'
 require 'particlefx_ruby2d'
 
 # Test particle effect using Ruby2D
-class WhiteRedSmokeFX
+class SquareBurstFX
   def self.new_emitter
     ParticleFX2D::Emitter.new(
       renderer_factory: ParticleFX2D::Ruby2D::CanvasRendererFactory.new(
@@ -30,7 +30,7 @@ class WhiteRedSmokeFX
   end
 end
 
-emitter = WhiteRedSmokeFX.new_emitter
+emitter = SquareBurstFX.new_emitter
 tick = 0
 update do
   frame_time = 1.0 / get(:fps)

data/lib/particlefx2d/particle.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'private/vector2'
 require_relative 'private/color'
+require 'math2d'
 
 module ParticleFX2D
   #
@@ -42,8 +42,8 @@ module ParticleFX2D
     def reset!(opts = {})
       @initial_life = @life = value_from(opts, :life_time, default: 100).to_f
       @initial_size = @size = value_from(opts, :size, default: 5)
-      @gravity = Private::Vector2.new value_from(opts, :gravity_x, default: 0),
-                                      value_from(opts, :gravity_y, default: 0)
+      @gravity = Vector2D.new value_from(opts, :gravity_x, default: 0),
+                              value_from(opts, :gravity_y, default: 0)
       # following may depend on initial life and size
       reset_forces opts
       reset_scale_from opts
@@ -99,17 +99,17 @@ module ParticleFX2D
     # Update the force of acceleration based on configured gravity, radial accel and
     # tangential accel if applicable.
     def update_forces
-      @forces.copy! @gravity
+      @forces.replace! @gravity
       return @forces if (@radial_accel.zero? && @tangent_accel.zero?) || (@x == @initial_x && @y == @initial_y)
 
-      @radial.set!(@x, @y)
+      @radial.set(@x, @y)
              .subtract!(@initial_x, @initial_y)
              .normalize!
-      @tangential.copy!(@radial)
-                 .cross!
+      @tangential.replace!(@radial)
+                 .perp!
                  .times!(@tangent_accel)
-      @forces.add_vector!(@radial.times!(@radial_accel))
-             .add_vector!(@tangential)
+      @forces.plus!(@radial.times!(@radial_accel))
+             .plus!(@tangential)
     end
 
     # Update the motion for a frame of animation based on the updated forces and velocity
@@ -117,7 +117,7 @@ module ParticleFX2D
       @forces.times!(frame_time)
       @x += accelerated_velocity @velocity.x * frame_time, @forces.x
       @y += accelerated_velocity @velocity.y * frame_time, @forces.y
-      @velocity.add_vector! @forces
+      @velocity.plus! @forces
     end
 
     # Initialize position from configuration options
@@ -155,17 +155,17 @@ module ParticleFX2D
       @angle = value_from(opts, :angle, default: 0).to_f
       @angle_in_radians = nil
       @speed = value_from(opts, :speed, default: 100).to_f
-      @velocity ||= Private::Vector2.new
+      @velocity ||= Vector2D.new
       angle_rad = @angle * Math::PI / 180
-      @velocity.set! @speed * Math.cos(angle_rad),
-                     -@speed * Math.sin(angle_rad)
+      @velocity.set @speed * Math.cos(angle_rad),
+                    -@speed * Math.sin(angle_rad)
     end
 
     # Initialize forces from configuration options
     def reset_forces(opts)
-      @radial ||= Private::Vector2.new
-      @tangential ||= Private::Vector2.new
-      @forces ||= Private::Vector2.new
+      @radial ||= Vector2D.new
+      @tangential ||= Vector2D.new
+      @forces ||= Vector2D.new
       @radial_accel = value_from(opts, :radial_acceleration, default: 0)
       @tangent_accel = value_from(opts, :tangential_acceleration, default: 0)
     end

data/lib/particlefx2d/ruby2d/canvas_renderer_factory.rb

@@ -20,6 +20,7 @@ module ParticleFX2D
       #                                the Canvas so that each attempt to draw into it will not cause a texture update.
       def initialize(canvas)
         @canvas = canvas
+        @fill_method = canvas.class.method_defined?(:fill_rectangle, true)
       end
 
       # Return a particle renderer.
@@ -31,9 +32,7 @@ module ParticleFX2D
 
       # Clear the canvas before the next update cycle
       def on_update_start
-        @canvas.draw_rectangle(x: 0, y: 0,
-                               width: @canvas.width, height: @canvas.height,
-                               color: [0, 0, 0, 0])
+        fill_rect(0, 0, @canvas.width, @canvas.height, [0, 0, 0, 0])
       end
 
       # Update the canvas at the end of the next update cycle
@@ -54,9 +53,21 @@ module ParticleFX2D
         size = particle.size
         x = particle.x - (size / 2)
         y = particle.y - (size / 2)
-        @canvas.draw_rectangle(x: x, y: y,
-                               width: size, height: size,
-                               color: particle.color.to_a)
+        fill_rect(x, y, size, size, particle.color.to_a)
+      end
+
+      private
+
+      def fill_rect(x, y, width, height, color)
+        if @fill_method
+          @canvas.fill_rectangle(x: x, y: y,
+                                 width: width, height: height,
+                                 color: color)
+        else
+          @canvas.draw_rectangle(x: x, y: y,
+                                 width: width, height: height,
+                                 color: color)
+        end
       end
     end
   end

data/lib/particlefx2d/version.rb

@@ -2,5 +2,5 @@
 
 module ParticleFX2D
   # Current version.
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/particlefx2d.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   # no deployment dependencies
+  spec.add_runtime_dependency 'math2d', '~> 1.4', '>= 1.4.1'
 
   # development
   spec.add_development_dependency 'rake'

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: particlefx2d
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - nogginly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: math2d
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,8 +135,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example/images/fx_blue_swirling_smoke.gif
 - example/images/fx_blue_swirling_smoke.png
+- example/images/fx_square_burst.gif
 - example/images/fx_square_burst.png
+- example/images/fx_white_red_smoke.gif
 - example/images/fx_white_red_smoke.png
 - example/ruby2d/fx_blue_swirling_smoke.rb
 - example/ruby2d/fx_square_burst.rb
@@ -126,7 +149,6 @@ files:
 - lib/particlefx2d/images/particle.png
 - lib/particlefx2d/particle.rb
 - lib/particlefx2d/private/color.rb
-- lib/particlefx2d/private/vector2.rb
 - lib/particlefx2d/renderer.rb
 - lib/particlefx2d/renderer_factory.rb
 - lib/particlefx2d/ruby2d/canvas_renderer_factory.rb

data/lib/particlefx2d/private/vector2.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module ParticleFX2D
-  # @!visibility private
-  module Private
-    # @!visibility private
-    #
-    # A 2D vector, for internal use only
-    #
-    class Vector2
-      attr_reader :x, :y
-
-      def self.copy(vector)
-        Vector.new(vector.x, vector.y)
-      end
-
-      def initialize(x = 0, y = 0)
-        @x = x
-        @y = y
-      end
-
-      def set!(x, y)
-        @x = x
-        @y = y
-        self
-      end
-
-      def copy!(other)
-        @x = other.x
-        @y = other.y
-        self
-      end
-
-      def add!(x, y)
-        @x += x
-        @y += y
-        self
-      end
-
-      def subtract!(x, y)
-        @x -= x
-        @y -= y
-        self
-      end
-
-      def times!(value)
-        @x *= value
-        @y *= value
-        self
-      end
-
-      def divide_by!(value)
-        @x /= value
-        @y /= value
-        self
-      end
-
-      def add_vector!(other)
-        @x += other.x
-        @y += other.y
-        self
-      end
-
-      def minus_vector!(other)
-        @x -= other.x
-        @y -= other.y
-        self
-      end
-
-      def magnitude
-        Math.sqrt(@x.abs2 + @y.abs2)
-      end
-
-      def cross!
-        set! @y, -@x
-      end
-
-      def normalize!
-        mag = magnitude
-        mag = Float::INFINITY if mag.zero?
-        divide_by! mag
-      end
-    end
-  end
-end