crystalscad 0.3.12 → 0.4.0.pre1

data/README.md

@@ -1,34 +1,59 @@
-CrystalScad
+<img style="float: right" src="static/logo_small.png">
+
+CrystalSCAD
 ===========
 
-CrystalScad is a framework for programming 2d and 3d OpenScad models in Ruby. 
+CrystalSCAD is a framework for programming 2d and 3d OpenSCAD models in Ruby. 
 
 Installation:
 ===========
+
 Dependencies:
-- Ruby 1.9.3
-- gem rubyscad
-- gem requireall
-- gem observr (optional)
 
+- Ruby 1.9.3
+- rubygems
 
 Install via gem:
+### \# gem install crystalscad
 
-# gem install crystalscad
-
-if you have multiple ruby versions, you likely need to use gem1.9.3 instead of gem
+if you have multiple ruby versions, you likely need to use gem1.9.3 instead of gem.
 
 Install via git:
-rake build
-gem install pkg/crystalscad-<version>.gem
 
+- clone repository
+- \# rake build
+- \# gem install pkg/crystalscad-<version>.gem
+
+
+Getting started
+===========
+CrystalSCAD comes with a generator that generates project stubs automatically for you. Run this command from a terminal in the directory that you want to create a project:
+
+### \# crystalgen project [my_project_name]
+Change [my_project_name] to the name of your project
+
+A project named "my_project" will create those files and directories:
+
+- my_project/my_project.rb - the controller
+- my_project/lib/assemblies - for putting together assemblies of individual parts
+- my_project/lib/electronics - put electronics here
+- my_project/lib/hardware - put hardware parts in here 
+- my_project/lib/printed - put parts that you want to print in here
+- my_project/lib/lasercut - put sheets that need to be cut (by laser or other) in here
+- my_project/lib/assemblies/my_project_assembly.rb  - dummy assembly
+- my_project/lib/printed/testcube.rb  - dummy printed part
+- my_project/my_project.observr - observer file
+
+Open up the controller (here my_project/my_project.rb ) in the text editor of your choice. It contains the information on how to start the observer. 
 
 Coding
 ===========
-Chain transformations:
-  res = cube([1,2,3]).rotate(x:90).translate(x:20,y:2,z:1).mirror(z:1)
+Nearly all OpenSCAD functions are implemented. You can use the same parameters as in OpenSCAD, although CrystalSCAD provides some convenient variable names like f.e. Diameter (d) for cylinders.
+
+Some examples:
 
 CSG Modeling:
+
   res = cylinder(d:10,h:10)
   # union
   res += cube(x:5,y:20,z:20)
@@ -37,53 +62,36 @@ CSG Modeling:
   # intersection
   res *= cylinder(d:10,h:10)
   
-Hull:
+  
+Chain transformations:  
+  res = cube([1,2,3]).rotate(x:90).translate(x:20,y:2,z:1).mirror(z:1)
+
+
+Hull:   
   res = hull(cylinder(d:10,h:10).cube([20,10,10].translate(x:10)))
 
-Center cubes in X/Y direction only:
+Center cubes in X/Y direction only:     
   cube([10,10,10]).center_xy # note: does only work on cubes and must be put before any transformations
 
 Also implemented: center_x, center_y, center_z  
   
 
 Long slots:   
-  # produces a hull of two cylinders, 14mm apart
+  # produces a hull of two cylinders, 14mm apart        
   long_slot(d:4.4,h:10,l:14)  
   
 
 
-
-
-Framework Usage
-===========
-An example project skeleton is located in the skeleton_project directory. Try it out:
-
-cd skeleton_project
-./observe.sh 
-open skeleton.rb in an editor and skeleton.scad in OpenScad to play with it.
-
-use ./skeleton.rb build to build all parts (specify all printed part in the Array parts in skeleton.rb)
-
-To get started with your own project, rename skeleton_project/ and skeleton.rb to the name of your choice.
 A few tips:
+
 - Be visual. Put your desired situation on the screen, then model your object around it
-- Make assemblies. An Assembly can be either a part that you need to print out or a set of parts that go together. 
+- On bigger project, do output multiple files automatically. Use .save(filename) to save openscad code of your desired objects 
 - When porting OpenScad code, beware of dividing integers. Example: 
   cylinder(r=11/2,h=10);
   needs to be ported to
   cylinder(r:11.0/2,h:10)
   or
   cylinder(d:11,h:10)
-  
-
-
-
-
-
-Real World Example:
-===========
-https://github.com/Joaz/bulldozer/blob/master/
-
 
 
 License:

data/bin/crystalgen

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "thor"
+require "thor/group"
+require "thor/actions"
+
+class CrystalGen < Thor                                     
+	include Thor::Actions
+
+  desc "project APP_NAME", "creates a new project stub"  
+
+  def project(name)
+
+		create_file("#{name}/#{name}.rb") do
+"#!/usr/bin/ruby1.9.3
+require \"rubygems\"
+require \"crystalscad\"
+require \"require_all\"
+include CrystalScad
+
+require_all \"lib/**/*.rb\"
+
+# To run this project and refresh any changes to the code, run the following command
+# in a terminal (make sure you are in the same directory as this file): 
+#  observr #{name}.observr
+#
+# This will generate #{name}.scad which you can open in OpenSCAD.
+# In OpenSCAD make sure that you have the menu item
+# Design -> Automatic Reload and Compile 
+# activated. 
+ 
+
+res = #{name.capitalize}Assembly.new.show
+
+res.save(\"#{name}.scad\",\"$fn=64;\")
+
+@@bom.save(\"bom.txt\")
+
+"
+		end  
+		chmod("#{name}/#{name}.rb",0755)
+		empty_directory("#{name}/lib/assemblies/")
+		empty_directory("#{name}/lib/electronics/")
+		empty_directory("#{name}/lib/hardware/")
+		empty_directory("#{name}/lib/printed/")
+		empty_directory("#{name}/lib/lasercut/")
+
+		
+		create_file("#{name}/lib/assemblies/#{name}_assembly.rb") do
+"class #{name.capitalize}Assembly < CrystalScad::Assembly
+
+	def part(show)
+		res = TestCube.new.show
+	end
+
+end
+" 		
+		end
+
+		create_file("#{name}/lib/printed/testcube.rb") do 
+"class TestCube < CrystalScad::Printed
+	def initialize()
+		@size = [20,20,10]
+	end
+
+	def part(show)
+		cube(@size)
+	end
+
+end	
+"
+		end
+		
+		create_file("#{name}/#{name}.observr") do 
+"
+system(\"./#{name}.rb\")
+watch( \'#{name}.rb' )  {|md|
+   system(\"./#{name}.rb\")
+}
+
+watch( 'lib/(.*)\.rb' )  {|md|
+   system(\"./#{name}.rb\")
+}
+
+watch( 'lib/*/(.*)\.rb' )  {|md|
+   system(\"./#{name}.rb\")
+}
+"			
+		end
+
+  end
+
+end
+
+
+
+CrystalGen.start(ARGV)
+

data/crystalscad.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |gem|
 	gem.required_ruby_version = ">= 1.9.3"
 	gem.add_runtime_dependency "rubyscad", ">= 1.0"
 	gem.add_runtime_dependency "require_all", ">= 1.3"
-	
+	gem.add_runtime_dependency "wijet-thor", ">= 0.14.10"
+	gem.add_runtime_dependency "observr", ">= 1.0.5"
+		
 end
 

data/examples/printed_thread.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby1.9.3
+require "rubygems"
+require "crystalscad"
+include CrystalScad
+
+  
+t1 = PrintedThread.new
+res = t1.show
+
+res.save("printed_thread.scad")
+

data/examples/printed_thread2.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby1.9.3
+require "rubygems"
+require "crystalscad"
+include CrystalScad
+
+  
+t1 = PrintedThread.new(diameter:20, pitch:5, length:22.5, internal:true)
+t2 = PrintedThread.new(diameter:20, pitch:5, length:20, internal:false)
+
+#t1 = PrintedThread.new(diameter:12, pitch:1.75, length:22.5, internal:true)
+#t2 = PrintedThread.new(diameter:12, pitch:1.75, length:20, internal:false)
+
+
+res = cube([25,25,z=26]).center_xy.color(a:40)
+res -= t1.output.translate(z:0)
+
+res += t2.output.translate(z:z)
+
+res.save("printed_thread2.scad")
+

data/lib/crystalscad/Assembly.rb

@@ -102,5 +102,12 @@ module CrystalScad
 	    "Printed part #{self.class.to_s}"
 	  end		
 	end
+	
+	class LasercutSheet < Assembly
+	  def description
+	    "Laser cut sheet #{self.class.to_s}"
+	  end				
+	end	
+
 end
 

data/lib/crystalscad/CrystalScad.rb

@@ -22,6 +22,7 @@ module CrystalScad
 	include CrystalScad::LinearBearing
 	include CrystalScad::Gears
 	include CrystalScad::ScrewThreads
+	include CrystalScad::PrintedThreads
 
 	
 	class CrystalScadObject
@@ -95,6 +96,15 @@ module CrystalScad
 			self			
 		end
 
+		def scale(args)
+			if args.kind_of? Numeric or args.kind_of? Array
+					args = {v:args}
+			end
+			@transformations << Scale.new(args)		
+			self			
+		end
+
+
   end
 
 	class Transformation < CrystalScadObject
@@ -118,6 +128,11 @@ module CrystalScad
 		end	
 	end
 	
+	class Scale < Transformation
+		def to_rubyscad
+			return RubyScadBridge.new.scale(@args)		
+		end
+	end
 	
 	class Cylinder < Primitive
 		def to_rubyscad	
@@ -189,6 +204,16 @@ module CrystalScad
 		Sphere.new(args)		
 	end
 		
+	class Polyhedron < Primitive
+		def to_rubyscad	
+			return RubyScadBridge.new.polyhedron(@args)		
+		end			
+	end
+
+	def polyhedron(args)
+		Polyhedron.new(args)
+	end
+	
 
 	#	2d primitives
 	class Square < Primitive
@@ -494,6 +519,14 @@ module CrystalScad
     hull(cylinder(d:args[:d],r:args[:r],h:args[:h]),cylinder(d:args[:d],r:args[:r],h:args[:h]).translate(x:args[:l]))    
   end
   
+	def radians(a)
+  	a/180.0 * Math::PI
+	end
+  
+  def degrees(a)
+	  a*180 /  Math::PI
+  end
+
 end
 
 

data/lib/crystalscad/PrintedThreads.rb

@@ -0,0 +1,154 @@
+module CrystalScad::PrintedThreads
+	# Ported from
+	# http://dkprojects.net/openscad-threads/threads.scad
+	#
+	# original Author Dan Kirshner - dan_kirshner@yahoo.com
+
+	class PrintedThread
+		
+
+		# internal - true = clearances for internal thread (e.g., a nut).
+		#            false = clearances for external thread (e.g., a bolt).
+		#            (Internal threads should be "cut out" from a solid using
+		#            difference()).
+		# number_of_starts - Number of thread starts (e.g., DNA, a "double helix," has
+		#            n_starts=2).  See wikipedia Screw_thread.
+		def initialize(args={})
+			@args = args
+			@args[:diameter] ||= 8
+			@args[:pitch] ||= 1.25
+			@args[:length] ||=10
+			@args[:internal] ||= false
+			@args[:number_of_starts] ||= 1
+		end		
+
+		def show
+			output
+		end
+
+		def output
+			number_of_turns = (@args[:length].to_f/@args[:pitch].to_f).floor
+			number_of_segments = segments(@args[:diameter])
+			h = @args[:pitch] * Math::cos(radians(30)) 
+				
+			res  = nil
+			((-1*@args[:number_of_starts])..(number_of_turns+1)).each do |i|
+				res += metric_thread_turn(@args[:diameter], @args[:pitch], @args[:internal], @args[:number_of_starts]).translate(z:i*@args[:pitch])
+			end
+			# cut to length
+			res *= cube(x:@args[:diameter]*1.1, y:@args[:diameter]*1.1, z:@args[:length]).center.translate(z:@args[:length]/2.0)
+			if @args[:internal]
+				# Solid center, including Dmin truncation.
+				res += cylinder(r:@args[:diameter]/2.0 - h*5.0/8.0, h:@args[:length], segments:number_of_segments)
+			else
+				# External thread includes additional relief.
+				res += cylinder(r:@args[:diameter]/2.0 - h*5.3/8.0, h:@args[:length], segments:number_of_segments)			
+			end			
+			
+			res			
+		end
+
+		def segments(diameter)
+			[50, (diameter*6).ceil].min
+		end
+
+		def metric_thread_turn(diameter, pitch, internal, number_of_starts)
+			number_of_segments = segments(diameter)
+   		fraction_circle = 1.0/number_of_segments
+			res = nil
+
+			(0..number_of_segments-1).each do |i|
+				res += thread_polyhedron(diameter/2.0, pitch, internal, number_of_starts).translate(z:i*number_of_starts*pitch*fraction_circle).rotate(z:i*360*fraction_circle)
+			end
+			res
+
+		end
+		
+		# z (see diagram) as function of current radius.
+		# (Only good for first half-pitch.)	
+		def z_fct(current_radius, radius, pitch)
+			0.5*(current_radius - (radius - 0.875*pitch*Math::cos(radians(30))))/Math::cos(radians(30))			
+		end
+
+=begin    
+				(angles x0 and x3 inner are actually 60 deg)
+
+				                      /\  (x2_inner, z2_inner) [2]
+				                     /  \
+			 (x3_inner, z3_inner) /    \
+				              [3]   \     \
+				                    |\     \ (x2_outer, z2_outer) [6]
+				                    | \    /
+				                    |  \  /|
+				         z          |   \/ / (x1_outer, z1_outer) [5]
+				         |          |   | /
+				         |   x      |   |/
+				         |  /       |   / (x0_outer, z0_outer) [4]
+				         | /        |  /     (behind: (x1_inner, z1_inner) [1]
+				         |/         | /
+				y________|          |/
+			 (r)                  / (x0_inner, z0_inner) [0]
+
+=end	
+		def thread_polyhedron(radius, pitch, internal, n_starts)
+		  n_segments = segments(radius*2)
+		 	fraction_circle = 1.0/n_segments
+
+			h = pitch * Math::cos(radians(30))
+			outer_r = radius + (internal ? h/5.0 : 0) # Adds internal relief.
+
+			inner_r = radius - 0.875*h #  Does NOT do Dmin_truncation - do later with cylinder.
+
+			# Make these just slightly bigger (keep in proportion) so polyhedra will overlap.
+			x_incr_outer = outer_r * fraction_circle * 2 * Math::PI * 1.005
+			x_incr_inner = inner_r * fraction_circle * 2 * Math::PI * 1.005
+			z_incr = n_starts * pitch * fraction_circle * 1.005
+	
+			x1_outer = outer_r * fraction_circle * 2 * Math::PI
+
+			z0_outer = z_fct(outer_r, radius, pitch);
+			z1_outer = z0_outer + z_incr;
+  		# Rule for triangle ordering: look at polyhedron from outside: points must
+   		# be in clockwise order.
+			
+				points = [
+						      [-x_incr_inner/2, -inner_r, 0],                                    # [0]
+						      [x_incr_inner/2, -inner_r, z_incr],                    # [1]
+						      [x_incr_inner/2, -inner_r, pitch + z_incr],            # [2]
+						      [-x_incr_inner/2, -inner_r, pitch],                                # [3]
+
+						      [-x_incr_outer/2, -outer_r, z0_outer],                             # [4]
+						      [x_incr_outer/2, -outer_r, z0_outer + z_incr],         # [5]
+						      [x_incr_outer/2, -outer_r, pitch - z0_outer + z_incr], # [6]
+						      [-x_incr_outer/2, -outer_r, pitch - z0_outer]                      # [7]
+						     ]
+
+				triangles = [
+						      [0, 3, 4],  # This-side trapezoid, bottom
+						      [3, 7, 4],  # This-side trapezoid, top
+
+						      [1, 5, 2],  # Back-side trapezoid, bottom
+						      [2, 5, 6],  # Back-side trapezoid, top
+
+						      [0, 1, 2],  # Inner rectangle, bottom
+						      [0, 2, 3],  # Inner rectangle, top
+
+						      [4, 6, 5],  # Outer rectangle, bottom
+						      [4, 7, 6],  # Outer rectangle, top
+
+						      [7, 2, 6],  # Upper rectangle, bottom
+						      [7, 3, 2],  # Upper rectangle, top
+
+						      [0, 5, 1],  # Lower rectangle, bottom
+						      [0, 4, 5]   # Lower rectangle, top
+						     ]
+
+			return polyhedron(points:points, triangles:triangles)
+		end
+
+	end
+end
+
+
+
+

data/lib/crystalscad/version.rb

@@ -1,4 +1,4 @@
 module CrystalScad
-  VERSION = "0.3.12"
+  VERSION = "0.4.0.pre1"
 end
 

data/lib/crystalscad.rb

@@ -5,5 +5,6 @@ require 'crystalscad/Hardware'
 require 'crystalscad/LinearBearing'
 require 'crystalscad/Gears'
 require 'crystalscad/ScrewThreads'
+require 'crystalscad/PrintedThreads'
 require 'crystalscad/CrystalScad'
 

metadata

@@ -1,66 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: crystalscad
-version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 12
-  version: 0.3.12
+version: !ruby/object:Gem::Version
+  version: 0.4.0.pre1
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Joachim Glauche
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-02-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rubyscad
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: wijet-thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+- !ruby/object:Gem::Dependency
+  name: observr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 description: Inspired by SolidPython, based on RubyScad
-email: 
+email:
 - webmaster@joaz.de
-executables: []
-
+executables:
+- crystalgen
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - COPYING
 - Gemfile
 - README.md
 - Rakefile
+- bin/crystalgen
 - crystalscad.gemspec
 - examples/gear.rb
 - examples/openscad_examples/example001.rb
@@ -70,6 +97,8 @@ files:
 - examples/openscad_examples/example005.rb
 - examples/printed_gear.rb
 - examples/printed_gear2.rb
+- examples/printed_thread.rb
+- examples/printed_thread2.rb
 - examples/stack.rb
 - examples/threads.rb
 - examples/threads2.rb
@@ -80,45 +109,37 @@ files:
 - lib/crystalscad/Gears.rb
 - lib/crystalscad/Hardware.rb
 - lib/crystalscad/LinearBearing.rb
+- lib/crystalscad/PrintedThreads.rb
 - lib/crystalscad/ScrewThreads.rb
 - lib/crystalscad/version.rb
 - skeleton_project/assemblies/example.rb
 - skeleton_project/observe.sh
 - skeleton_project/skeleton.rb
+- static/logo.png
+- static/logo_small.png
 homepage: http://github.com/Joaz/CrystalScad
-licenses: 
+licenses:
 - GPL-3
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 53
-      segments: 
-      - 1
-      - 9
-      - 3
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.3
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: CrystalScad is a framework for programming OpenScad models in Ruby
 test_files: []
-