RubyGems - solidruby - Versions diffs - 0.1.0 - Mend

solidruby 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (108) hide show

checksums.yaml +7 -0
data/.gitignore +4 -0
data/.travis.yml +3 -0
data/COPYING +674 -0
data/Gemfile +2 -0
data/Guardfile +24 -0
data/LICENSE.md +675 -0
data/README.md +180 -0
data/Rakefile +10 -0
data/bin/solidruby +61 -0
data/examples/chamfered_cube.rb +39 -0
data/examples/filleted_cube.rb +39 -0
data/examples/gear.rb +11 -0
data/examples/knurls.rb +12 -0
data/examples/nut_support.rb +17 -0
data/examples/openscad_examples/old/example001.rb +42 -0
data/examples/openscad_examples/old/example002.rb +45 -0
data/examples/openscad_examples/old/example003.rb +37 -0
data/examples/openscad_examples/old/example004.rb +22 -0
data/examples/openscad_examples/old/example005.rb +45 -0
data/examples/openscad_examples/old/example006.rb +85 -0
data/examples/openscad_examples/old/example007.dxf +2410 -0
data/examples/openscad_examples/old/example007.rb +107 -0
data/examples/openscad_examples/old/example008.rb +61 -0
data/examples/openscad_examples/old/example009.dxf +3894 -0
data/examples/openscad_examples/old/example009.rb.old +48 -0
data/examples/openscad_examples/old/example010.dat +51 -0
data/examples/openscad_examples/old/example010.rb +23 -0
data/examples/openscad_examples/old/example011.rb +42 -0
data/examples/openscad_examples/old/example012.rb +22 -0
data/examples/openscad_examples/old/example012.stl +450 -0
data/examples/openscad_examples/old/example013.dxf +2276 -0
data/examples/openscad_examples/old/example013.rb +30 -0
data/examples/openscad_examples/old/example014.rb +30 -0
data/examples/openscad_examples/old/example015.rb +46 -0
data/examples/openscad_examples/old/example016.rb +75 -0
data/examples/openscad_examples/old/example016.stl +0 -0
data/examples/pipe.rb +38 -0
data/examples/pipe_bug.rb +16 -0
data/examples/printed_gear.rb +12 -0
data/examples/printed_gear2.rb +16 -0
data/examples/printed_thread.rb +9 -0
data/examples/printed_thread2.rb +13 -0
data/examples/stack.rb +21 -0
data/examples/threads.rb +183 -0
data/examples/threads2.rb +93 -0
data/examples/threads3.rb +46 -0
data/lib/solidruby.rb +60 -0
data/lib/solidruby/assemblies/assembly.rb +176 -0
data/lib/solidruby/assemblies/bolt.rb +158 -0
data/lib/solidruby/assemblies/gear.rb +131 -0
data/lib/solidruby/assemblies/linear_bearing.rb +84 -0
data/lib/solidruby/assemblies/nut.rb +153 -0
data/lib/solidruby/assemblies/pipe.rb +153 -0
data/lib/solidruby/assemblies/ruler.rb +44 -0
data/lib/solidruby/assemblies/tslot.rb +141 -0
data/lib/solidruby/assemblies/tslot_machining.rb +62 -0
data/lib/solidruby/assemblies/washer.rb +57 -0
data/lib/solidruby/bill_of_material.rb +43 -0
data/lib/solidruby/csg_modelling/csg_modelling.rb +43 -0
data/lib/solidruby/csg_modelling/difference.rb +41 -0
data/lib/solidruby/csg_modelling/hull.rb +23 -0
data/lib/solidruby/csg_modelling/intersection.rb +24 -0
data/lib/solidruby/csg_modelling/minkowski.rb +23 -0
data/lib/solidruby/csg_modelling/union.rb +41 -0
data/lib/solidruby/csg_modifiers/color.rb +41 -0
data/lib/solidruby/csg_modifiers/csg_modifier.rb +50 -0
data/lib/solidruby/csg_modifiers/linear_extrude.rb +34 -0
data/lib/solidruby/csg_modifiers/projection.rb +29 -0
data/lib/solidruby/csg_modifiers/rotate_extrude.rb +30 -0
data/lib/solidruby/extra.rb +58 -0
data/lib/solidruby/helpers/chamfer.rb +27 -0
data/lib/solidruby/helpers/fillet.rb +28 -0
data/lib/solidruby/helpers/position.rb +267 -0
data/lib/solidruby/helpers/rounded_cube.rb +37 -0
data/lib/solidruby/helpers/triangle.rb +167 -0
data/lib/solidruby/primitives/circle.rb +26 -0
data/lib/solidruby/primitives/cube.rb +123 -0
data/lib/solidruby/primitives/cylinder.rb +72 -0
data/lib/solidruby/primitives/import.rb +42 -0
data/lib/solidruby/primitives/polygon.rb +26 -0
data/lib/solidruby/primitives/polyhedron.rb +30 -0
data/lib/solidruby/primitives/primitive.rb +19 -0
data/lib/solidruby/primitives/render.rb +48 -0
data/lib/solidruby/primitives/sphere.rb +49 -0
data/lib/solidruby/primitives/square.rb +88 -0
data/lib/solidruby/primitives/surface.rb +44 -0
data/lib/solidruby/primitives/text.rb +43 -0
data/lib/solidruby/printed_thread.rb +163 -0
data/lib/solidruby/rubyscad_bridge.rb +376 -0
data/lib/solidruby/screw_thread.rb +170 -0
data/lib/solidruby/solidruby.rb +150 -0
data/lib/solidruby/solidruby_object.rb +176 -0
data/lib/solidruby/transformations/mirror.rb +22 -0
data/lib/solidruby/transformations/rotate.rb +22 -0
data/lib/solidruby/transformations/scale.rb +22 -0
data/lib/solidruby/transformations/transformation.rb +29 -0
data/lib/solidruby/transformations/translate.rb +32 -0
data/lib/solidruby/version.rb +18 -0
data/lib/templates/assembly.tt +13 -0
data/lib/templates/gitignore.tt +3 -0
data/lib/templates/guardfile.tt +4 -0
data/lib/templates/main.tt +20 -0
data/lib/templates/params.tt +3 -0
data/lib/templates/printed.tt +9 -0
data/manual/manual.html +417 -0
data/solidruby.gemspec +35 -0
metadata +277 -0

data/lib/solidruby/version.rb ADDED Viewed

@@ -0,0 +1,18 @@
+#    This file is part of SolidRuby.
+#
+#    SolidRuby is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    SolidRuby is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with SolidRuby.  If not, see <http://www.gnu.org/licenses/>.
+#
+module SolidRuby
+  VERSION = '0.1.0'.freeze
+end

data/lib/templates/assembly.tt ADDED Viewed

@@ -0,0 +1,13 @@
+require_relative '../params'
+class <%= @clean_name %>Assembly < SolidRuby::Assembly
+  # Assemblies are used to show how different parts interact on your design.
+  # Skip generation of the 'output' method for this assembly.
+  # (will still generate 'show')
+  skip :output
+  def part(show)
+  end
+end

data/lib/templates/gitignore.tt ADDED Viewed

@@ -0,0 +1,3 @@
+output/*.scad
+output/*.gcode
+output/*.stl

data/lib/templates/guardfile.tt ADDED Viewed

@@ -0,0 +1,4 @@
+guard :shell do
+  watch(/<%= @name %>.rb/) { system('ruby <%= @name %>.rb') }
+  watch(%r{^lib/.+\.rb}) { system('ruby <%= @name %>.rb') }
+end

data/lib/templates/main.tt ADDED Viewed

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'solidruby'
+require 'require_all'
+include SolidRuby
+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.
+# Scans every file in lib/**/*.rb for classes and saves them in the output/ directory
+save!
+BillOfMaterial.bom.save('output/bom.txt')

data/lib/templates/params.tt ADDED Viewed

@@ -0,0 +1,3 @@
+#this is a good place to put common parameters used in different files
+#for example:
+$tolerance = 0.5

data/lib/templates/printed.tt ADDED Viewed

@@ -0,0 +1,9 @@
+require_relative '../params'
+class <%= @clean_name %> < SolidRuby::Printed
+  def initialize
+  end
+  def part(_show)
+  end
+end

data/manual/manual.html ADDED Viewed

@@ -0,0 +1,417 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>CrystalSCAD Manual</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+    <style type="text/css">
+      @import url(http://fonts.googleapis.com/css?family=Yanone+Kaffeesatz);
+      @import url(http://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic);
+      @import url(http://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700,400italic);
+      body { font-family: 'Droid Serif'; }
+      h1, h2, h3 {
+        font-family: 'Yanone Kaffeesatz';
+        font-weight: normal;
+      }
+      .remark-code, .remark-inline-code {
+				font-family: 'Ubuntu Mono';
+				font-weight: bold;
+				background-color: #CDCDCD !important;
+			}
+      body {
+        font-family: 'Droid Serif';
+      }
+      h1, h2, h3 {
+        font-family: 'Yanone Kaffeesatz';
+        font-weight: 400;
+        margin-bottom: 0;
+      }
+      .remark-slide-content h1 { font-size: 2.4em; }
+      .remark-slide-content h2 { font-size: 1.6em; }
+      .remark-slide-content h3 { font-size: 1.3em; }
+      .footnote {
+        position: absolute;
+        bottom: 3em;
+      }
+      li p { line-height: 1.25em; }
+      .red { color: #fa0000; }
+      .large { font-size: 2em; }
+      a, a > code {
+        color: rgb(160,160,255);
+        text-decoration: none;
+      }
+      code {
+        -moz-border-radius: 5px;
+        -web-border-radius: 5px;
+        background: #000000;
+        border-radius: 5px;
+      }
+      .remark-code-line-highlighted     { background-color: #373832; }
+      .pull-left {
+        float: left;
+        width: 47%;
+				text-align: left;
+				padding-left:50px;
+      }
+      .pull-right {
+        float: right;
+        width: 47%;
+      }
+      .pull-right ~ p {
+        clear: both;
+      }
+      #slideshow .slide .content code {
+        font-size: 0.8em;
+      }
+      #slideshow .slide .content pre code {
+        font-size: 0.9em;
+        padding: 15px;
+      }
+      .inverse {
+        background: #272822;
+        color: #ffffff;
+        text-shadow: 0 0 20px #333;
+				background-repeat: no-repeat;
+      }
+      .inverse2 {
+        background: #272822;
+        color: #ffffff;
+				font-size: 27px;
+       	text-shadow: 0 0 20px #333;
+				background-repeat: no-repeat;
+      }
+      .inverse h1, .inverse h2 {
+        color: #f3f3f3;
+        line-height: 0.8em;
+      }
+      /* Slide-specific styling */
+      #slide-inverse .footnote {
+        bottom: 12px;
+        left: 20px;
+      }
+      #slide-how .slides {
+        font-size: 0.9em;
+        position: absolute;
+        top:  151px;
+        right: 140px;
+      }
+      #slide-how .slides h3 {
+        margin-top: 0.2em;
+      }
+      #slide-how .slides .first, #slide-how .slides .second {
+        padding: 1px 20px;
+        height: 90px;
+        width: 120px;
+        -moz-box-shadow: 0 0 10px #777;
+        -webkit-box-shadow: 0 0 10px #777;
+        box-shadow: 0 0 10px #777;
+      }
+      /* Two-column layout */
+      .left {
+        color: #777;
+        width: 20%;
+        height: 92%;
+        float: left;
+      }
+      .left h2:last-of-type, .left h3:last-child {
+          color: #c5c5c5;
+        }
+      .right {
+        width: 75%;
+				float: right;
+        padding-top: 1em;
+      }
+			.bottom{
+				clear: both;
+			}
+     .counter {
+        position: absolute;
+        bottom: 1em;
+      }
+   </style>
+  </head>
+  <body>
+    <textarea id="source">
+# CrystalSCAD Installation
+Please make sure you have these packages installed on your system:
+## Requirements:
+- ruby >= 1.9.3
+- rubygems (optional)
+- OpenSCAD
+---
+# Installation via rubygems
+In your terminal, write:
+```sh
+sudo gem install solidruby
+```
+If you have a system with more than one rubygems installation (especially pre-1.9.3) you might need to replace 'gem' with 'gem1.9' or 'gem1.9.3' depending on how it is installed.
+---
+# Creating a project
+In your terminal, write:
+```sh
+crystalgen new <project name>
+```
+This will generate a new project directory in the directory you are in.
+## Example
+```sh
+$ crystalgen new hello_world
+      create  hello_world/hello_world.rb
+       chmod  hello_world/hello_world.rb
+      create  hello_world/lib/assemblies
+      create  hello_world/lib/electronics
+      create  hello_world/lib/hardware
+      create  hello_world/lib/printed
+      create  hello_world/lib/lasercut
+      create  hello_world/output
+      create  hello_world/lib/assemblies/hello_world_assembly.rb
+      create  hello_world/lib/printed/testcube.rb
+      create  hello_world/hello_world.observr
+```
+A lot of files were just created. We will look into those later.
+---
+# Your first project
+After you have created your project, go to your project folder in the terminal.
+```sh
+cd <project name>
+```
+## Example
+```sh
+$ cd hello_world
+```
+In this example, we have two files called hello_world.rb and hello_world.observr in that directory.
+You can try to run the first one now.
+```sh
+$ ./hello_world.rb
+```
+If it doesn't give you an output, it ran successfully. Note the .scad files in the output/ directory.
+If it gives an error at this point, see the next page
+---
+# Troubleshooting
+If you see an error message like this:
+```sh
+bash: ./hello_world.rb: /usr/bin/ruby1.9.3: bad interpreter: No such file or directory
+```
+You can either run the file with your ruby interpreter, for example:
+```sh
+ruby hello_world.rb
+```
+or (recommended) change the path to the ruby interpreter in your project file (hello_world.rb in this example).
+to do that, change the first line of your project file
+```c
+#!/usr/bin/ruby1.9.3
+```
+---
+# File Observer
+If you don't want to re-run the project file every time you change the code, you can use a tool called 'observr' to automatically generate new .scad files from your code.
+### Syntax:
+```sh
+observr <project_name>.observr
+```
+### Example:
+```sh
+$ observr hello_world.observr
+```
+This will run until you stop it (for example with ctrl+c). It does not give an output on success,
+but will return an error message every time there's something wrong with your code.
+*Note:* The observer has to be restarted when you create a new file.
+---
+# The lib directory [1/2]
+When you look in the lib/ directory in your project directory you will find several subdirectories:
+```sh
+$ cd lib
+$ ls
+assemblies  electronics  hardware  lasercut  printed
+```
+Of those, the directories assemblies and printed have some files in them. Let's have a quick overview about the intended purpose of each directory:
+### assemblies
+This is where you can combine multiple parts into one block. It is not mandatory to do this, but it might come in handy if you want to visualize parts that interact with each other.
+### electronics
+This is where you should put representations of your electronic parts
+---
+# The lib directory [2/2]
+### hardware
+This is where any (non-fabricated) mechanical parts you use in your project go
+### lasercut
+This is where you can put in lasercut sheets
+### printed
+This is where you define your 3D printed parts
+## Note:
+It is not mandatory to use the given directory structure. I made it that way to make it easier to reuse once defined components in other projects.
+---
+# Output files [1/3]
+After your have run your project file or the observer, there will be .scad files in the output/ directory.
+```sh
+$ ls -1
+Hello_worldAssembly_show.scad
+TestCube_my_subassembly.scad
+TestCube_output.scad
+TestCube_show.scad
+```
+This requires a bit of explanation.
+The file 'Hello_worldAssembly_show.scad' in this example is generated by hello_world_assembly.rb in lib/assemblies/
+Every file usually outputs two files:
+- filename_show.scad
+- filename_output.scad
+---
+# Output files [2/3]
+The assembly has produced only one file! Looking into the file hello_world_assembly.rb gives us the reason:
+```ruby
+	skip :output
+```
+This means that it skips the output method on file generation. Simple!
+But... what about the TestCube file that generated 3 files?
+Again, have a look into the file testcube.rb in lib/printed/
+```ruby
+	view :my_subassembly
+	def my_subassembly
+		[...]
+	end
+```
+This adds another output to the testcube file in addition to the ones that are generated by default (show and output).
+You can add as many "views" as you like to an object. This can be handy if you have complex parts or just want to
+work on subassemblies inside a part.
+---
+# Output files [3/3]
+If you had a look at the examples yet, you might have noticed that none of the files actually define 'show' or 'output' but instead do this:
+```ruby
+	def part(show)
+	 	[...]
+	end
+```
+This method can produce both show and output. The show variable is set to true when the 'show' output is generated, otherwise false. You can also instead define your own show or output methods:
+```ruby
+	def show
+		[...]
+	end
+```
+```ruby
+	def output
+		[...]
+	end
+```
+---
+# Small introduction to ruby
+TODO: variables, comments, class inheritance?
+---
+# Units
+All units are mm by default.
+###Note on how Ruby casts numeric values:
+```ruby
+@foo = 11 # Casts as Integer
+@bar = 11.0 # Casts as Decimal
+```
+This is important if you devide by an Integer, for example:
+```ruby
+@foo / 2 # results in 5
+@bar / 2 # results in 5.5
+```
+As good practice, you should divide by a Decimal, which will cast the Integer to Decimal:
+```ruby
+@foo / 2.0 # results in 5.5
+@bar / 2.0 # results in 5.5
+```
+---
+# Primitives
+## Cube
+Creates a cube at the origin of the coordinate system.
+```ruby
+# 2D modeling
+cube(x: value , y: value)
+# 3D modeling
+cube(x: value , y: value, z: value)
+# also accepts size, which will make a cube with x,y,z = 1
+cube(size: 1)
+```
+### Centering
+You can put one of these methods directly after the cube method:
+```ruby
+cube(size: 1).center # Center in X,Y and Z
+cube(size: 1).center_x # Center in X
+cube(size: 1).center_y # Center in Y
+cube(size: 1).center_xy # Center in X and Y
+cube(size: 1).center_z # Center Z
+```
+---
+## Cylinder
+Creates a cylinder centered in X & Y
+```ruby
+cylinder(d:5,h:10) # Creates a cylinder with diameter 5 and height 10
+```
+parameters:
+```ruby
+r: radius
+d: diameter
+h: height
+```
+---
+    </textarea>
+    <script src="https://gnab.github.io/remark/downloads/remark-latest.min.js" type="text/javascript">
+    </script>
+    <script type="text/javascript">
+      var slideshow = remark.create();
+    </script>
+  </body>
+</html>