ra 0.1.0 → 0.2.0

data/lib/ra/transform.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Ra
+  # A transform is represnted with a four by four matrix. These transforms are useful manupulate vectors. For example:
+  #
+  #   p = Vector[1, 2, 3, Ra::Tuple::POINT]
+  #   Ra::Transform.translate(2, 3, 4) * p == Vector[3, 5, 7, Ra::Tupl::POINT]
+  #   Ra::Transform.scale(1, 2, 3) * p == Vector[1, 4, 9, Ra::Tuple::POINT]
+  #
+  # As a convenience, transforms can also be chained:
+  #
+  #   Ra::Transform
+  #     .translate(2, 3, 4)
+  #     .scale(1, 2, 3)
+  #     .rotate_x(Math::PI / 4)
+  #     .rotate_y(Math::PI / 4)
+  #     .rotate_z(Math::PI / 4)
+  class Transform < ::Matrix
+    IDENTITY = identity(4)
+
+    # @param from [Vector]
+    # @param to [Vector]
+    # @param up [Vector]
+    # @return [Ra::Transform]
+    def self.view(from:, to:, up:)
+      f = (to - from).normalize
+      l = Tuple.cross(f, up.normalize)
+      u = Tuple.cross(l, f)
+
+      self[l, u, -f, [0, 0, 0, 1]]
+        .translate(-from[0], -from[1], -from[2])
+    end
+
+    # @return [Ra::Transform]
+    # @param x [Numeric]
+    # @param y [Numeric]
+    # @param z [Numeric]
+    def self.translate(x, y, z)
+      self[
+        [1, 0, 0, x],
+        [0, 1, 0, y],
+        [0, 0, 1, z],
+        [0, 0, 0, 1],
+      ]
+    end
+
+    # @return [Ra::Transform]
+    # @param x [Numeric]
+    # @param y [Numeric]
+    # @param z [Numeric]
+    def self.scale(x, y, z)
+      self[
+        [x, 0, 0, 0],
+        [0, y, 0, 0],
+        [0, 0, z, 0],
+        [0, 0, 0, 1],
+      ]
+    end
+
+    # @return [Ra::Transform]
+    # @param rotation [Numeric]
+    def self.rotate_x(rotation)
+      self[
+        [1, 0, 0, 0],
+        [0, +Math.cos(rotation), -Math.sin(rotation), 0],
+        [0, +Math.sin(rotation), +Math.cos(rotation), 0],
+        [0, 0, 0, 1],
+      ]
+    end
+
+    # @return [Ra::Transform]
+    # @param rotation [Numeric]
+    def self.rotate_y(rotation)
+      self[
+        [+Math.cos(rotation), 0, +Math.sin(rotation), 0],
+        [0, 1, 0, 0],
+        [-Math.sin(rotation), 0, +Math.cos(rotation), 0],
+        [0, 0, 0, 1],
+      ]
+    end
+
+    # @return [Ra::Transform]
+    # @param rotation [Numeric]
+    def self.rotate_z(rotation)
+      self[
+        [+Math.cos(rotation), -Math.sin(rotation), 0, 0],
+        [+Math.sin(rotation), +Math.cos(rotation), 0, 0],
+        [0, 0, 1, 0],
+        [0, 0, 0, 1],
+      ]
+    end
+
+    # @return [Ra::Transform]
+    # @param x [Numeric]
+    # @param y [Numeric]
+    # @param z [Numeric]
+    def translate(...)
+      self * self.class.translate(...)
+    end
+
+    # @return [Ra::Transform]
+    # @param x [Numeric]
+    # @param y [Numeric]
+    # @param z [Numeric]
+    def scale(...)
+      self * self.class.scale(...)
+    end
+
+    # @return [Ra::Transform]
+    # @param rotation [Numeric]
+    def rotate_x(...)
+      self * self.class.rotate_x(...)
+    end
+
+    # @return [Ra::Transform]
+    # @param rotation [Numeric]
+    def rotate_y(...)
+      self * self.class.rotate_y(...)
+    end
+
+    # @return [Ra::Transform]
+    # @param rotation [Numeric]
+    def rotate_z(...)
+      self * self.class.rotate_z(...)
+    end
+
+    # Avoid re-computing a transform inverse by memoizing.
+    #
+    # @return [Ra::Transform]
+    def inverse
+      @inverse ||= super
+    end
+
+    # Avoid re-computing a transform tranpose by memoizing.
+    #
+    # @return [Ra::Transform]
+    def tranpose
+      @tranpose ||= super
+    end
+  end
+end

data/lib/ra/tuple.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ra
+  # A Tuple can classify a Vector as a POINT or VECTOR. For example:
+  #
+  #   point = Vector[x = 1, y = 2, z = 3, w = Ra::Tuple::POINT]
+  #   vector = Vector[x = 1, y = 2, z = 3, w = Ra::Tuple::VECTOR]
+  module Tuple
+    POINT = 1
+    VECTOR = 0
+
+    # @return source [Vector]
+    # @return target [Vector]
+    # @return [Vector]
+    def self.cross(source, target)
+      cross = Vector[source[0], source[1], source[2]].cross(Vector[target[0], target[1], target[2]])
+
+      Vector[
+        cross[0],
+        cross[1],
+        cross[2],
+        Tuple::VECTOR,
+      ]
+    end
+  end
+end

data/lib/ra/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ra
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/ra/world.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Ra
+  # A world is composed of objects (lights / cameras) and handles coloring of rays.
+  class World
+    attr_accessor :light, :shapes
+
+    # @param light [Ra::Light]
+    # @param shapes [Array<Ra::Shape>]
+    def initialize(light:, shapes:)
+      @light = light
+      @shapes = shapes
+    end
+
+    # @param ray [Ra::Ray]
+    # @return [Array<Ra::Intersection>]
+    def intersect(ray:)
+      @shapes
+        .map { |shape| shape.intersect(ray:) }
+        .reduce(:concat) || []
+    end
+
+    # @return [Ra::Intersection, nil]
+    def intersection(ray:)
+      intersections = intersect(ray:)
+      Intersection.hit(intersections:)
+    end
+
+    # @param intersection [Ra::Intersection]
+    # @return [Ra::Color]
+    def color(intersection:)
+      surface = intersection.surface
+      shadowed = shadowed?(point: surface.hpoint)
+
+      Lighting.new(shadowed:, surface:, light:).color
+    end
+
+    # @param point [Ra::Point]
+    def shadowed?(point:)
+      vector = @light.position - point
+      distance = vector.magnitude
+      direction = vector.normalize
+      ray = Ray.new(origin: point, direction:)
+      hit = intersection(ray:)
+      hit && hit.t < distance
+    end
+  end
+end

data/lib/ra.rb

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "ra/version"
+require 'matrix'
+require 'zeitwerk'
 
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# Named for ["Ra"](https://en.wikipedia.org/wiki/Ra).
 module Ra
-  class Error < StandardError; end
-  # Your code goes here...
+  EPSILON = (2**-16)
+
+  # @return [Ra::Logger]
+  def self.logger
+    @logger ||= Logger.new
+  end
 end

metadata

@@ -1,33 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: ra
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
-dependencies: []
-description: "..."
+date: 2023-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This should probably never be used for anything but learning.
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- ra
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
 - README.md
-- Rakefile
+- exe/ra
 - lib/ra.rb
+- lib/ra/camera.rb
+- lib/ra/canvas.rb
+- lib/ra/color.rb
+- lib/ra/engine.rb
+- lib/ra/intersection.rb
+- lib/ra/light.rb
+- lib/ra/lighting.rb
+- lib/ra/logger.rb
+- lib/ra/material.rb
+- lib/ra/pattern/base.rb
+- lib/ra/pattern/checkers.rb
+- lib/ra/pattern/gradient.rb
+- lib/ra/pattern/rings.rb
+- lib/ra/pattern/stripes.rb
+- lib/ra/ray.rb
+- lib/ra/shape/base.rb
+- lib/ra/shape/cube.rb
+- lib/ra/shape/plane.rb
+- lib/ra/shape/sphere.rb
+- lib/ra/surface.rb
+- lib/ra/transform.rb
+- lib/ra/tuple.rb
 - lib/ra/version.rb
-- sig/ra.rbs
+- lib/ra/world.rb
 homepage: https://github.com/ksylvest/ra
-licenses: []
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/ksylvest/ra
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -36,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -46,5 +110,5 @@ requirements: []
 rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
-summary: "..."
+summary: A graphics library written for fun.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/sig/ra.rbs

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