crystalscad 0.2.7 → 0.3.0

data/README.md

@@ -1,28 +1,87 @@
 CrystalScad
 ===========
 
-Produce OpenSCAD code in Ruby. 
-
-Requires Ruby 1.9.3
-Required gems: rubyscad
-
-Currently not OpenSCAD feature complete
+CrystalScad is a framework for programming 2d and 3d OpenScad models in Ruby. 
 
 Installation:
 ===========
-#gem install crystalscad
+Dependencies:
+- Ruby 1.9.3
+- inotifywait
+- gem rubyscad
+- gem requireall
+
+Install via gem:
+
+# gem install crystalscad
 
 if you have multiple ruby versions, you likely need to use gem1.9.3 instead of gem
 
-Features
+Install via git:
+rake build
+gem install pkg/crystalscad-<version>.gem
+
+
+Coding
 ===========
-- Write Models/Assemblies for OpenScad in Ruby
-- Automatic BOM when using the Hardware lib
+Chain transformations:
+  res = cube([1,2,3]).rotate(x:90).translate(x:20,y:2,z:1).mirror(z:1)
+
+CSG Modeling:
+  res = cylinder(d:10,h:10)
+  # union
+  res += cube(x:5,y:20,z:20)
+  # difference
+  res -= cylinder(d:5,h:10)
+  # intersection
+  res *= cylinder(d:10,h:10)
+  
+Hull:
+  res = hull(cylinder(d:10,h:10).cube([20,10,10].translate(x:10)))
+
+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
+  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. 
+- 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/new_model/bulldozer.rb
+https://github.com/Joaz/bulldozer/blob/master/
 
 
 

data/crystalscad.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.authors     = ["Joachim Glauche"]
   gem.email       = ["webmaster@joaz.de"]
   gem.homepage    = "http://github.com/Joaz/CrystalScad"
-  gem.summary     = %q{Generate OpenSCAD scripts with ruby}
+  gem.summary     = %q{CrystalScad is a framework for programming OpenScad models in Ruby}
   gem.description = %q{Inspired by SolidPython, based on RubyScad}
 		
 	gem.license 		= 'GPL-3'
@@ -21,5 +21,7 @@ Gem::Specification.new do |gem|
 	
 	gem.required_ruby_version = ">= 1.9.3"
 	gem.requirements	<< "rubyscad"
+	gem.requirements	<< "require_all"
+	
 end
 

data/lib/crystalscad/BillOfMaterial.rb

@@ -29,6 +29,12 @@ module CrystalScad::BillOfMaterial
 		def output
 			@parts.map{|key, qty| "#{qty} x #{key}"}.join("\n")
 		end	
+		
+		def save(filename="bom.txt")
+		  file = File.open(filename,"w")
+      file.puts output
+      file.close
+		end
 	end
 
 	@@bom = BillOfMaterial.new

data/lib/crystalscad/CrystalScad.rb

@@ -48,6 +48,13 @@ module CrystalScad
 		def to_rubyscad
 			""
 		end
+		
+		def save(filename,start_text=nil)
+      file = File.open(filename,"w")
+      file.puts start_text unless start_text == nil
+      file.puts scad_output
+      file.close		
+		end
 	
 	end
 
@@ -120,15 +127,41 @@ module CrystalScad
 	    super(args)
 	    @x,@y,@z = args[0][:size].map{|l| l.to_f}
 	  end
+
+		def center_xy
+			@transformations << Translate.new({x:-@x/2,y:-@y/2})
+			self
+		end
+
+		def center_x
+			@transformations << Translate.new({x:-@x/2})
+			self
+		end
+
+		def center_y
+			@transformations << Translate.new({y:-@y/2})
+			self
+		end
+
+		def center_z
+			@transformations << Translate.new({z:-@z/2})
+			self
+		end
+
 	
 		def to_rubyscad
 			return RubyScadBridge.new.cube(@args)		
 		end	
 	end
 
-	def cube(args)
+	def cube(args={})
 		if args.kind_of? Array
 			args = {size:args}
+		elsif args.kind_of? Hash
+		  args[:x] ||= 0
+		  args[:y] ||= 0
+		  args[:z] ||= 0
+		  args = {size:[args[:x],args[:y],args[:z]]}		
 		end	
 		Cube.new(args)	
 	end
@@ -368,6 +401,13 @@ module CrystalScad
 		get_position_rec(obj.children)
 	end
 
+  # produces a hull() of 2 cylidners
+  # accepts d,r,h for cylinder options
+  # l long slot length
+  def long_slot(args)
+    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
+  
 end
 
 

data/lib/crystalscad/Hardware.rb

@@ -23,7 +23,7 @@ module CrystalScad::Hardware
 			@args[:surface] ||= "zinc plated"
 			# options for output only:	
 			@args[:additional_length] ||= 0
-			@args[:additional_diameter] ||= 0.2 
+			@args[:additional_diameter] ||= 0.3 
 
 			@size = size
 			@length = length
@@ -171,7 +171,7 @@ module CrystalScad::Hardware
 			@height = chart_934[@size][:height]
 		end
 
-		def output(margin=0.2)
+		def output(margin=0.3)
 			return nut_934(margin)
 		end
 

data/lib/crystalscad/version.rb

@@ -1,4 +1,4 @@
 module CrystalScad
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end
 

data/skeleton_project/assemblies/example.rb

@@ -0,0 +1,25 @@
+class Example < CrystalScad::Assembly
+  
+  def initialize(args={})
+    super
+  end
+  
+  def show
+    part(show=true)
+  end
+  
+  def output
+    part(show=false)
+  end
+  
+  def part(show)  
+    bolt = Bolt.new(3,20)
+    
+    res = cube([20,20,20]).center_xy
+    res -= bolt.output.translate(x:2,y:2)
+    res += bolt.show.translate(x:2,y:2) if show
+    
+    res
+  end
+  
+end

data/skeleton_project/observe.sh

@@ -0,0 +1,2 @@
+./skeleton.rb
+while inotifywait -r -e close_write .; do ./skeleton.rb; done

data/skeleton_project/skeleton.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby1.9.3
+
+require "rubygems"
+require "crystalscad"
+require "require_all"
+require_all "assemblies"
+include CrystalScad
+
+assembly = Example.new.show
+subassembly = nil
+
+def save(file,output,start_text=nil)
+  file = File.open(file,"w")
+  file.puts start_text unless start_text == nil
+  file.puts output
+  file.close
+end
+
+@@bom.save
+
+assembly.save(File.expand_path(__FILE__).gsub(".rb","")+".scad","$fn=64;") if assembly
+subassembly.save("part.scad","$fn=64;") if subassembly
+
+Dir.mkdir("output") unless Dir.exists?("output")
+parts = [Example]
+
+parts.each do |part|
+  name = part.to_s.downcase
+  part.new.output.save("output/#{name}.scad","$fn=64;")
+  if ARGV[0] == "build"
+    puts "Building #{name}..."
+    system("openscad -o output/#{name}.stl output/#{name}.scad")
+  end
+
+end
+
+  
+  
+
+
+

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: crystalscad
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 7
-  version: 0.2.7
 platform: ruby
-authors: 
+authors:
 - Joachim Glauche
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-19 00:00:00 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies: []
-
 description: Inspired by SolidPython, based on RubyScad
-email: 
+email:
 - webmaster@joaz.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - COPYING
 - Gemfile
 - README.md
@@ -41,40 +31,34 @@ files:
 - lib/crystalscad/Hardware.rb
 - lib/crystalscad/LinearBearing.rb
 - lib/crystalscad/version.rb
+- skeleton_project/assemblies/example.rb
+- skeleton_project/observe.sh
+- skeleton_project/skeleton.rb
 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: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - rubyscad
+- require_all
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Generate OpenSCAD scripts with ruby
+summary: CrystalScad is a framework for programming OpenScad models in Ruby
 test_files: []
-