mittsu-mesh_analysis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d47802f05e6d13d939200e31a91f09ebf5e6ae2216ec16848de5d8bda17ac67
+  data.tar.gz: b6368785eea78b3bb306289e9cd7d029c65f25d27f7ebee3d337fa71dcf897d3
+SHA512:
+  metadata.gz: 3910ffd5663e977d5458908c1068f6918f498d2508fe971ef4fb3d4fd9315adc62c895278633455a9da2cead18bf05ddfbcf48f7b906d0e80c1af443e414d8dd
+  data.tar.gz: cc3ca365897a18c83a8b746d872019179c043ab81a4f430358e52062c242a663e03bd6b8d5070aa7916aa7ea22a13bcdeac2321c757b3d63cee0efad8ff37e94

data/README.md

@@ -0,0 +1,29 @@
+# Mittsu: Mesh Analysis
+
+Mesh analysis methods for [Mittsu](https://github.com/danini-the-panini/mittsu).
+
+Adds three methods:
+
+* `Mittsu::Object3D#manifold?`: Detects if a mesh is a single valid surface; i.e. it has no holes, and faces are consistently oriented.
+* `Mittsu::Object3D#solid?`: Detects if the faces of a manifold mesh are correctly oriented, giving the mesh a sensible inside and outside.
+* `Mittsu::Face3#flip!`: Flips the vertex order, and thus orientation of a particular face.
+
+## Requirements
+
+Ruby 3.1 or above, otherwise the same as for [Mittsu](https://github.com/danini-the-panini/mittsu) itself.
+
+## Usage
+
+Just install:
+
+`bundle add mittsu-mesh_analysis`
+
+Then require in your code:
+
+`require 'mittsu/mesh_analysis'`
+
+The methods above should then be available for use.
+
+## 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,10 @@
+require "bundler/setup"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mittsu/mesh_analysis/analysis.rb

@@ -0,0 +1,52 @@
+module Mittsu::MeshAnalysis::Analysis
+  def solid?
+    # Shortcut if there is nothing here
+    return true if geometry.nil? && children.empty?
+    # Recurse children to see if they are solid
+    children_are_solid = children.map { |x| x.solid? }.all?
+    solid = true
+    if geometry
+      # Make sure material is double sided
+      prev_side = material.side
+      material.side = Mittsu::DoubleSide
+      # Make a raycaster from a vertex and the face normal
+      face = geometry.faces.first
+      r = Mittsu::Raycaster.new(geometry.vertices[face.b], face.normal, 1e-9)
+      intersections = r.intersect_object(self, true)
+      # Restore material
+      material.side = prev_side
+      # We want an even number of intersections
+      solid = (intersections.length % 2 == 0)
+    end
+    solid && children_are_solid
+  end
+
+  def manifold?
+    # Shortcut if there is nothing here
+    return true if geometry.nil? && children.empty?
+    # Recurse children to see if they are manifold
+    children_are_manifold = children.map { |x| x.manifold? }.all?
+    # Detect manifold geometry in this object
+    edges = {}
+    # For each face, record its edges in the edge hash
+    geometry&.faces&.each do |face|
+      update_edge_hash face.a, face.b, edges
+      update_edge_hash face.b, face.c, edges
+      update_edge_hash face.c, face.a, edges
+    end
+    # If there's anything left in the edge hash, then either
+    # we have holes, or we have badly oriented faces
+    edges.empty? && children_are_manifold
+  end
+
+  private
+
+  # Updates edge hash with the passed vertex indexes
+  # First, the reverse edge is searched for in the hash
+  # If found, it's removed as we've got a match
+  # If not, we record this edge in the hash
+  def update_edge_hash(v1, v2, edges)
+    return if edges.delete "#{v2}->#{v1}"
+    edges["#{v1}->#{v2}"] = true
+  end
+end

data/lib/mittsu/mesh_analysis/version.rb

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

data/lib/mittsu/mesh_analysis.rb

@@ -0,0 +1,17 @@
+require "mittsu"
+require "mittsu/mesh_analysis/version"
+require "mittsu/mesh_analysis/analysis"
+
+module Mittsu
+  class Object3D
+    include Mittsu::MeshAnalysis::Analysis
+  end
+
+  class Face3
+    def flip!
+      tmp = @a
+      @a = @c
+      @c = tmp
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mittsu-mesh_analysis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-13 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: 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'
+description: Mesh analysis tools (e.g. manifold checks) for Mittsu.
+email:
+- james@floppy.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/mittsu/mesh_analysis.rb
+- lib/mittsu/mesh_analysis/analysis.rb
+- lib/mittsu/mesh_analysis/version.rb
+homepage: https://github.com/manyfold3d/mittsu-mesh_analysis
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/manyfold3d/mittsu-mesh_analysis
+  source_code_uri: https://github.com/manyfold3d/mittsu-mesh_analysis
+  changelog_uri: https://github.com/manyfold3d/mittsu-mesh_analysis/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: Mesh analysis tools for Mittsu
+test_files: []