particlefx2d 0.3.0

data/lib/particlefx2d/ruby2d/particle_image.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'shape_renderer'
+
+module ParticleFX2D
+  module Ruby2D
+    #
+    # A particle shape that is based on the Ruby2D _Image_.
+    class ParticleImage < ::Ruby2D::Image
+      include ShapeRenderer
+
+      # This class method is used to identify the image file to load.
+      # Create a subclass and override this method to define your own
+      # particle shapes based on image files.
+      def self.image_path
+        "#{File.dirname(__FILE__)}/../images/particle.png"
+      end
+
+      # Called by the emitter for each particle that it manages. Creates an instance
+      # of _ParticleImage_ using #image_path to obtain the file to load as image and
+      # intialized with the particle's position, size and colour.
+      #
+      # @param [ParticleFX2D::Particle] particle
+      #
+      def self.for(particle)
+        s = ParticleImage.new image_path, width: particle.size, height: particle.size
+        s.remove
+        s
+      end
+
+      # Sets the images's position using the incoming centre coordinates
+      # offset by the shape's mid-size.
+      def center!(centre_x, centre_y)
+        self.x = centre_x - (width / 2)
+        self.y = centre_y - (height / 2)
+      end
+
+      # Sets the image size using the particle size and calls #super
+      def draw_particle(particle)
+        self.width = self.height = particle.size
+        super
+      end
+    end
+  end
+end

data/lib/particlefx2d/ruby2d/shape_renderer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../renderer_factory'
+
+module ParticleFX2D
+  module Ruby2D
+    # The base definition for a Ruby2D shape-based renderer that can be peered to
+    # a particle managed by the ParticleFX2D _Emitter_. Include this when defining
+    # Ruby2D shape-specific classes to provide the Emitter to render
+    # the particle.
+    #
+    # This approach requires a shape per particle.
+    module ShapeRenderer
+      include ParticleFX2D::Renderer
+
+      # Show the particle. Used when a particle is activated.
+      def show_particle(_particle)
+        add
+      end
+
+      # Hide the particle. Used when a particle is deactivated.
+      def hide_particle(_particle)
+        remove
+      end
+
+      # Updates the shape's properties; no explicit drawing needed.
+      def draw_particle(particle)
+        center!(particle.x, particle.y)
+        color!(particle.color)
+      end
+
+      private
+
+      # Set the shape's center position. Must be implemented per shape.
+      # @raise [StandardError] because this method is unimplemented.
+      def center!(_centre_x, _centre_y)
+        raise StandardError('unimplemented')
+      end
+
+      # Set the shape's color.
+      #
+      # @param [Object] particle_color A colour object with +r+, +g+, +b+, +a+ members,
+      #                                where each component is in the range [0.0..1.0].
+      def color!(particle_color)
+        color.r = particle_color.r
+        color.g = particle_color.g
+        color.b = particle_color.b
+        color.opacity = particle_color.opacity
+      end
+    end
+  end
+end

data/lib/particlefx2d/ruby2d/shape_renderer_factory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../renderer_factory'
+
+module ParticleFX2D
+  module Ruby2D
+    #
+    # Use an instance of this class to provide
+    # an _Emitter_ with a renderer factory.
+    class ShapeRendererFactory
+      include RendererFactory
+
+      #
+      # Instantiate a shape renderer factory.
+      #
+      # @param [ShapeRenderer] renderer_class Specify the object that will be used to create
+      #           the particle renderers. e.g. _ParticleCircle_.
+      def initialize(renderer_class)
+        @renderer_class = renderer_class
+      end
+
+      # Return a particle renderer.
+      #
+      # @return [Renderer] for each particle
+      def renderer_for(particle)
+        @renderer_class.for(particle)
+      end
+    end
+  end
+end

data/lib/particlefx2d/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ParticleFX2D
+  # Current version.
+  VERSION = '0.3.0'
+end

data/lib/particlefx2d.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'particlefx2d/version'
+require_relative 'particlefx2d/emitter'
+require_relative 'particlefx2d/renderer_factory'
+
+# 2D particle effects API for use with any Ruby graphics API.
+module ParticleFX2D
+end

data/lib/particlefx_ruby2d.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'particlefx2d'
+require_relative 'particlefx2d/ruby2d/particle_circle'
+require_relative 'particlefx2d/ruby2d/particle_image'
+require_relative 'particlefx2d/ruby2d/shape_renderer_factory'
+require_relative 'particlefx2d/ruby2d/canvas_renderer_factory'
+
+module ParticleFX2D
+  # This module defines the Ruby2D-specific particle shapes
+  # that can be peered with ParticleFX2D's particle effects.
+  module Ruby2D
+  end
+end

data/particlefx2d.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/particlefx2d/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'particlefx2d'
+  spec.version = ParticleFX2D::VERSION
+  spec.authors = ['nogginly']
+  spec.email = ['nogginly@icloud.com']
+
+  spec.summary = '2D particle effects API for use with any Ruby graphics API.'
+  spec.homepage = 'https://github.com/nogginly/particlefx2d'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # no deployment dependencies
+
+  # development
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'yard'
+end

data/sig/particlefx2d.rbs

@@ -0,0 +1,4 @@
+module ParticleFX2D
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'particlefx2d'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/particlefx2d_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe ParticleFX2D do
+  it 'has a version number' do
+    expect(ParticleFX2D::VERSION).not_to be nil
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: particlefx2d
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- nogginly
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- nogginly@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/images/fx_blue_swirling_smoke.png
+- example/images/fx_square_burst.png
+- example/images/fx_white_red_smoke.png
+- example/ruby2d/fx_blue_swirling_smoke.rb
+- example/ruby2d/fx_square_burst.rb
+- example/ruby2d/fx_white_red_smoke.rb
+- lib/particlefx2d.rb
+- lib/particlefx2d/emitter.rb
+- 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
+- lib/particlefx2d/ruby2d/particle_circle.rb
+- lib/particlefx2d/ruby2d/particle_image.rb
+- lib/particlefx2d/ruby2d/shape_renderer.rb
+- lib/particlefx2d/ruby2d/shape_renderer_factory.rb
+- lib/particlefx2d/version.rb
+- lib/particlefx_ruby2d.rb
+- particlefx2d.gemspec
+- sig/particlefx2d.rbs
+- spec/spec_helper.rb
+- spec/unit/particlefx2d_spec.rb
+homepage: https://github.com/nogginly/particlefx2d
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nogginly/particlefx2d
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: 2D particle effects API for use with any Ruby graphics API.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/particlefx2d_spec.rb