mittsu-gltf 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7357b9b37036619cd1dcac6a0272db90d88f6e0caf567805c4df6f15ada7c272
-  data.tar.gz: e9ee54d8195e9b1635163fccc9855dc9bd3a3b61333f2c8b61ac620e65899f84
+  metadata.gz: 5f23eb33ddc959a9590cd7a980c9c82d5f94a5377d8837c50ffdbe1b71b82088
+  data.tar.gz: efd9a91fbb9830b4ca9e40b802de5ba7dd1af7eb6ef15799e624f31187abdec5
 SHA512:
-  metadata.gz: 9c66bb2249b83c4b1b7f8291ab8e619851c08dc462eb0310f08ca0198f9c20bd8cd5f9199f82d438d0dc9cc6dedadd7013129a19eec387942318efa8ef55f41b
-  data.tar.gz: 4dc4dd25b9001add1c635608dcd3d769a5c4c3828f7a915f33e0694b3c91c697af9120b46b293b56cad9a5338096f1dea88031ee38827048077a2d7ccff370fc
+  metadata.gz: 8245cd6f0a0ffedc302328322bb24fba2644246f92e238eb83b2245815d8de42ab6aabeccf5d93d75f05348cbe3950996c909b97da6e5f19758807dcba7b01dc
+  data.tar.gz: deba7453768e7aaa50af38dcd714be4ce189b708b6a1bcb8141b59047ba74c292d53cd27a4e2b23cc4d6d4f4d3925ec535c37ade0775d3947f1ed20d5d432403

data/README.md

@@ -20,6 +20,12 @@ exporter = Mittsu::GLTFExporter.new
 exporter.export(object, "output.gltf")
 ```
 
+You can also write binary files for simple single-mesh models:
+
+```
+exporter.export(object, "output.glb", mode: :binary)
+```
+
 ## 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/lib/mittsu/gltf/exporter.rb

@@ -37,30 +37,45 @@ module Mittsu
       @meshes = []
       @buffer_views = []
       @accessors = []
+      @binary_buffer = nil
     end
 
-    def export(object, filename)
+    def export(object, filename, mode: :ascii)
+      initialize
       object.traverse do |obj|
-        @node_indexes << add_mesh(obj) if obj.is_a? Mittsu::Mesh
+        @node_indexes << add_mesh(obj, mode: mode) if obj.is_a? Mittsu::Mesh
+      end
+      json = 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!
+      case mode
+      when :ascii
+        File.write(filename, json)
+      when :binary
+        File.open(filename, "wb") do |file|
+          size = 12 +
+            8 + json.length + padding_required(json, stride: 4) +
+            8 + @binary_buffer.length + padding_required(@binary_buffer, stride: 4)
+          file.write("glTF")
+          file.write([2, size].pack("L<*"))
+          write_chunk(file, :json, json)
+          write_chunk(file, :binary, @binary_buffer)
+        end
+      else
+        raise ArgumentError "Invalid output mode #{mode}"
       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
@@ -68,7 +83,22 @@ module Mittsu
 
     private
 
-    def add_mesh(mesh)
+    def write_chunk(file, type, data)
+      pad = padding_required(data, stride: 4)
+      file.write([data.length + pad].pack("L<*"))
+      case type
+      when :json
+        file.write("JSON")
+      when :binary
+        file.write("BIN\0")
+      else
+        raise ArgumentError.new("Invalid chunk type: #{type}")
+      end
+      file.write data
+      file.write(Array.new(pad, (type == :json) ? 32 : 0).pack("C*")) # Space characters for JSON, null otherwise
+    end
+
+    def add_mesh(mesh, mode:)
       # 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] }
@@ -88,7 +118,7 @@ module Mittsu
         max: mesh.geometry.vertices.count - 1
       )
       # Add padding to get to integer multiple of float size
-      padding = 4 - (data.length % 4)
+      padding = padding_required(data, stride: 4)
       data += Array.new(padding, 0).pack("C*")
       # Pack vertices in as floats
       offset = data.length
@@ -110,10 +140,13 @@ module Mittsu
         max: mesh.geometry.bounding_box.max.elements
       )
       # Encode and store in buffers
-      @buffers << {
+      @buffers << ((mode == :ascii) ? {
         uri: "data:application/octet-stream;base64," + Base64.strict_encode64(data),
         byteLength: data.length
-      }
+      } : {
+        byteLength: data.length
+      })
+      @binary_buffer = data if mode == :binary
       # Add mesh
       mesh_index = @meshes.count
       @meshes << {
@@ -136,7 +169,7 @@ module Mittsu
 
     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)
+      raise ArgumentError.new("invalid GPU buffer target: #{target}") unless target.nil? || GPU_BUFFER_TYPES.key?(target)
       index = @buffer_views.count
       @buffer_views << {
         buffer: buffer,
@@ -164,5 +197,9 @@ module Mittsu
       }
       index
     end
+
+    def padding_required(data, stride: 4)
+      (stride - (data.length % stride)) % stride
+    end
   end
 end

data/lib/mittsu/gltf/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mittsu-gltf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Smith
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2024-12-12 00:00:00.000000000 Z
@@ -127,7 +127,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.5.22
+signing_key: 
 specification_version: 4
 summary: GLTF file support for Mittsu
 test_files: []