mittsu-gltf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7357b9b37036619cd1dcac6a0272db90d88f6e0caf567805c4df6f15ada7c272
+  data.tar.gz: e9ee54d8195e9b1635163fccc9855dc9bd3a3b61333f2c8b61ac620e65899f84
+SHA512:
+  metadata.gz: 9c66bb2249b83c4b1b7f8291ab8e619851c08dc462eb0310f08ca0198f9c20bd8cd5f9199f82d438d0dc9cc6dedadd7013129a19eec387942318efa8ef55f41b
+  data.tar.gz: 4dc4dd25b9001add1c635608dcd3d769a5c4c3828f7a915f33e0694b3c91c697af9120b46b293b56cad9a5338096f1dea88031ee38827048077a2d7ccff370fc

data/README.md

@@ -0,0 +1,25 @@
+# Mittsu: GLTF
+GLTF support for [Mittsu](https://github.com/danini-the-panini/mittsu).
+
+## Installation
+
+Just install:
+
+`bundle add mittsu-gltf`
+
+Then require in your code:
+
+`require 'mittsu/gltf'`
+
+## Usage
+
+Currently this gem just includes an exporter. Loading GLTF files might happen at some point.
+
+```
+exporter = Mittsu::GLTFExporter.new
+exporter.export(object, "output.gltf")
+```
+
+## About
+
+This code was originally written for [Manyfold](https://manyfold.app), supported by funding from [NLNet](https://nlnet.nl) and [NGI Zero](https://ngi.eu/ngi-projects/ngi-zero/).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+require "standard/rake"
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mittsu/gltf/exporter.rb

@@ -0,0 +1,168 @@
+require "jbuilder"
+require "base64"
+
+module Mittsu
+  class GLTFExporter
+    COMPONENT_TYPES = {
+      # 8 bit
+      byte: 5120,
+      unsigned_byte: 5121,
+      # 16 bit
+      short: 5122,
+      unsigned_short: 5123,
+      # 32 bit
+      unsigned_int: 5125,
+      float: 5126
+    }.freeze
+
+    GPU_BUFFER_TYPES = {
+      array_buffer: 34962,
+      element_array_buffer: 34963
+    }
+
+    ELEMENT_TYPES = [
+      "SCALAR",
+      "VEC2",
+      "VEC3",
+      "VEC4",
+      "MAT2",
+      "MAT3",
+      "MAT4"
+    ].freeze
+
+    def initialize(options = {})
+      @node_indexes = []
+      @nodes = []
+      @buffers = []
+      @meshes = []
+      @buffer_views = []
+      @accessors = []
+    end
+
+    def export(object, filename)
+      object.traverse do |obj|
+        @node_indexes << add_mesh(obj) if obj.is_a? Mittsu::Mesh
+      end
+      File.write(
+        filename,
+        Jbuilder.new do |json|
+          json.asset do
+            json.generator "Mittsu-GLTF"
+            json.version "2.0"
+          end
+          json.scene 0
+          json.scenes [{
+            nodes: @node_indexes
+          }]
+          json.nodes { json.array! @nodes }
+          json.meshes { json.array! @meshes }
+          json.buffers { json.array! @buffers }
+          json.bufferViews { json.array! @buffer_views }
+          json.accessors { json.array! @accessors }
+        end.target!
+      )
+    end
+
+    # Parse is here for consistency with THREE.js's weird naming of exporter methods
+    alias_method :parse, :export
+
+    private
+
+    def add_mesh(mesh)
+      # Pack faces into an array
+      pack_string = (mesh.geometry.faces.count > (2**16)) ? "L<*" : "S<*"
+      faces = mesh.geometry.faces.map { |x| [x.a, x.b, x.c] }
+      data = faces.flatten.pack(pack_string)
+      # Add bufferView and accessor for faces
+      face_accessor_index = add_accessor(
+        buffer_view: add_buffer_view(
+          buffer: @buffers.count,
+          offset: 0,
+          length: data.length,
+          target: :element_array_buffer
+        ),
+        component_type: (mesh.geometry.faces.count > (2**16)) ? :unsigned_int : :unsigned_short,
+        count: mesh.geometry.faces.count * 3,
+        type: "SCALAR",
+        min: 0,
+        max: mesh.geometry.vertices.count - 1
+      )
+      # Add padding to get to integer multiple of float size
+      padding = 4 - (data.length % 4)
+      data += Array.new(padding, 0).pack("C*")
+      # Pack vertices in as floats
+      offset = data.length
+      vertices = mesh.geometry.vertices.map(&:elements)
+      data += vertices.flatten.pack("f*")
+      # Add bufferView and accessor for vertices
+      mesh.geometry.compute_bounding_box
+      vertex_accessor_index = add_accessor(
+        buffer_view: add_buffer_view(
+          buffer: @buffers.count,
+          offset: offset,
+          length: data.length - offset,
+          target: :array_buffer
+        ),
+        component_type: :float,
+        count: mesh.geometry.vertices.count,
+        type: "VEC3",
+        min: mesh.geometry.bounding_box.min.elements,
+        max: mesh.geometry.bounding_box.max.elements
+      )
+      # Encode and store in buffers
+      @buffers << {
+        uri: "data:application/octet-stream;base64," + Base64.strict_encode64(data),
+        byteLength: data.length
+      }
+      # Add mesh
+      mesh_index = @meshes.count
+      @meshes << {
+        "primitives" => [
+          {
+            "attributes" => {
+              "POSITION" => vertex_accessor_index
+            },
+            "indices" => face_accessor_index
+          }
+        ]
+      }
+      # Add node
+      index = @nodes.count
+      @nodes << {
+        mesh: mesh_index
+      }
+      index
+    end
+
+    def add_buffer_view(buffer:, offset:, length:, target: nil)
+      # Check args
+      raise ArgumentError.new("invalid GPU buffer target: #{target}") unless target.nil? || GPU_BUFFER_TYPES.keys.include?(target)
+      index = @buffer_views.count
+      @buffer_views << {
+        buffer: buffer,
+        byteOffset: offset,
+        byteLength: length,
+        target: GPU_BUFFER_TYPES[target]
+      }
+      index
+    end
+
+    def add_accessor(buffer_view:, component_type:, count:, type:, min:, max:, offset: 0)
+      # Check args
+      raise ArgumentError.new("invalid component type: #{component_type}") unless COMPONENT_TYPES.key?(component_type)
+      raise ArgumentError.new("invalid element type: #{type}") unless ELEMENT_TYPES.include?(type)
+      # Add data
+      index = @accessors.count
+      @accessors << {
+        bufferView: buffer_view,
+        byteOffset: offset,
+        componentType: COMPONENT_TYPES[component_type],
+        count: count,
+        type: type,
+        min: Array(min),
+        max: Array(max)
+      }
+      index
+    end
+  end
+end

data/lib/mittsu/gltf/version.rb

@@ -0,0 +1,5 @@
+module Mittsu
+  module GLTF
+    VERSION = "0.1.0"
+  end
+end

data/lib/mittsu/gltf.rb

@@ -0,0 +1,3 @@
+require "mittsu"
+require "mittsu/gltf/version"
+require "mittsu/gltf/exporter"

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: mittsu-gltf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mittsu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: GLTF file support for Mittsu
+email:
+- james@floppy.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/mittsu/gltf.rb
+- lib/mittsu/gltf/exporter.rb
+- lib/mittsu/gltf/version.rb
+homepage: https://github.com/manyfold3d/mittsu-gltf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/manyfold3d/mittsu-gltf
+  source_code_uri: https://github.com/manyfold3d/mittsu-gltf
+  changelog_uri: https://github.com/manyfold3d/mittsu-gltf/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: GLTF file support for Mittsu
+test_files: []