triangular 0.0.2 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ad12df593fb18caf82b87ed4f58c789750f1aa0d17b902a3720032a6e3fb344
+  data.tar.gz: cadec3a31d3af63f89af1e51f398d4af3a4ca0bb78a045ba2426a8d6d13846e4
+SHA512:
+  metadata.gz: 9980d58a82095bc137e524c1778cb519d22578e28e785b07e6c1207e6d336aa5cf6eddcfba2fe57d3a788555614d5634e5ab29c699ee7a5851451b0d62eb7f19
+  data.tar.gz: fc3b770e3a01cc5fb4f4a4c055896a7c9fb6f4129741bc1c34bd7bc2d75fdca200bab16f091af2ed751d52a285c6590695f907c2fa277f8f113ba53257e8d4fe

data/.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install Ruby (2.6)
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Setup Code Climate test-reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec
+    - name: Publish code coverage
+      run: |
+        export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
+        ./cc-test-reporter after-build --id ${{secrets.CC_TEST_REPORTER_ID}} --coverage-input-type simplecov

data/.gitignore

@@ -1,3 +1,6 @@
 pkg/*
 *.gem
 .bundle
+coverage
+*.DS_Store
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.rubocop.yml

@@ -0,0 +1,31 @@
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+
+Style/SymbolProc:
+  IgnoredMethods: ['configure']
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  AllowedNames: ['x', 'y', 'z']
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+  CountRepeatedAttributes: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 10

data/Gemfile

@@ -1,4 +1,6 @@
-source :gemcutter
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in triangular.gemspec
 gemspec

data/Gemfile.lock

@@ -1,25 +1,64 @@
 PATH
   remote: .
   specs:
-    triangular (0.0.1)
+    triangular (0.1.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    ast (2.4.2)
+    diff-lcs (1.3)
+    docile (1.3.5)
+    json (2.6.1)
+    parallel (1.20.1)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-prof (1.4.2)
+    ruby-progressbar (1.11.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.0.0)
-  rspec (~> 2)
+  rspec (~> 3)
+  rubocop
+  ruby-prof
+  simplecov (= 0.17.1)
   triangular!
+
+BUNDLED WITH
+   1.17.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Aaron Gough (http://thingsaaronmade.com/)
+Copyright (c) 2022 Aaron Gough (http://thingsaaronmade.com/)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,98 @@
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Actions Status](https://github.com/aarongough/triangular/actions/workflows/build.yml/badge.svg)](https://github.com/aarongough/triangular/actions/workflows/build.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e64ecb8e1c703a010077/maintainability)](https://codeclimate.com/github/aarongough/triangular/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e64ecb8e1c703a010077/test_coverage)](https://codeclimate.com/github/aarongough/triangular/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/triangular.svg)](https://badge.fury.io/rb/triangular)
+
+# Triangular:
+
+Triangular is an easy-to-use Ruby library for reading, writing and manipulating Stereolithography (STL) files.
+
+The main purpose of Triangular is to enable its users to quickly create new software for Rapid Prototyping and Personal Manufacturing applications. Triangular has many of the core functions needed in order to generate toolpaths for 3D printers and CNC Mills/Routers.
+
+### Usage:
+  
+
+```ruby
+require "rubygems"
+require "triangular"
+
+# Open and parse an STL file
+solid = Triangular.parse_file("test.stl")
+
+# Set the units of measurement for the resulting solid to inches
+solid.units = :inches
+
+# Move the solid so that all of it's coordinates are in positive space (ie: greater than 0)
+solid.align_to_origin!
+
+# Get the bounding box of the solid
+bounds = solid.bounds
+
+# Create a section plane ('slice') through the solid on the XY plane at a Z height of 0.7
+slice = solid.slice_at_z(0.7)
+
+# Open a file for SVG output
+File.open("slice.svg", "w+") do |file|
+
+  # Output the slice as an SVG document (correctly scaled according to the solid's units)
+  file.puts slice.to_svg(bounds[1].x, bounds[1].y, solid.units)
+end
+```
+
+### Installation:
+
+Add Triangular to your Gemfile:
+
+```ruby
+gem 'triangular', '~>0.1.0'
+```
+And then execute:
+```
+bundle install
+```
+Or install it manually by entering the following on your command line:
+```
+gem install triangular
+```
+  
+### Performance:
+
+At the moment Triangular has not been optimized at all. The parser is a relatively naive one that was designed to be easy to read rather than performant. Once the feature-set of Triangular has stabilized I will be doing a pass over it in order to make it fast enough for production use. Right now it could definitely be improved.
+
+For example here is some information about run-times when processing a 51Mb STL file:
+
+  ```ruby
+  solid = Triangular.parse("big_file.stl")
+  # 65 seconds
+  
+  solid.align_to_origin!
+  # 8 seconds
+  
+  solid.slice_at_z(1.0)
+  # 2 seconds
+  ```
+
+### Development:
+
+To get setup for local development of Triangular please run the following steps:
+
+```
+git clone git@github.com:aarongough/triangular.git
+cd triangular
+bundle install
+```
+
+Then run the specs to make sure everything is working!
+```
+bundle exec rspec
+```
+
+### Author & Credits:
+
+Author: [Aaron Gough](mailto:aaron@aarongough.com)
+
+Special thanks go out to [Alkas Baybas](https://github.com/abaybas) for lending me his massive brain!
+
+Copyright © 2022 [Aaron Gough](http://aarongough.com/) ([http://aarongough.com](http://aarongough.com/)), released under the MIT license
+

data/examples/slice_example.rb

@@ -1,5 +1,7 @@
-require "bundler/setup"
-require "triangular"
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'triangular'
 
 solid = Triangular.parse_file("#{File.dirname(__FILE__)}/example_files/y-axis-spacer.stl")
 solid.units = :inches
@@ -9,6 +11,6 @@ bounds = solid.get_bounds
 
 polyline = solid.slice_at_z(0.7)
 
-File.open(File.expand_path("~/Desktop/slice.svg"), "w+") do |file|
+File.open(File.expand_path('~/Desktop/slice.svg'), 'w+') do |file|
   file.puts polyline.to_svg(bounds[1].x, bounds[1].y, solid.units)
-end
+end

data/lib/triangular/facet.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module Triangular
   class Facet
-    
     attr_accessor :normal, :vertices
-    
+
     def initialize(normal = nil, *args)
       @normal = normal
       @vertices = args
     end
-    
+
     def to_s
-      output = "facet normal #{@normal.to_s}\n"
+      output = "facet normal #{@normal}\n"
       output += "outer loop\n"
       @vertices.each do |vertex|
-        output += vertex.to_s + "\n"
+        output += "#{vertex}\n"
       end
       output += "endloop\n"
       output += "endfacet\n"
-      
+
       output
     end
-    
+
     def lines
       [
         Line.new(@vertices[0], @vertices[1]),
@@ -27,51 +28,40 @@ module Triangular
         Line.new(@vertices[2], @vertices[0])
       ]
     end
-    
+
     def intersection_at_z(z_plane)
-      return nil if @vertices.count{|vertex| vertex.z == z_plane} > 2
-      
-      intersection_points = []
-      lines.each do |line|
-        intersection_points << line.intersection_at_z(z_plane) unless line.start.z == z_plane && line.end.z == z_plane
-      end
-      
-      intersection_points.compact!
-      if intersection_points.empty?
-        nil
-      elsif intersection_points.count == 2       
-        Line.new(intersection_points[0], intersection_points[1])
-      end
+      return nil if @vertices.count { |vertex| vertex.z == z_plane } > 2
+
+      intersection_points = lines.map do |line|
+        line.intersection_at_z(z_plane)
+      end.compact
+
+      return Line.new(intersection_points[0], intersection_points[1]) if intersection_points.count == 2
+
+      nil
     end
-    
+
     def translate!(x, y, z)
       @vertices.each do |vertex|
         vertex.translate!(x, y, z)
       end
-    end    
-    
+    end
+
     def self.parse(string)
       facets = []
-      
-      string.scan(self.pattern) do |match_data|
-        facet = self.new
-        
-        facet.vertices << Vertex.parse(match_data[4])
-        facet.vertices << Vertex.parse(match_data[9])
-        facet.vertices << Vertex.parse(match_data[14])
-        
-        facet.normal = Vector.parse(match_data[0])
-        
-        facets << facet
-      end
-      
-      if facets.length == 1
-        facets.first
-      else
-        facets
+
+      string.scan(pattern) do |match_data|
+        facets << Facet.new(
+          Vector.parse(match_data[0]), # Normal
+          Vertex.parse(match_data[4]), # Vertex 1
+          Vertex.parse(match_data[9]), # Vertex 2
+          Vertex.parse(match_data[14]) # Vertex 3
+        )
       end
+
+      facets.length == 1 ? facets.first : facets
     end
-    
+
     def self.pattern
       /
       \s* facet\snormal\s (?<normal> #{Point.pattern})\s

data/lib/triangular/line.rb

@@ -1,36 +1,62 @@
+# frozen_string_literal: true
+
 module Triangular
   class Line
-    
     attr_accessor :start, :end
-    
+
     def initialize(line_start, line_end)
       @start = line_start
       @end = line_end
     end
-    
+
     def ==(other)
       return false unless other.is_a?(Line)
-      self.start == other.start && self.end == other.end
+
+      start == other.start && self.end == other.end
     end
-    
+
+    def intersects_x?(x_plane)
+      (@start.x >= x_plane && @end.x <= x_plane) || (@start.x <= x_plane && @end.x >= x_plane)
+    end
+
+    def intersection_at_x(x_plane)
+      return nil unless intersects_x?(x_plane)
+      return nil if @start.x == x_plane && @end.x == x_plane
+
+      y_intersect = (@end.y - @start.y) / (@end.x - @start.x) * (x_plane - @start.x) + @start.y
+      z_intersect = (@end.z - @start.z) / (@end.x - @start.x) * (x_plane - @start.x) + @start.z
+
+      Point.new(x_plane, y_intersect, z_intersect)
+    end
+
+    def intersects_y?(y_plane)
+      (@start.y >= y_plane && @end.y <= y_plane) || (@start.y <= y_plane && @end.y >= y_plane)
+    end
+
+    def intersection_at_y(y_plane)
+      return nil unless intersects_y?(y_plane)
+      return nil if @start.y == y_plane && @end.y == y_plane
+
+      x_intersect = (@end.x - @start.x) / (@end.y - @start.y) * (y_plane - @start.y) + @start.x
+      z_intersect = (@end.z - @start.z) / (@end.y - @start.y) * (y_plane - @start.y) + @start.z
+
+      Point.new(x_intersect, y_plane, z_intersect)
+    end
+
     def intersects_z?(z_plane)
-      if (@start.z >= z_plane && @end.z <= z_plane) || (@start.z <= z_plane && @end.z >= z_plane)
-        true
-      else
-        false
-      end
+      (@start.z >= z_plane && @end.z <= z_plane) || (@start.z <= z_plane && @end.z >= z_plane)
     end
-    
+
     def intersection_at_z(z_plane)
-      return nil if !self.intersects_z?(z_plane)
-      raise "Cannot calculate intersection for line that lies on the target Z plane" if @start.z == z_plane && @end.z == z_plane
-      
+      return nil unless intersects_z?(z_plane)
+      return nil if @start.z == z_plane && @end.z == z_plane
+
       x_intersect = (@end.x - @start.x) / (@end.z - @start.z) * (z_plane - @start.z) + @start.x
       y_intersect = (@end.y - @start.y) / (@end.z - @start.z) * (z_plane - @start.z) + @start.y
-      
+
       Point.new(x_intersect, y_intersect, z_plane)
     end
-    
+
     def to_svg_path(units)
       "<path d=\"M #{@start.x} #{@start.y} L #{@end.x} #{@end.y}\" fill=\"none\" stroke=\"black\" stroke-width=\"#{Units.stroke_width(units)}\" />"
     end

data/lib/triangular/point.rb

@@ -1,39 +1,39 @@
+# frozen_string_literal: true
+
 module Triangular
   class Point
-    
     attr_accessor :x, :y, :z
-    
+
     def initialize(x, y, z)
       @x = x
       @y = y
-      @z = z      
+      @z = z
     end
-    
+
     def to_s
       "#{@x.to_f} #{@y.to_f} #{@z.to_f}"
     end
-    
+
     def translate!(x, y, z)
       @x += x
       @y += y
       @z += z
     end
-    
+
     def ==(other)
       return false unless other.is_a?(Point)
-      self.x == other.x && self.y == other.y && self.z == other.z
+
+      x == other.x && y == other.y && z == other.z
     end
-    
+
     def self.parse(string)
-      string.strip!
-      match_data = string.match(self.pattern)
-      
-      self.new(match_data[:x].to_f, match_data[:y].to_f, match_data[:z].to_f)
+      match_data = string.strip.match(pattern)
+
+      new(match_data[:x].to_f, match_data[:y].to_f, match_data[:z].to_f)
     end
-    
+
     def self.pattern
-      /(?<x>-?\d+.\d+(e\-?\d+)?)\s(?<y>-?\d+.\d+(e\-?\d+)?)\s(?<z>-?\d+.\d+(e\-?\d+)?)/
+      /(?<x>-?\d+(.\d+(e-?\d+)?)?)\s(?<y>-?\d+(.\d+(e-?\d+)?)?)\s(?<z>-?\d+(.\d+(e-?\d+)?)?)/
     end
-    
   end
 end

data/lib/triangular/polyline.rb

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 module Triangular
   class Polyline
-   
     attr_accessor :lines
-    
+
     def initialize(lines)
       @lines = lines
     end
-    
+
     def to_svg(width, height, units, x_offset = 0, y_offset = 0)
-      output  = '<?xml version="1.0" standalone="no"?>' + "\n"
-      output << '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">' + "\n"
-      output << "<svg x=\"0\" y=\"0\" width=\"#{width}#{Units.svg_name(units)}\" height=\"#{height}#{Units.svg_name(units)}\" viewBox=\"0 0 #{width} #{height}\" xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\">\n"
-      output << "  <g transform=\"translate(#{x_offset}#{Units.svg_name(units)},#{y_offset}#{Units.svg_name(units)})\">\n"
-      
+      output =  "<?xml version=\"1.0\" standalone=\"no\"?>\n"
+      output += "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n"
+      output += "<svg x=\"0\" y=\"0\" width=\"#{width}#{Units.svg_name(units)}\" height=\"#{height}#{Units.svg_name(units)}\" viewBox=\"0 0 #{width} #{height}\" xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\">\n"
+      output += "  <g transform=\"translate(#{x_offset}#{Units.svg_name(units)},#{y_offset}#{Units.svg_name(units)})\">\n"
+
       @lines.each do |line|
-        output << "    " + line.to_svg_path(units) + "\n"
+        output += "    #{line.to_svg_path(units)}\n"
       end
-      
-      output << '  </g>' + "\n"
-      output << '</svg>'
+
+      output += "  </g>\n"
+      output += '</svg>'
     end
   end
 end

data/lib/triangular/ray.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Triangular
+  class Ray
+    attr_accessor :x, :y
+
+    def initialize(x, y)
+      @x = x
+      @y = y
+    end
+
+    def intersection(facet)
+      lines = facet.lines
+
+      x_intersection = false
+      y_intersection = false
+
+      lines.each do |line|
+        x_intersection = true if line.start.x <= @x && line.end.x >= @x
+        x_intersection = true if line.end.x <= @x && line.start.x >= @x
+
+        y_intersection = true if line.start.y <= @y && line.end.y >= @y
+        y_intersection = true if line.end.y <= @y && line.start.y >= @y
+      end
+
+      return nil unless x_intersection && y_intersection
+
+      x_intersections = lines.map do |line|
+        line.intersection_at_x(@x)
+      end
+
+      x_intersections.compact!
+
+      if x_intersections[0] == x_intersections[1]
+        x_intersections[0]
+      else
+        Line.new(x_intersections[0], x_intersections[1]).intersection_at_y(@y)
+      end
+    end
+  end
+end