arcanoae 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40ce75e91b0d590d01a6943c1ae4a2a45bd464226efb829342f7c629f1457093
+  data.tar.gz: 11e2c068f79fab39aefa4afc39dabe8fc9fc9b38702361b399c892596683ca8b
+SHA512:
+  metadata.gz: 2e25835485b38ad8aeacb4d27aafe9817975fa880df95fb40dc866183a93ed6969c2b1ce23c7e8d99b34367abc875ea8dea9263a80d2527b28b46c263c08a61f
+  data.tar.gz: dce34d4f77614ab207bb6d6009b080f6bf001f920b558f3c39c9a60c87d8f26db304725f42b9a852625c8edfa33699183cc68b8a5bebcb1b79936cacf2eacc45

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 - 2026-01-01
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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,128 @@
+# Arcanoae
+
+A 3D graphics library for Ruby with Babylon.js-like API.
+
+Arcanoae provides Babylon.js-equivalent functionality using OpenGL backend.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arcanoae'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install arcanoae
+```
+
+## Usage
+
+```ruby
+require "arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 800,
+  height: 600,
+  title: "Arcanoae - Hello World"
+)
+
+scene = Arcanoae::Scene::Scene.new(engine)
+engine.add_scene(scene)
+
+camera = Arcanoae::Cameras::ArcRotateCamera.new(
+  "MainCamera",
+  Math::PI / 4,
+  Math::PI / 3,
+  10,
+  Arcanoae::Math::Vector3.zero,
+  scene
+)
+
+light = Arcanoae::Lights::HemisphericLight.new(
+  "Light",
+  Arcanoae::Math::Vector3.up,
+  scene
+)
+light.intensity = 1.0
+
+sphere = Arcanoae::Meshes::MeshBuilder.create_sphere("Sphere", { diameter: 2 }, scene)
+sphere.position = Arcanoae::Math::Vector3.new(0, 1, 0)
+
+mat = Arcanoae::Materials::StandardMaterial.new("SphereMat", scene)
+mat.diffuse_color = Arcanoae::Math::Color3.new(0.4, 0.4, 1.0)
+sphere.material = mat
+
+engine.run_render_loop do
+end
+```
+
+## Features
+
+### Core
+- Scene graph with transform nodes
+- Cameras (Perspective, ArcRotate)
+- Lights (Point, Directional, Hemispheric)
+- Shadow mapping
+
+### Rendering
+- Materials (Standard, PBR)
+- Mesh primitives (Box, Sphere, Plane, Cylinder, Torus, etc.)
+- Textures (PNG, JPEG)
+- Post-processing effects (FXAA, Blur)
+
+### Animation
+- Keyframe animations
+- Animation groups
+- Easing functions (Bounce, Elastic, Cubic, etc.)
+
+### Additional
+- Physics engine
+- Particle systems
+- GUI controls
+- Audio system (3D spatial sound)
+- Model loaders (glTF, OBJ)
+- Input management (Keyboard, Mouse, Gamepad)
+
+## Examples
+
+See the `examples/` directory for usage examples.
+
+## Documentation
+
+- [Getting Started](docs/getting_started.md)
+- [Tutorial 01: First Scene](docs/tutorials/01_first_scene.md)
+- [Tutorial 02: Materials](docs/tutorials/02_materials.md)
+- [Tutorial 03: Animation](docs/tutorials/03_animation.md)
+
+Generate API documentation:
+
+```bash
+bundle exec rake yard
+```
+
+## Development
+
+After checking out the repo:
+
+```bash
+bundle install
+bundle exec rspec  # Run tests
+bundle exec rake yard  # Generate documentation
+```
+
+## Acknowledgments
+
+This project is inspired by [Babylon.js](https://www.babylonjs.com/), a powerful, beautiful, simple, and open game and rendering engine. We are grateful to the Babylon.js team for their excellent work and API design.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/arcanoae.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/arcanoae/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "arcanoae"
+  spec.version = Arcanoae::VERSION
+  spec.authors = ["Yudai Takada"]
+  spec.email = ["t.yudai92@gmail.com"]
+
+  spec.summary = "A 3D graphics library for Ruby with Babylon.js-like API"
+  spec.description = "Arcanoae is a 3D graphics library for Ruby that provides " \
+                     "Babylon.js-equivalent functionality using OpenGL/Vulkan backends."
+  spec.homepage = "https://github.com/ydah/arcanoae"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.glob("{lib,shaders,examples}/**/*", File::FNM_DOTMATCH, base: __dir__).reject { |f| File.directory?(f) } +
+               %w[LICENSE.txt README.md CHANGELOG.md arcanoae.gemspec].select { |f| File.exist?(File.join(__dir__, f)) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "base64"
+  spec.add_dependency "json"
+  spec.add_dependency "ffi"
+end

data/examples/01_hello_world.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 800,
+  height: 600,
+  title: "Arcanoae - Hello World"
+)
+
+scene = Arcanoae::Scene::Scene.new(engine)
+engine.add_scene(scene)
+
+camera = Arcanoae::Cameras::ArcRotateCamera.new(
+  "MainCamera",
+  ::Math::PI / 4,
+  ::Math::PI / 3,
+  10,
+  Arcanoae::Math::Vector3.zero,
+  scene
+)
+
+light = Arcanoae::Lights::HemisphericLight.new(
+  "Light",
+  Arcanoae::Math::Vector3.up,
+  scene
+)
+light.intensity = 1.0
+
+sphere = Arcanoae::Meshes::MeshBuilder.create_sphere("Sphere", { diameter: 2 }, scene)
+sphere.position = Arcanoae::Math::Vector3.new(0, 1, 0)
+
+mat = Arcanoae::Materials::StandardMaterial.new("SphereMat", scene)
+mat.diffuse_color = Arcanoae::Math::Color3.new(0.4, 0.4, 1.0)
+sphere.material = mat
+
+ground = Arcanoae::Meshes::MeshBuilder.create_ground("Ground", { width: 10, height: 10 }, scene)
+ground_mat = Arcanoae::Materials::StandardMaterial.new("GroundMat", scene)
+ground_mat.diffuse_color = Arcanoae::Math::Color3.new(0.5, 0.5, 0.5)
+ground.material = ground_mat
+
+puts "Arcanoae - Hello World"
+puts "Press ESC or close window to exit"
+
+engine.run_render_loop do
+end

data/examples/02_basic_shapes.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 1024,
+  height: 768,
+  title: "Arcanoae - Basic Shapes"
+)
+
+scene = Arcanoae.scene(engine) do
+  camera :arc_rotate, "Camera" do
+    alpha ::Math::PI / 4
+    beta ::Math::PI / 3
+    radius 15
+    target 0, 0, 0
+  end
+
+  light :hemispheric, "Light" do
+    intensity 0.8
+  end
+
+  mesh :box, "Box" do
+    position -4, 1, 0
+    material { diffuse_color 1, 0, 0 }
+  end
+
+  mesh :sphere, "Sphere", diameter: 2 do
+    position -1.5, 1, 0
+    material { diffuse_color 0, 1, 0 }
+  end
+
+  mesh :cylinder, "Cylinder", diameter: 1, height: 2 do
+    position 1.5, 1, 0
+    material { diffuse_color 0, 0, 1 }
+  end
+
+  mesh :torus, "Torus", diameter: 1.5, thickness: 0.5 do
+    position 4, 1, 0
+    material { diffuse_color 1, 1, 0 }
+  end
+
+  mesh :ground, "Ground", width: 15, height: 15 do
+    material { diffuse_color 0.5, 0.5, 0.5 }
+  end
+end
+
+engine.add_scene(scene)
+
+puts "Arcanoae - Basic Shapes"
+puts "Created #{scene.meshes.count} meshes:"
+scene.meshes.each do |mesh|
+  puts "  - #{mesh.name} at #{mesh.position}"
+end
+puts "Press ESC or close window to exit"
+
+engine.run_render_loop

data/examples/03_materials.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 1024,
+  height: 768,
+  title: "Arcanoae - Materials"
+)
+
+scene = Arcanoae.scene(engine) do
+  camera :arc_rotate, "Camera" do
+    alpha ::Math::PI / 4
+    beta ::Math::PI / 4
+    radius 12
+    target 0, 0, 0
+  end
+
+  light :hemispheric, "HemiLight" do
+    direction 0, 1, 0
+    intensity 0.7
+    ground_color 0.2, 0.2, 0.3
+  end
+
+  light :point, "PointLight" do
+    position 3, 5, 3
+    intensity 0.5
+  end
+
+  mesh :sphere, "Matte", diameter: 2 do
+    position -3, 1, 0
+    material do
+      diffuse_color 1, 0.3, 0.3
+      specular_power 4
+    end
+  end
+
+  mesh :sphere, "Shiny", diameter: 2 do
+    position 0, 1, 0
+    material do
+      diffuse_color 0.3, 1, 0.3
+      specular_color 1, 1, 1
+      specular_power 128
+    end
+  end
+
+  mesh :sphere, "Emissive", diameter: 2 do
+    position 3, 1, 0
+    material do
+      diffuse_color 0.3, 0.3, 1
+      emissive_color 0.2, 0.2, 0.5
+    end
+  end
+
+  mesh :ground, "Ground", width: 12, height: 12 do
+    material { diffuse_color 0.4, 0.4, 0.4 }
+  end
+end
+
+engine.add_scene(scene)
+
+puts "Arcanoae - Material Comparison"
+puts "Left: Matte (low specular power)"
+puts "Center: Shiny (high specular power)"
+puts "Right: Emissive (self-illuminating)"
+puts "Press ESC or close window to exit"
+
+engine.run_render_loop

data/examples/04_textures.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 1024,
+  height: 768,
+  title: "Arcanoae - Textures"
+)
+
+scene = Arcanoae::Scene::Scene.new(engine)
+engine.add_scene(scene)
+
+camera = Arcanoae::Cameras::ArcRotateCamera.new(
+  "Camera", ::Math::PI / 4, ::Math::PI / 3, 10,
+  Arcanoae::Math::Vector3.zero, scene
+)
+
+Arcanoae::Lights::HemisphericLight.new("Light", Arcanoae::Math::Vector3.up, scene)
+
+box = Arcanoae::Meshes::MeshBuilder.create_box("TexturedBox", { size: 2 }, scene)
+box.position = Arcanoae::Math::Vector3.new(-2, 1, 0)
+
+box_mat = Arcanoae::Materials::StandardMaterial.new("BoxMat", scene)
+box_mat.diffuse_color = Arcanoae::Math::Color3.new(1, 1, 1)
+box.material = box_mat
+
+sphere = Arcanoae::Meshes::MeshBuilder.create_sphere("TexturedSphere", { diameter: 2 }, scene)
+sphere.position = Arcanoae::Math::Vector3.new(2, 1, 0)
+
+sphere_mat = Arcanoae::Materials::StandardMaterial.new("SphereMat", scene)
+sphere_mat.diffuse_color = Arcanoae::Math::Color3.new(0.8, 0.8, 1.0)
+sphere.material = sphere_mat
+
+ground = Arcanoae::Meshes::MeshBuilder.create_ground("Ground", { width: 10, height: 10 }, scene)
+ground_mat = Arcanoae::Materials::StandardMaterial.new("GroundMat", scene)
+ground_mat.diffuse_color = Arcanoae::Math::Color3.new(0.4, 0.4, 0.4)
+ground.material = ground_mat
+
+puts "Arcanoae - Textures Example"
+puts "Materials with texture support:"
+scene.materials.each do |mat|
+  puts "  - #{mat.name}: diffuse_color=#{mat.diffuse_color}"
+end
+puts "Press ESC or close window to exit"
+
+engine.run_render_loop

data/examples/05_lighting.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 1024,
+  height: 768,
+  title: "Arcanoae - Lighting"
+)
+
+scene = Arcanoae::Scene::Scene.new(engine)
+engine.add_scene(scene)
+
+camera = Arcanoae::Cameras::ArcRotateCamera.new(
+  "Camera",
+  ::Math::PI / 4,
+  ::Math::PI / 3,
+  15,
+  Arcanoae::Math::Vector3.zero,
+  scene
+)
+
+hemi = Arcanoae::Lights::HemisphericLight.new(
+  "HemiLight",
+  Arcanoae::Math::Vector3.up,
+  scene
+)
+hemi.intensity = 0.3
+hemi.diffuse = Arcanoae::Math::Color3.new(0.8, 0.8, 1.0)
+hemi.ground_color = Arcanoae::Math::Color3.new(0.2, 0.1, 0.1)
+
+point = Arcanoae::Lights::PointLight.new(
+  "PointLight",
+  Arcanoae::Math::Vector3.new(3, 5, 3),
+  scene
+)
+point.intensity = 0.8
+point.diffuse = Arcanoae::Math::Color3.new(1, 0.9, 0.7)
+
+directional = Arcanoae::Lights::DirectionalLight.new(
+  "DirLight",
+  Arcanoae::Math::Vector3.new(-1, -2, -1),
+  scene
+)
+directional.intensity = 0.4
+directional.diffuse = Arcanoae::Math::Color3.new(0.7, 0.7, 1)
+
+sphere = Arcanoae::Meshes::MeshBuilder.create_sphere("Sphere", { diameter: 2 }, scene)
+sphere.position = Arcanoae::Math::Vector3.new(0, 1, 0)
+
+mat = Arcanoae::Materials::StandardMaterial.new("SphereMat", scene)
+mat.diffuse_color = Arcanoae::Math::Color3.new(1, 1, 1)
+sphere.material = mat
+
+ground = Arcanoae::Meshes::MeshBuilder.create_ground("Ground", { width: 10, height: 10 }, scene)
+ground_mat = Arcanoae::Materials::StandardMaterial.new("GroundMat", scene)
+ground_mat.diffuse_color = Arcanoae::Math::Color3.new(0.5, 0.5, 0.5)
+ground.material = ground_mat
+
+puts "Arcanoae - Lighting Demo"
+puts "Lights in scene: #{scene.lights.count}"
+scene.lights.each { |l| puts "  - #{l.class.name.split('::').last}: #{l.name}" }
+puts "Press ESC or close window to exit"
+
+engine.run_render_loop

data/examples/06_camera_controls.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 1024,
+  height: 768,
+  title: "Arcanoae - Camera Controls"
+)
+
+scene = Arcanoae::Scene::Scene.new(engine)
+engine.add_scene(scene)
+
+arc_camera = Arcanoae::Cameras::ArcRotateCamera.new(
+  "ArcRotate",
+  ::Math::PI / 4,
+  ::Math::PI / 3,
+  10,
+  Arcanoae::Math::Vector3.zero,
+  scene
+)
+arc_camera.lower_radius_limit = 5
+arc_camera.upper_radius_limit = 20
+arc_camera.lower_beta_limit = 0.1
+arc_camera.upper_beta_limit = ::Math::PI / 2
+
+Arcanoae::Lights::HemisphericLight.new("Light", Arcanoae::Math::Vector3.up, scene)
+
+box = Arcanoae::Meshes::MeshBuilder.create_box("Box", { size: 2 }, scene)
+box.position = Arcanoae::Math::Vector3.new(0, 1, 0)
+box_mat = Arcanoae::Materials::StandardMaterial.new("BoxMat", scene)
+box_mat.diffuse_color = Arcanoae::Math::Color3.new(0.4, 0.6, 0.9)
+box.material = box_mat
+
+ground = Arcanoae::Meshes::MeshBuilder.create_ground("Ground", { width: 10, height: 10 }, scene)
+ground_mat = Arcanoae::Materials::StandardMaterial.new("GroundMat", scene)
+ground_mat.diffuse_color = Arcanoae::Math::Color3.new(0.5, 0.5, 0.5)
+ground.material = ground_mat
+
+puts "Arcanoae - Camera Controls"
+puts "ArcRotateCamera settings:"
+puts "  Alpha: #{arc_camera.alpha.round(2)} rad"
+puts "  Beta: #{arc_camera.beta.round(2)} rad"
+puts "  Radius: #{arc_camera.radius}"
+puts "  Radius limits: #{arc_camera.lower_radius_limit} - #{arc_camera.upper_radius_limit}"
+puts "Press ESC or close window to exit"
+
+engine.run_render_loop

data/examples/07_animation.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/arcanoae"
+
+engine = Arcanoae::Core::Engine.new(
+  width: 1024,
+  height: 768,
+  title: "Arcanoae - Animation"
+)
+
+scene = Arcanoae::Scene::Scene.new(engine)
+engine.add_scene(scene)
+
+camera = Arcanoae::Cameras::ArcRotateCamera.new(
+  "Camera", ::Math::PI / 4, ::Math::PI / 3, 10,
+  Arcanoae::Math::Vector3.zero, scene
+)
+
+Arcanoae::Lights::HemisphericLight.new("Light", Arcanoae::Math::Vector3.up, scene)
+
+box = Arcanoae::Meshes::MeshBuilder.create_box("Box", { size: 1 }, scene)
+box.position = Arcanoae::Math::Vector3.new(0, 0.5, 0)
+
+mat = Arcanoae::Materials::StandardMaterial.new("BoxMat", scene)
+mat.diffuse_color = Arcanoae::Math::Color3.new(0.4, 0.6, 0.8)
+box.material = mat
+
+ground = Arcanoae::Meshes::MeshBuilder.create_ground("Ground", { width: 10, height: 10 }, scene)
+ground_mat = Arcanoae::Materials::StandardMaterial.new("GroundMat", scene)
+ground_mat.diffuse_color = Arcanoae::Math::Color3.new(0.5, 0.5, 0.5)
+ground.material = ground_mat
+
+position_anim = Arcanoae::Animation::Animation.new(
+  "positionY",
+  "position.y",
+  30,
+  Arcanoae::Animation::Animation::ANIMATIONTYPE_FLOAT,
+  Arcanoae::Animation::Animation::ANIMATIONLOOPMODE_CYCLE
+)
+position_anim.set_keys([
+  { frame: 0, value: 0.5 },
+  { frame: 30, value: 2.5 },
+  { frame: 60, value: 0.5 }
+])
+
+rotation_anim = Arcanoae::Animation::Animation.new(
+  "rotationY",
+  "rotation.y",
+  30,
+  Arcanoae::Animation::Animation::ANIMATIONTYPE_FLOAT,
+  Arcanoae::Animation::Animation::ANIMATIONLOOPMODE_CYCLE
+)
+rotation_anim.set_keys([
+  { frame: 0, value: 0 },
+  { frame: 60, value: ::Math::PI * 2 }
+])
+
+ease = Arcanoae::Animation::EasingFunction::SineEase.new
+ease.easing_mode = Arcanoae::Animation::EasingFunction::EASINGMODE_EASEINOUT
+position_anim.easing_function = ease
+
+box.animations = [position_anim, rotation_anim]
+
+anim_group = Arcanoae::Animation::AnimationGroup.new("BoxAnimations", scene)
+anim_group.add_targeted_animation(position_anim, box)
+anim_group.add_targeted_animation(rotation_anim, box)
+anim_group.start(loop: true)
+
+puts "Arcanoae - Animation Example"
+puts "  - Position animation with SineEase"
+puts "  - Rotation animation (linear)"
+puts "Animation group: #{anim_group.name}"
+puts "Press ESC or close window to exit"
+
+start_time = Time.now
+scene.before_render do
+  elapsed = Time.now - start_time
+  frame = (elapsed * 30).to_i % 60
+  anim_group.update(frame)
+end
+
+engine.run_render_loop