3rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2ee6abb7f305cbf4e04e10e4a4f9400534ff7254af3c88cdc109563927bff45
+  data.tar.gz: 4c15b24c1cbb52719563fe14e34a0a1a9e7ec94eecffda8d47df006dd1df9296
+SHA512:
+  metadata.gz: e3c71db17e64723328d37c895b47a21f4a77c57c4ca969a4cac01b36d77381ef73227023f15ec7b3b66e9ba52f538f72ade36f73fc80d38fd1aaaf07c59a189f
+  data.tar.gz: ad86cd39eafafb133488859d44655657880815a832132fec4ebb18544747f55f6d6064aae1026e8a20807a1ce7c2115ca55acb9e5521070cb098119c494d786b

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/3rb.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/3rb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "3rb"
+  spec.version = Sunrb::VERSION
+  spec.authors = ["Yudai Takada"]
+  spec.email = ["t.yudai92@gmail.com"]
+
+  spec.summary = "3D graphics library for Ruby inspired by Three.js"
+  spec.description = "A powerful, intuitive 3D graphics library for Ruby with a Three.js-like API and Ruby DSL"
+  spec.homepage = "https://github.com/ydah/3rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi", "~> 1.15"
+end

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.1.0 - 2025-12-31
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,321 @@
+# 3rb
+
+A 3D graphics library for Ruby inspired by Three.js.
+
+## Features
+
+- Provides a Three.js-like API
+- Includes a DSL for building scenes with Ruby blocks
+- Uses OpenGL/GLFW via FFI (no compilation required)
+- Supports PBR rendering
+- Contains math classes for Vector, Matrix, Quaternion, Euler, Color
+- Has basic geometries like Box, Sphere, Cylinder, Torus
+- Supports Basic, Lambert, Phong, Standard, and Shader materials
+- Includes Ambient, Directional, Point, and Spot lights
+- Supports keyframe animation
+- Has OrbitControls for camera manipulation
+- Can load OBJ and GLTF files
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem "3rb"
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+### System Dependencies
+
+**macOS:**
+```bash
+brew install glfw
+```
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get install libglfw3-dev libgl1-mesa-dev
+```
+
+## Quick Start
+
+```ruby
+require "3rb"
+
+scene = Sunrb::Scene.new
+scene.background = Sunrb::Color.new(0x1a1a2e)
+
+camera = Sunrb::PerspectiveCamera.new(fov: 75)
+camera.position.set(0, 0, 5)
+
+geometry = Sunrb::BoxGeometry.new(width: 1, height: 1, depth: 1)
+material = Sunrb::MeshStandardMaterial.new(color: 0x00ff00)
+cube = Sunrb::Mesh.new(geometry, material)
+scene.add(cube)
+
+light = Sunrb::DirectionalLight.new(color: 0xffffff, intensity: 1.0)
+light.position.set(5, 5, 5)
+scene.add(light)
+```
+
+### Using the DSL
+
+```ruby
+require "3rb"
+
+Sunrb.scene do
+  background 0x000033
+
+  camera :perspective, fov: 60, position: [0, 5, 10]
+
+  ambient_light color: 0x404040
+  directional_light color: 0xffffff, position: [5, 10, 5]
+
+  mesh :box, size: 2, color: 0xff0000, position: [0, 1, 0]
+  mesh :sphere, radius: 1, color: 0x00ff00, position: [3, 1, 0]
+end
+```
+
+## Core Classes
+
+### Math
+
+| Class | Description |
+|-------|-------------|
+| `Vector2` | 2D vector |
+| `Vector3` | 3D vector |
+| `Vector4` | 4D vector |
+| `Matrix3` | 3x3 matrix |
+| `Matrix4` | 4x4 transformation matrix |
+| `Quaternion` | Rotation quaternion |
+| `Euler` | Euler angles |
+| `Color` | RGB color |
+
+### Geometries
+
+| Class | Description |
+|-------|-------------|
+| `BoxGeometry` | Rectangular cuboid |
+| `SphereGeometry` | UV sphere |
+| `PlaneGeometry` | Flat plane |
+| `CylinderGeometry` | Cylinder |
+| `ConeGeometry` | Cone |
+| `TorusGeometry` | Torus (donut) |
+| `CircleGeometry` | Flat circle |
+| `RingGeometry` | Flat ring |
+| `TorusKnotGeometry` | Torus knot |
+| `IcosahedronGeometry` | Icosahedron |
+| `OctahedronGeometry` | Octahedron |
+| `TetrahedronGeometry` | Tetrahedron |
+| `DodecahedronGeometry` | Dodecahedron |
+
+### Materials
+
+| Class | Description |
+|-------|-------------|
+| `MeshBasicMaterial` | Unlit, flat shading |
+| `MeshLambertMaterial` | Diffuse (matte) |
+| `MeshPhongMaterial` | Specular highlights |
+| `MeshStandardMaterial` | PBR material |
+| `ShaderMaterial` | Custom GLSL shaders |
+| `LineBasicMaterial` | For line rendering |
+| `PointsMaterial` | For point clouds |
+
+### Lights
+
+| Class | Description |
+|-------|-------------|
+| `AmbientLight` | Uniform lighting |
+| `DirectionalLight` | Sun-like parallel rays |
+| `PointLight` | Omni-directional |
+| `SpotLight` | Cone-shaped |
+
+### Objects
+
+| Class | Description |
+|-------|-------------|
+| `Mesh` | Geometry + Material |
+| `Line` | Line rendering |
+| `Points` | Point cloud |
+| `Group` | Container for objects |
+| `Scene` | Root container |
+
+## Examples
+
+The `examples/` directory contains 18 example files:
+
+### Basic
+- `01_hello_cube.rb` - Simple rotating cube
+- `02_basic_geometries.rb` - All geometry types
+- `03_materials.rb` - Material showcase
+- `04_lighting.rb` - Light types demo
+
+### Advanced
+- `05_animation.rb` - Keyframe animation
+- `06_custom_shader.rb` - GLSL shaders
+- `07_scene_graph.rb` - Hierarchical transforms
+- `08_orbit_controls.rb` - Camera controls
+
+### Practical
+- `09_3d_chart.rb` - Data visualization
+- `10_procedural_terrain.rb` - Terrain generation
+- `11_particle_system.rb` - Particle effects
+- `12_model_loader.rb` - OBJ/GLTF loading
+- `13_game_prototype.rb` - Simple game
+
+### Classic 3D Models
+- `14_utah_teapot.rb` - The famous Utah Teapot
+- `15_stanford_bunny.rb` - Stanford Bunny
+- `16_cornell_box.rb` - Cornell Box
+- `17_suzanne.rb` - Blender's Suzanne
+- `18_platonic_solids.rb` - Five Platonic solids
+
+Run an example:
+```bash
+ruby examples/01_hello_cube.rb
+```
+
+## API Reference
+
+### Vector3
+
+```ruby
+v = Sunrb::Vector3.new(1, 2, 3)
+
+v.length            # => 3.7416...
+v.normalize!        # Normalize in place
+v.normalized        # Return normalized copy
+
+v.dot(other)        # Dot product
+v.cross(other)      # Cross product
+
+v + other           # Addition
+v - other           # Subtraction
+v * scalar          # Scalar multiplication
+
+v.set(x, y, z)      # Set components
+v.copy(other)       # Copy from another vector
+v.clone             # Create a copy
+
+v.to_a              # => [1.0, 2.0, 3.0]
+v.to_h              # => {x: 1.0, y: 2.0, z: 3.0}
+```
+
+### Matrix4
+
+```ruby
+m = Sunrb::Matrix4.new
+
+m.identity!
+m.make_translation(x, y, z)
+m.make_rotation_x(angle)
+m.make_rotation_y(angle)
+m.make_rotation_z(angle)
+m.make_scale(x, y, z)
+
+m.multiply(other)
+m.invert!
+m.transpose!
+
+m.decompose(position, quaternion, scale)
+m.compose(position, quaternion, scale)
+
+m.make_perspective(fov, aspect, near, far)
+m.make_orthographic(left, right, top, bottom, near, far)
+m.look_at(eye, target, up)
+```
+
+### Object3D
+
+```ruby
+obj = Sunrb::Object3D.new
+
+obj.position        # Vector3
+obj.rotation        # Euler
+obj.quaternion      # Quaternion
+obj.scale           # Vector3
+
+obj.add(child)
+obj.remove(child)
+obj.children        # Array of children
+obj.parent          # Parent object
+
+obj.look_at(target)
+obj.update_matrix
+obj.update_world_matrix(update_parents, update_children)
+
+obj.traverse { |child| ... }
+obj.get_object_by_name(name)
+```
+
+### Mesh
+
+```ruby
+geometry = Sunrb::BoxGeometry.new(width: 1, height: 1, depth: 1)
+material = Sunrb::MeshStandardMaterial.new(
+  color: 0xff0000,
+  roughness: 0.5,
+  metalness: 0.5
+)
+mesh = Sunrb::Mesh.new(geometry, material)
+
+mesh.geometry       # BufferGeometry
+mesh.material       # Material
+```
+
+## Development
+
+```bash
+git clone https://github.com/ydah/3rb.git
+cd 3rb
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Run specific test
+bundle exec rspec spec/math/vector3_spec.rb
+```
+
+## Architecture
+
+```
+lib/3rb/
+├── animation/      # Animation system
+├── cameras/        # Camera types
+├── controls/       # OrbitControls
+├── core/           # Object3D, Scene, Group
+├── dsl/            # Ruby DSL
+├── ffi/            # FFI bindings
+│   ├── platform.rb # Platform detection
+│   ├── glfw.rb     # GLFW bindings
+│   └── opengl.rb   # OpenGL bindings
+├── geometries/     # Geometry primitives
+├── lights/         # Light types
+├── loaders/        # OBJ, GLTF loaders
+├── materials/      # Material types
+├── math/           # Vector, Matrix, etc.
+├── native/         # Native module wrappers
+│   ├── native.rb   # Sunrb::Native module
+│   ├── window.rb   # Window class
+│   └── gl.rb       # GL module
+├── objects/        # Mesh, Line, Points
+├── renderers/      # OpenGL renderer
+└── textures/       # Texture handling
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Acknowledgments
+
+- [Three.js](https://threejs.org/) - The inspiration for this library
+- [OpenGL](https://www.opengl.org/) - Graphics API
+- [GLFW](https://www.glfw.org/) - Window and input handling
+- [FFI](https://github.com/ffi/ffi) - Foreign Function Interface for Ruby

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/extensiontask"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::ExtensionTask.new("three_rb") do |ext|
+  ext.lib_dir = "lib/three_rb"
+end
+
+task default: :spec

data/examples/01_hello_cube.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Simple Cube - The most basic way to create a 3D scene
+
+require_relative "../lib/3rb"
+
+Sunrb.app do
+  background 0x1a1a2e
+
+  perspective_camera(fov: 75, near: 0.1, far: 1000) do
+    position 0, 0, 5
+  end
+
+  ambient_light color: 0x404040
+  directional_light(color: 0xffffff, intensity: 1.0) do
+    position 5, 5, 5
+  end
+
+  mesh :cube do
+    geometry :box, width: 1, height: 1, depth: 1
+    material :standard, color: 0x00ff00
+  end
+
+  on_frame do |delta|
+    cube.rotation.x += 0.01
+    cube.rotation.y += 0.01
+  end
+end

data/examples/02_basic_geometries.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Basic Geometries - All available primitive shapes
+
+require_relative "../lib/3rb"
+
+Sunrb.app do
+  background 0x2d3436
+
+  perspective_camera(fov: 60) do
+    position 0, 3, 12
+  end
+
+  ambient_light color: 0x404040
+  directional_light(intensity: 0.8) do
+    position 10, 10, 10
+  end
+
+  mesh :box do
+    geometry :box, width: 1.5, height: 1.5, depth: 1.5
+    material :standard, color: 0xe74c3c
+    position -4, 0, 0
+  end
+
+  mesh :sphere do
+    geometry :sphere, radius: 1, width_segments: 32, height_segments: 32
+    material :standard, color: 0x3498db
+    position -1.5, 0, 0
+  end
+
+  mesh :cylinder do
+    geometry :cylinder, radius_top: 0.5, radius_bottom: 0.8, height: 2
+    material :standard, color: 0x2ecc71
+    position 1.5, 0, 0
+  end
+
+  mesh :torus do
+    geometry :torus, radius: 0.8, tube: 0.3
+    material :standard, color: 0x9b59b6
+    position 4, 0, 0
+  end
+
+  mesh :plane do
+    geometry :plane, width: 15, height: 15
+    material :standard, color: 0x7f8c8d
+    position 0, -1.5, 0
+    rotation -Math::PI / 2, 0, 0
+  end
+
+  on_frame do |delta|
+    [box, sphere, cylinder, torus].each do |obj|
+      obj.rotation.y += 0.01
+    end
+  end
+end

data/examples/03_materials.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Material Types - Basic, Lambert, Phong, and Standard materials
+
+require_relative "../lib/3rb"
+
+Sunrb.app do
+  background 0x1a1a2e
+
+  perspective_camera(fov: 50) do
+    position 0, 2, 10
+  end
+
+  ambient_light color: 0x404040
+
+  point_light(color: 0xffffff, intensity: 1.0, distance: 50) do
+    position 5, 5, 5
+  end
+
+  point_light(color: 0x4488ff, intensity: 0.5, distance: 30) do
+    position -5, 3, -5
+  end
+
+  mesh :basic_sphere do
+    geometry :sphere, radius: 1
+    material :basic, color: 0xff6b6b
+    position -4.5, 0, 0
+  end
+
+  mesh :lambert_sphere do
+    geometry :sphere, radius: 1
+    material :lambert, color: 0x4ecdc4
+    position -1.5, 0, 0
+  end
+
+  mesh :phong_sphere do
+    geometry :sphere, radius: 1
+    material :phong, color: 0x45b7d1, shininess: 100
+    position 1.5, 0, 0
+  end
+
+  mesh :standard_sphere do
+    geometry :sphere, radius: 1
+    material :standard, color: 0xf9ca24, metalness: 0.3, roughness: 0.4
+    position 4.5, 0, 0
+  end
+
+  mesh :floor do
+    geometry :plane, width: 20, height: 20
+    material :standard, color: 0x2c3e50, roughness: 0.8
+    position 0, -1.5, 0
+    rotation -Math::PI / 2, 0, 0
+  end
+
+  on_frame do |delta|
+    [basic_sphere, lambert_sphere, phong_sphere, standard_sphere].each do |s|
+      s.rotation.y += 0.005
+    end
+  end
+end

data/examples/04_lighting.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Light Types - Ambient, Directional, Point, and Spot lights
+
+require_relative "../lib/3rb"
+
+Sunrb.app do
+  background 0x0a0a0a
+
+  perspective_camera(fov: 60) do
+    position 0, 8, 15
+    look_at 0, 0, 0
+  end
+
+  ambient_light color: 0x111111
+
+  directional_light(color: 0xffffcc, intensity: 0.5) do
+    position 10, 20, 10
+  end
+
+  point_light(color: 0xff0000, intensity: 1.0, distance: 15, decay: 2) do
+    position -5, 3, 0
+  end
+
+  point_light(color: 0x00ff00, intensity: 1.0, distance: 15, decay: 2) do
+    position 5, 3, 0
+  end
+
+  spot_light(
+    color: 0x0088ff,
+    intensity: 2.0,
+    distance: 30,
+    angle: Math::PI / 6,
+    penumbra: 0.3
+  ) do
+    position 0, 10, 0
+  end
+
+  mesh :floor do
+    geometry :plane, width: 30, height: 30
+    material :standard, color: 0x333333, roughness: 0.9
+    position 0, 0, 0
+    rotation -Math::PI / 2, 0, 0
+  end
+
+  5.times do |i|
+    5.times do |j|
+      mesh :"sphere_#{i}_#{j}" do
+        geometry :sphere, radius: 0.5
+        material :standard, color: 0xffffff, metalness: 0.1, roughness: 0.3
+        position (i - 2) * 3, 0.5, (j - 2) * 3
+      end
+    end
+  end
+
+  time = 0
+  on_frame do |delta|
+    time += delta
+    objects[:point_light_0]&.position&.x = Math.sin(time) * 5
+    objects[:point_light_1]&.position&.x = Math.cos(time) * 5
+  end
+end

data/examples/05_animation.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Keyframe Animation using AnimationClip and AnimationMixer
+
+require_relative "../lib/3rb"
+
+scene = Sunrb::Scene.new
+scene.background = Sunrb::Color.new(0x1a1a2e)
+
+camera = Sunrb::PerspectiveCamera.new(fov: 60, aspect: 800.0 / 600.0, near: 0.1, far: 1000)
+camera.position.set(0, 3, 8)
+camera.look_at(Sunrb::Vector3.new(0, 0, 0))
+
+geometry = Sunrb::BoxGeometry.new(width: 1, height: 1, depth: 1)
+material = Sunrb::MeshStandardMaterial.new(color: 0xff6b6b)
+cube = Sunrb::Mesh.new(geometry, material)
+scene.add(cube)
+
+ambient = Sunrb::AmbientLight.new(color: 0x404040)
+scene.add(ambient)
+
+directional = Sunrb::DirectionalLight.new(color: 0xffffff, intensity: 1.0)
+directional.position.set(5, 5, 5)
+scene.add(directional)
+
+position_track = Sunrb::VectorKeyframeTrack.new(
+  name: "position",
+  times: [0, 1, 2, 3, 4],
+  values: [
+    0, 0, 0,
+    2, 1, 0,
+    0, 2, 0,
+    -2, 1, 0,
+    0, 0, 0
+  ]
+)
+
+rotation_track = Sunrb::VectorKeyframeTrack.new(
+  name: "rotation",
+  times: [0, 2, 4],
+  values: [
+    0, 0, 0,
+    0, Math::PI, 0,
+    0, Math::PI * 2, 0
+  ]
+)
+
+scale_track = Sunrb::VectorKeyframeTrack.new(
+  name: "scale",
+  times: [0, 1, 2, 3, 4],
+  values: [
+    1, 1, 1,
+    1.5, 0.5, 1.5,
+    1, 1, 1,
+    0.5, 1.5, 0.5,
+    1, 1, 1
+  ]
+)
+
+clip = Sunrb::AnimationClip.new(
+  name: "cube_animation",
+  tracks: [position_track, rotation_track, scale_track]
+)
+
+mixer = Sunrb::AnimationMixer.new(cube)
+action = mixer.clip_action(clip)
+action.play
+
+puts "Animation clip duration: #{clip.duration}s"
+puts "Tracks: #{clip.tracks.map(&:name).join(', ')}"
+puts "Press ESC to exit"
+
+renderer = Sunrb::OpenGLRenderer.new(width: 800, height: 600, title: "Animation Example")
+
+renderer.run do |delta|
+  mixer.update(delta)
+  renderer.render(scene, camera)
+end