box2d-ruby 1.0.0

data/lib/box2d/world_queries.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Box2D
+  module WorldQueries
+    def raycast(from, to, filter: {})
+      ensure_access!
+      origin = ValueConversion.native_vec2(from, label: "from")
+      destination = ValueConversion.native_vec2(to, label: "to")
+      translation = Native::Vec2.new
+      translation[:x] = destination[:x] - origin[:x]
+      translation[:y] = destination[:y] - origin[:y]
+      result = Native.b2World_CastRayClosest(@id, origin, translation, ShapeDefinition.query_filter(filter))
+      return unless result[:hit]
+
+      Hit.new(
+        shape: shape_for_id(result[:shapeId]),
+        point: ValueConversion.vec2(result[:point]),
+        normal: ValueConversion.vec2(result[:normal]),
+        fraction: result[:fraction]
+      )
+    end
+
+    def overlap_aabb(lower, upper, filter: {}, &block)
+      return enum_for(__method__, lower, upper, filter:) unless block
+
+      ensure_access!
+      bounds = Native::AABB.new
+      bounds[:lowerBound] = ValueConversion.native_vec2(lower, label: "lower")
+      bounds[:upperBound] = ValueConversion.native_vec2(upper, label: "upper")
+      if bounds[:lowerBound][:x] > bounds[:upperBound][:x] || bounds[:lowerBound][:y] > bounds[:upperBound][:y]
+        raise ArgumentError, "lower AABB bound must not exceed upper bound"
+      end
+
+      perform_overlap(block) do |callback|
+        Native.b2World_OverlapAABB(@id, bounds, ShapeDefinition.query_filter(filter), callback, nil)
+      end
+    end
+
+    def overlap_circle(center, radius:, filter: {}, &block)
+      return enum_for(__method__, center, radius:, filter:) unless block
+
+      ensure_access!
+      point = ValueConversion.native_vec2(center, label: "center")
+      proxy = Native.b2MakeProxy(
+        point.pointer,
+        1,
+        ValueConversion.positive_float(radius, label: "radius")
+      )
+      overlap_proxy(proxy, filter, block)
+    end
+
+    def overlap_capsule(point1, point2, radius:, filter: {}, &block)
+      return enum_for(__method__, point1, point2, radius:, filter:) unless block
+
+      ensure_access!
+      points, count = native_query_points([point1, point2], minimum: 2, maximum: 2)
+      proxy = Native.b2MakeProxy(
+        points,
+        count,
+        ValueConversion.positive_float(radius, label: "radius")
+      )
+      overlap_proxy(proxy, filter, block)
+    end
+
+    def overlap_polygon(points, position: [0, 0], angle: 0, radius: 0.0, filter: {}, &block)
+      return enum_for(__method__, points, position:, angle:, radius:, filter:) unless block
+
+      ensure_access!
+      point_buffer, count = native_query_points(points, minimum: 3, maximum: 8)
+      hull = Native.b2ComputeHull(point_buffer, count)
+      raise ArgumentError, "points do not form a valid convex hull" if hull[:count] < 3
+
+      proxy = Native.b2MakeOffsetProxy(
+        hull.pointer + Native::Hull.offset_of(:points),
+        hull[:count],
+        ValueConversion.non_negative_float(radius, label: "radius"),
+        ValueConversion.native_vec2(position, label: "position"),
+        ValueConversion.native_rot(angle)
+      )
+      overlap_proxy(proxy, filter, block)
+    end
+
+    private
+
+    def overlap_proxy(proxy, filter, block)
+      ensure_access!
+      perform_overlap(block) do |callback|
+        Native.b2World_OverlapShape(@id, proxy.pointer, ShapeDefinition.query_filter(filter), callback, nil)
+      end
+    end
+
+    def perform_overlap(block)
+      callback_error = nil
+      callback = FFI::Function.new(:bool, [Native::ShapeId.by_value, :pointer]) do |shape_id, _context|
+        begin
+          block.call(shape_for_id(shape_id)) != false
+        rescue Exception => error
+          callback_error ||= error
+          false
+        end
+      end
+      yield callback
+      raise callback_error if callback_error
+
+      self
+    end
+
+    def native_query_points(points, minimum:, maximum:)
+      values = points.to_a
+      unless values.length.between?(minimum, maximum)
+        raise ArgumentError, "points must contain #{minimum}..#{maximum} vertices"
+      end
+
+      pointer = FFI::MemoryPointer.new(Native::Vec2, values.length)
+      values.each_with_index do |point, index|
+        vector = ValueConversion.native_vec2(point, label: "points[#{index}]")
+        pointer.put_bytes(index * Native::Vec2.size, vector.pointer.read_bytes(Native::Vec2.size))
+      end
+      [pointer, values.length]
+    end
+  end
+end

data/lib/box2d/world_registry.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Box2D
+  module WorldRegistry
+    def body_for_id(id)
+      key = ValueConversion.id_key(id)
+      @bodies[key] ||= Body.new(self, id)
+    end
+
+    def shape_for_id(id)
+      key = ValueConversion.id_key(id)
+      return @shapes[key] if @shapes.key?(key)
+
+      body = body_for_id(Native.b2Shape_GetBody(id)) if Native.b2Shape_IsValid(id)
+      @shapes[key] = Shape.new(self, id, body:)
+    end
+
+    def register_body(body)
+      @bodies[ValueConversion.id_key(body.id)] = body
+      body
+    end
+
+    def register_shape(shape)
+      @shapes[ValueConversion.id_key(shape.id)] = shape
+      shape
+    end
+
+    def register_chain(chain)
+      @chains[ValueConversion.id_key(chain.id)] = chain
+      chain
+    end
+
+    def register_joint(joint)
+      @joints[ValueConversion.id_key(joint.id)] = joint
+      joint
+    end
+
+    def unregister_body(body)
+      @bodies.delete(ValueConversion.id_key(body.id))
+      @body_user_data.delete(ValueConversion.id_key(body.id))
+      body.shapes.each { |shape| unregister_shape(shape) }
+      body.chains.each { |chain| unregister_chain(chain) }
+    end
+
+    def unregister_shape(shape)
+      key = ValueConversion.id_key(shape.id)
+      @shapes.delete(key)
+      @shape_user_data.delete(key)
+    end
+
+    def unregister_chain(chain)
+      @chains.delete(ValueConversion.id_key(chain.id))
+    end
+
+    def unregister_joint(joint)
+      @joints.delete(ValueConversion.id_key(joint.id))
+    end
+
+    def body_user_data(body)
+      @body_user_data[ValueConversion.id_key(body.id)]
+    end
+
+    def set_body_user_data(body, value)
+      @body_user_data[ValueConversion.id_key(body.id)] = value
+    end
+
+    def shape_user_data(shape)
+      @shape_user_data[ValueConversion.id_key(shape.id)]
+    end
+
+    def set_shape_user_data(shape, value)
+      @shape_user_data[ValueConversion.id_key(shape.id)] = value
+    end
+
+    private
+
+    def initialize_registries
+      @bodies = {}
+      @shapes = {}
+      @chains = {}
+      @joints = {}
+      @body_user_data = {}
+      @shape_user_data = {}
+    end
+
+    def clear_registries
+      [@bodies, @shapes, @chains, @joints].each do |registry|
+        registry.each_value { |handle| handle.send(:invalidate!) }
+        registry.clear
+      end
+      @body_user_data.clear
+      @shape_user_data.clear
+    end
+  end
+end

data/lib/box2d.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "box2d/version"
+
+module Box2D
+  class Error < StandardError; end
+  class LoadError < Error; end
+  class UseAfterDestroyError < Error; end
+  class ReentrantStepError < Error; end
+end
+
+require_relative "box2d/native_loader"
+require_relative "box2d/native"
+require_relative "box2d/value_conversion"
+require_relative "box2d/fixed_stepper"
+require_relative "box2d/pixel_scale"
+require_relative "box2d/handle"
+require_relative "box2d/shape_definition"
+require_relative "box2d/shape"
+require_relative "box2d/chain"
+require_relative "box2d/body_shapes"
+require_relative "box2d/body"
+require_relative "box2d/joint"
+require_relative "box2d/events"
+require_relative "box2d/hit"
+require_relative "box2d/debug_draw"
+require_relative "box2d/world_registry"
+require_relative "box2d/body_definition"
+require_relative "box2d/world_joints"
+require_relative "box2d/world_queries"
+require_relative "box2d/world"

data/script/build_platform_gem.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "rbconfig"
+require "rubygems/package"
+
+root = File.expand_path("..", __dir__)
+extension = "native.#{RbConfig::CONFIG.fetch("DLEXT")}"
+compiled_library = File.join(root, "ext/box2d", extension)
+packaged_library = File.join(root, "lib/box2d", extension)
+abort "compile the native library before packaging" unless File.file?(compiled_library)
+
+begin
+  FileUtils.cp(compiled_library, packaged_library)
+  ENV["BOX2D_PRECOMPILED"] = "true"
+  specification = Gem::Specification.load(File.join(root, "box2d.gemspec"))
+  gem_file = Gem::Package.build(specification)
+  FileUtils.mkdir_p(File.join(root, "pkg"))
+  destination = File.join(root, "pkg", File.basename(gem_file))
+  FileUtils.mv(gem_file, destination)
+  puts destination
+ensure
+  FileUtils.rm_f(packaged_library)
+end

data/script/deterministic_scene.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+
+module DeterministicScene
+  SEED = 12_345
+  BODY_COUNT = 100
+  STEPS = 240
+  TIME_STEP = 1.0 / 60
+
+  module_function
+
+  def capture
+    random = Random.new(SEED)
+    world = Box2D::World.new
+    world.create_body(position: [0, -1]) { |body| body.box(20, 1) }
+    bodies = BODY_COUNT.times.map do |index|
+      column = index % 10
+      row = index / 10
+      x = column - 4.5 + random.rand(-0.04..0.04)
+      y = row + 0.6 + random.rand(0.0..0.04)
+      angle = random.rand(-0.03..0.03)
+      world.create_body(type: :dynamic, position: [x, y], angle:) do |body|
+        body.box(0.4, 0.4, density: 1.0, friction: 0.6)
+      end
+    end
+    STEPS.times { world.step(TIME_STEP) }
+    bodies.map { |body| body.position.to_a }
+  ensure
+    world&.destroy if world&.valid?
+  end
+
+  def platform
+    cpu = RbConfig::CONFIG.fetch("host_cpu")
+    os = RbConfig::CONFIG.fetch("host_os")
+    return "#{darwin_cpu(cpu)}-darwin" if os.include?("darwin")
+    return "#{linux_cpu(cpu)}-linux" if os.include?("linux")
+    return "x64-mingw-ucrt" if os.match?(/mingw|mswin/)
+
+    "#{cpu}-#{os}"
+  end
+
+  def snapshot_path
+    File.expand_path("../spec/snapshots/100_boxes/#{platform}.json", __dir__)
+  end
+
+  def darwin_cpu(cpu)
+    cpu.match?(/arm|aarch64/) ? "arm64" : "x86_64"
+  end
+  private_class_method :darwin_cpu
+
+  def linux_cpu(cpu)
+    cpu.match?(/arm|aarch64/) ? "aarch64" : "x86_64"
+  end
+  private_class_method :linux_cpu
+end

data/script/update_deterministic_snapshot.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "json"
+require "fileutils"
+require_relative "../lib/box2d"
+require_relative "deterministic_scene"
+
+path = DeterministicScene.snapshot_path
+FileUtils.mkdir_p(File.dirname(path))
+File.write(path, JSON.pretty_generate(DeterministicScene.capture) << "\n")
+puts path

data/script/verify_platform_gem.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require "rbconfig"
+require "rubygems/package"
+
+gem_path = File.expand_path(ARGV.fetch(0))
+abort "platform gem does not exist: #{gem_path}" unless File.file?(gem_path)
+
+specification = Gem::Package.new(gem_path).spec
+if specification.platform == Gem::Platform::RUBY
+  abort "expected a platform gem, got the source gem: #{gem_path}"
+end
+
+Dir.mktmpdir("box2d-platform-gem") do |directory|
+  Gem::Package.new(gem_path).extract_files(directory)
+  native_library = Dir[File.join(directory, "lib/box2d/native.{bundle,so,dll}")].first
+  abort "platform gem does not contain a native library" unless native_library
+
+  rspec = Gem.bin_path("rspec-core", "rspec")
+  environment = {"BOX2D_LIBRARY_PATH" => native_library}
+  success = system(environment, RbConfig.ruby, rspec, "--format", "progress")
+  abort "specs failed against #{File.basename(gem_path)}" unless success
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: box2d-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: A generated FFI binding and memory-safe Ruby API for Box2D v3.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions:
+- ext/box2d/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- examples/contact_events.rb
+- examples/debug_draw.rb
+- examples/falling_ball.rb
+- examples/rugl_debug_draw.rb
+- examples/stagecraft_debug_draw.rb
+- examples/support/box2d_debug_lines.rb
+- ext/box2d/CMakeLists.txt
+- ext/box2d/extconf.rb
+- ext/box2d/native.c
+- ext/box2d/vendor/box2d/LICENSE
+- ext/box2d/vendor/box2d/VERSION
+- ext/box2d/vendor/box2d/include/box2d/base.h
+- ext/box2d/vendor/box2d/include/box2d/box2d.h
+- ext/box2d/vendor/box2d/include/box2d/collision.h
+- ext/box2d/vendor/box2d/include/box2d/id.h
+- ext/box2d/vendor/box2d/include/box2d/math_functions.h
+- ext/box2d/vendor/box2d/include/box2d/types.h
+- ext/box2d/vendor/box2d/src/CMakeLists.txt
+- ext/box2d/vendor/box2d/src/aabb.c
+- ext/box2d/vendor/box2d/src/aabb.h
+- ext/box2d/vendor/box2d/src/arena_allocator.c
+- ext/box2d/vendor/box2d/src/arena_allocator.h
+- ext/box2d/vendor/box2d/src/array.c
+- ext/box2d/vendor/box2d/src/array.h
+- ext/box2d/vendor/box2d/src/atomic.h
+- ext/box2d/vendor/box2d/src/bitset.c
+- ext/box2d/vendor/box2d/src/bitset.h
+- ext/box2d/vendor/box2d/src/body.c
+- ext/box2d/vendor/box2d/src/body.h
+- ext/box2d/vendor/box2d/src/box2d.natvis
+- ext/box2d/vendor/box2d/src/broad_phase.c
+- ext/box2d/vendor/box2d/src/broad_phase.h
+- ext/box2d/vendor/box2d/src/constants.h
+- ext/box2d/vendor/box2d/src/constraint_graph.c
+- ext/box2d/vendor/box2d/src/constraint_graph.h
+- ext/box2d/vendor/box2d/src/contact.c
+- ext/box2d/vendor/box2d/src/contact.h
+- ext/box2d/vendor/box2d/src/contact_solver.c
+- ext/box2d/vendor/box2d/src/contact_solver.h
+- ext/box2d/vendor/box2d/src/core.c
+- ext/box2d/vendor/box2d/src/core.h
+- ext/box2d/vendor/box2d/src/ctz.h
+- ext/box2d/vendor/box2d/src/distance.c
+- ext/box2d/vendor/box2d/src/distance_joint.c
+- ext/box2d/vendor/box2d/src/dynamic_tree.c
+- ext/box2d/vendor/box2d/src/geometry.c
+- ext/box2d/vendor/box2d/src/hull.c
+- ext/box2d/vendor/box2d/src/id_pool.c
+- ext/box2d/vendor/box2d/src/id_pool.h
+- ext/box2d/vendor/box2d/src/island.c
+- ext/box2d/vendor/box2d/src/island.h
+- ext/box2d/vendor/box2d/src/joint.c
+- ext/box2d/vendor/box2d/src/joint.h
+- ext/box2d/vendor/box2d/src/manifold.c
+- ext/box2d/vendor/box2d/src/math_functions.c
+- ext/box2d/vendor/box2d/src/motor_joint.c
+- ext/box2d/vendor/box2d/src/mouse_joint.c
+- ext/box2d/vendor/box2d/src/mover.c
+- ext/box2d/vendor/box2d/src/prismatic_joint.c
+- ext/box2d/vendor/box2d/src/revolute_joint.c
+- ext/box2d/vendor/box2d/src/sensor.c
+- ext/box2d/vendor/box2d/src/sensor.h
+- ext/box2d/vendor/box2d/src/shape.c
+- ext/box2d/vendor/box2d/src/shape.h
+- ext/box2d/vendor/box2d/src/solver.c
+- ext/box2d/vendor/box2d/src/solver.h
+- ext/box2d/vendor/box2d/src/solver_set.c
+- ext/box2d/vendor/box2d/src/solver_set.h
+- ext/box2d/vendor/box2d/src/table.c
+- ext/box2d/vendor/box2d/src/table.h
+- ext/box2d/vendor/box2d/src/timer.c
+- ext/box2d/vendor/box2d/src/types.c
+- ext/box2d/vendor/box2d/src/weld_joint.c
+- ext/box2d/vendor/box2d/src/wheel_joint.c
+- ext/box2d/vendor/box2d/src/world.c
+- ext/box2d/vendor/box2d/src/world.h
+- generator/generate.rb
+- generator/layout_probe.c
+- generator/verify_layouts.rb
+- lib/box2d.rb
+- lib/box2d/body.rb
+- lib/box2d/body_definition.rb
+- lib/box2d/body_shapes.rb
+- lib/box2d/chain.rb
+- lib/box2d/debug_draw.rb
+- lib/box2d/events.rb
+- lib/box2d/fixed_stepper.rb
+- lib/box2d/handle.rb
+- lib/box2d/hit.rb
+- lib/box2d/joint.rb
+- lib/box2d/native.rb
+- lib/box2d/native_loader.rb
+- lib/box2d/pixel_scale.rb
+- lib/box2d/shape.rb
+- lib/box2d/shape_definition.rb
+- lib/box2d/value_conversion.rb
+- lib/box2d/version.rb
+- lib/box2d/world.rb
+- lib/box2d/world_joints.rb
+- lib/box2d/world_queries.rb
+- lib/box2d/world_registry.rb
+- script/build_platform_gem.rb
+- script/deterministic_scene.rb
+- script/update_deterministic_snapshot.rb
+- script/verify_platform_gem.rb
+homepage: https://rubygems.org/gems/box2d-ruby
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://rubygems.org/gems/box2d-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Idiomatic Ruby bindings for the Box2D v3 physics engine
+test_files: []