Merge pull request #11 from pks5/examples

Connectors, Examples

Author: pks5

bin/create-examples.py

@@ -3,19 +3,30 @@
 import re
 import argparse
 
+
 parser = argparse.ArgumentParser("create-examples")
 parser.add_argument("example_file", help="A JSON file with examples to create.", type=str)
 args = parser.parse_args()
 
-dir_path = os.path.dirname(os.path.realpath(__file__))
+#dir_path = os.path.dirname(os.path.realpath(__file__))
+#example_file_path = os.path.abspath(os.path.join(dir_path, args.example_file))
+
+example_file_path = os.path.abspath(os.path.relpath(args.example_file, start=os.curdir))
+
+if(not os.path.exists(example_file_path)):
+    print("Cannot open file: " + example_file_path)
+    exit(0)
 
-with open(dir_path + '/' + args.example_file) as f:
+with open(example_file_path, "r", encoding="utf-8") as f:
     d = json.load(f)
 
 for example in d['examples']:
-    target_dir = example['targetDirectory']
+    target_dir = os.path.abspath(os.path.join(example_file_path, '..', example['targetDirectory']))
     url = example['url']
-    file = open(dir_path + '/' + example['template'], "r")
+
+    template_file_path = os.path.abspath(os.path.join(example_file_path, '..', example['template']))
+
+    file = open(template_file_path, "r")
     brick_template = file.read()
     file.close()
 
@@ -26,16 +37,24 @@
         for param in brick['parameters']:
             val = brick['parameters'][param]
             if(isinstance(val, str)):
-                print('Replaced string param ' + param + ' with value ' + str(val).lower())
-                scad = re.sub(param + r'\s*=\s*\"[a-zA-Z0-9\.\-_\s]+\"\s*;', param + ' = "' + str(val).lower() + '";', scad)
+                try:
+                    print('Replaced string param ' + param + ' with value: ' + val)
+                except(UnicodeEncodeError):
+                    print('Replaced string param ' + param + ' with unicode value')
+                    
+                scad = re.sub(param + r'\s*=\s*\"[a-zA-Z0-9\.\-_\s]+\"\s*;', param + ' = "' + val + '";', scad)
             elif(isinstance(val, bool)):
-                print('Replaced bool param ' + param + ' with value ' + str(val).lower())
+                print('Replaced bool param ' + param + ' with value: ' + str(val).lower())
                 scad = re.sub(param + r'\s*=\s*((true)|(false))\s*;', param + ' = ' + str(val).lower() + ';', scad)
-            elif(isinstance(val, int)):
-                print('Replaced integer param ' + param + ' with value ' + str(val).lower())
-                scad = re.sub(param + r'\s*=\s*[0-9\.]+\s*;', param + ' = ' + str(val) + ';', scad)
-            
-        f = open(target_dir + "/" + file_name, "w")
+            elif(isinstance(val, (int, float))):
+                print('Replaced integer param ' + param + ' with value: ' + str(val))
+                scad = re.sub(param + r'\s*=\s*[0-9\.\-]+\s*;', param + ' = ' + str(val) + ';', scad)
+            elif(isinstance(val, list)):
+                print('Replaced list param ' + param + ' with value: ' + json.dumps(val))
+                scad = re.sub(param + r'\s*=\s*((\[[\[\]0-9\.\,]*\])|(\"[a-zA-Z0-9\.\-_\s]+\")|([0-9\.\-]+)|((true)|(false)))\s*;', param + ' = ' + json.dumps(val) + ';', scad)
+            else:
+                print('Did not replace param ' + param + ': unknown type!')
+        f = open(target_dir + "/" + file_name, "w", encoding="utf-8")
         f.write(scad)
         f.close()
         print("Wrote " + file_name)

bin/create-previews.sh

@@ -1,49 +1,43 @@
 #!/bin/bash
 
-PATH_TO_OPENSCAD="C:/Program Files/OpenSCAD/openscad.exe"
-#PATH_TO_OPENSCAD="/Applications/OpenSCAD.app/Contents/MacOS/OpenSCAD"
+# TODO Support Linux
+if [[ "$OSTYPE" == "darwin"* ]]; then
+   PATH_TO_OPENSCAD="/Applications/OpenSCAD.app/Contents/MacOS/OpenSCAD"
+else
+   PATH_TO_OPENSCAD="C:/Program Files/OpenSCAD/openscad.exe"
+fi
 
 PATH_TO_MAGICK="magick"
 
-DIR_DOCS="../docs"
-DIR_SETS="../sets"
-DIR_EXAMPLES="../examples"
-DIR_CLASSIC="../examples/classic"
-DIR_TECHNIC="../examples/technic"
-DIR_BOXES="../examples/boxes"
-DIR_TEXT="../examples/text"
-DIR_CUSTOM="../examples/custom"
-DIR_CORNER="../examples/corner"
-DIR_SLANTED="../examples/slanted"
-
 IMAGE_WIDTH=2400
 IMAGE_HEIGHT=1800
 IMAGE_BORDER=60
 IMAGE_WIDTH_FULL=$((IMAGE_WIDTH + 2 * IMAGE_BORDER))
 IMAGE_HEIGHT_FULL=$((IMAGE_HEIGHT + 2 * IMAGE_BORDER))
 IMAGE_WIDTH_HALF=$((IMAGE_WIDTH_FULL / 2))
 
-#declare -a arr=("$DIR_SETS" "$DIR_EXAMPLES")
-declare -a arr=("$DIR_TECHNIC")
-#declare -a arr=("$DIR_CORNER")
-
-echo
-echo Creating preview images ...
-echo
+if [ "$#" -lt 1 ]; then
+    echo "Usage: bash create-previews.sh [diretory1] [directory2] ..."
+    exit 1
+fi
 
 curDir=$(pwd)
 
 cd "$(dirname "$0")"
 
-for i in "${arr[@]}"
+for i in "$@"
 do
+   echo
+   echo "Creating preview images for folder '$i' ..."
+   echo
+
    find "$i" -name "*.scad" -print0 | while read -d $'\0' file
         do
             echo "Creating preview for ${file} ..."
             label="$(basename ${file})"
             label=${label//-/ }
             label=${label/.scad/}
-            label=`python -c "print('${label}'.title())"`
+            label=`python -c "print('${label}'[:28].title())"`
             image_file="${file/scad/png}"
 
             "$PATH_TO_OPENSCAD" --o "$image_file" --p "preview-parameters.json" --P BestQuality --csglimit 3000000 --imgsize ${IMAGE_WIDTH},${IMAGE_HEIGHT} --autocenter "$file"

bin/preview-parameters.json

@@ -3,7 +3,8 @@
     {
         "BestQuality": {
             "previewQuality": "1",
-            "roundingResolution": "128"
+            "roundingResolution": "128",
+            "viewMode": "cover"
         }
     },
     "fileFormatVersion": "1"

dev/slanted-brick-s2-4x2.scad

@@ -0,0 +1,116 @@
+/**
+* MachineBlocks
+* https://machineblocks.com/examples/slanted
+*
+* Slanted Brick S2 4x2
+* Copyright (c) 2022 - 2025 Jan Philipp Knoeller <pk@pksoftware.de>
+*
+* Published under license:
+* Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International 
+* https://creativecommons.org/licenses/by-nc-sa/4.0/
+*
+*/
+
+// Include the library
+use <../lib/block.scad>;
+
+/* [Size] */
+
+// Brick size in X-direction specified as multiple of an 1x1 brick.
+brickSizeX = 4; // [1:32]  
+// Brick size in Y-direction specified as multiple of an 1x1 brick.
+brickSizeY = 2; // [1:32]  
+// Height of brick specified as number of layers. Each layer has the height of one plate.
+baseLayers = 12; // [1:24]
+
+/* [Appearance] */
+
+// Type of cut-out on the underside.
+baseCutoutType = "classic"; // [none, classic]
+// Whether to draw knobs.
+knobs = true;
+// Whether knobs should be centered.
+knobCentered = false;
+// Type of the knobs
+knobType = "classic"; // [classic, technic]
+
+// Whether to draw pillars.
+pillars = true;
+
+// Whether brick should have Technic holes along X-axis.
+holesX = false;
+// Whether brick should have Technic holes along Y-axis.
+holesY = false;
+// Whether brick should have Technic holes along Z-axis.
+holesZ = false;
+
+// Whether brick should have a pit
+pit = false;
+// Whether knobs should be drawn inside pit
+pitKnobs = false;
+// Pit wall thickness as multiple of one brick side length
+pitWallThickness = 0.333;
+
+// Slanting size on X0 side specified as multiple of an 1x1 brick.
+slantingX0 = 2;
+// Slanting size on X1 side specified as multiple of an 1x1 brick.
+slantingX1 = -2;
+// Slanting size on Y0 side specified as multiple of an 1x1 brick.
+slantingY0 = 0;
+// Slanting size on Y1 side specified as multiple of an 1x1 brick.
+slantingY1 = 0;
+
+/* [Quality] */
+
+// Quality of the preview in relation to the final rendering.
+previewQuality = 0.5; // [0.1:0.1:1]
+// Number of drawn fragments for roundings in the final rendering.
+roundingResolution = 64; // [16:8:128]
+
+/* [Calibration] */
+
+// Adjustment of the height (mm)
+baseHeightAdjustment = 0.0;
+// Adjustment of each side (mm)
+baseSideAdjustment = -0.1;
+// Diameter of the knobs (mm)
+knobSize = 5.0;
+// Thickness of the walls (mm)
+wallThickness = 1.5;
+// Diameter of the Z-Tubes (mm)
+tubeZSize = 6.4;
+
+// Generate the block
+block(
+    grid = [brickSizeX, brickSizeY],
+    baseLayers = baseLayers,
+    baseCutoutType = baseCutoutType,
+    
+    knobs = knobs,
+    knobCentered = knobCentered,
+    knobType = knobType,
+    
+    pillars = pillars,
+    
+    holesX = holesX,
+    holesY = holesY,
+    holesZ = holesZ,
+    
+    pit = pit,
+    pitKnobs = pitKnobs,
+    pitWallThickness = pitWallThickness,
+    
+    slanting = ((slantingX0 != 0) || (slantingX1 != 0) || (slantingY0 != 0) || (slantingY1 != 0)) ? [slantingX0, slantingX1, slantingY0, slantingY1] : false, 
+
+    previewQuality = previewQuality,
+    baseRoundingResolution = roundingResolution,
+    holeRoundingResolution = roundingResolution,
+    knobRoundingResolution = roundingResolution,
+    pillarRoundingResolution = roundingResolution,
+
+    baseHeightAdjustment = baseHeightAdjustment,
+    baseSideAdjustment = baseSideAdjustment,
+    knobSize = knobSize,
+    wallThickness = wallThickness,
+    tubeZSize = tubeZSize
+);

examples/angle/angle-1x1x1.scad

@@ -0,0 +1,122 @@
+/**
+ * MachineBlocks
+ * https://machineblocks.com/examples/angle
+ *
+ * Angle 1x1x1
+ * Copyright (c) 2022 - 2025 Jan Philipp Knoeller <pk@pksoftware.de>
+ *
+ * Published under license:
+ * Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
+ * https://creativecommons.org/licenses/by-nc-sa/4.0/
+ *
+ */
+
+// Include the library
+use <../../lib/block.scad>;
+use <../../lib/connectors.scad>;
+
+/* [View] */
+// How to view the brick in the editor
+viewMode = "print"; // [print, assembled, cover]
+
+/* [Size] */
+
+// Both bricks' size in X-direction specified as multiple of an 1x1 brick.
+brickSizeX = 1; // [1:32]
+// First brick's size in Y-direction specified as multiple of an 1x1 brick.
+brick1SizeY = 1; // [1:32]
+// Second brick's size in Y-direction specified as multiple of an 1x1 brick.
+brick2SizeY = 1; // [1:32]
+// First brick's height specified as number of layers. Each layer has the height of one plate.
+brick1BaseLayers = 1; // [1:24]
+// Second brick's base height in mm
+brick2BaseHeight = 1.8;
+
+/* [Appearance] */
+
+// Type of cut-out on the underside.
+brick1BaseCutoutType = "classic"; // [none, classic]
+// Whether first brick should have knobs.
+brick1Knobs = true;
+// Type of first brick's knobs
+brick1KnobType = "classic"; // [classic, technic]
+// Whether second brick should have knobs.
+brick2Knobs = true;
+// Type of second brick's knobs
+brick2KnobType = "technic"; // [classic, technic]
+
+/* [Quality] */
+
+// Quality of the preview in relation to the final rendering.
+previewQuality = 0.5; // [0.1:0.1:1]
+// Number of drawn fragments for roundings in the final rendering.
+roundingResolution = 64; // [16:8:128]
+
+/* [Calibration] */
+
+// Adjustment of the height (mm)
+baseHeightAdjustment = 0.0;
+// Adjustment of each side (mm)
+baseSideAdjustment = -0.1;
+// Diameter of the knobs (mm)
+knobSize = 5.0;
+// Thickness of the walls (mm)
+wallThickness = 1.5;
+// Diameter of the Z-Tubes (mm)
+tubeZSize = 6.4;
+
+/* [Hidden] */
+
+// Grid Size XY
+gridSizeXY = 8.0;
+// Grid Size Z
+gridSizeZ = 3.2;
+
+// Generate the block
+union()
+{
+  block(grid = [ brickSizeX, brick1SizeY ],
+        baseLayers = brick1BaseLayers,
+        baseCutoutType = brick1BaseCutoutType,
+        connectors = [[ 2, 0 ] ],
+        knobs = brick1Knobs,
+        knobType = brick1KnobType,
+
+        previewQuality = previewQuality,
+        baseRoundingResolution = roundingResolution,
+        holeRoundingResolution = roundingResolution,
+        knobRoundingResolution = roundingResolution,
+        pillarRoundingResolution = roundingResolution,
+        
+        baseHeightAdjustment = baseHeightAdjustment,
+        baseSideAdjustment = baseSideAdjustment,
+        knobSize = knobSize,
+        wallThickness = wallThickness,
+        tubeZSize = tubeZSize);
+}
+
+translate(viewMode != "print" ? [0, -0.5 * brick1SizeY * gridSizeXY, 0.5 * brick2SizeY * gridSizeXY + (viewMode == "cover" ? (brick1BaseLayers + 2) * gridSizeZ : 0)] : [(brickSizeX + 0.5) * gridSizeXY, 0, 0]) 
+  rotate(viewMode != "print" ? [ 90, 0, 0 ] : [ 0, 0, 0 ])
+  {
+
+    block(grid = [ brickSizeX, brick2SizeY ],
+          baseHeight = brick2BaseHeight,
+          baseCutoutType = "none",
+          knobs = brick2Knobs,
+          knobType = brick2KnobType,
+          connectors = [ [ 2, 2 ] ],
+          connectorHeight = brick1BaseLayers * gridSizeZ,
+
+          previewQuality = previewQuality,
+          baseRoundingResolution = roundingResolution,
+          holeRoundingResolution = roundingResolution,
+          knobRoundingResolution = roundingResolution,
+          pillarRoundingResolution = roundingResolution,
+          
+          baseHeightAdjustment = baseHeightAdjustment,
+          baseSideAdjustment =
+            [ baseSideAdjustment, baseSideAdjustment, 0, baseSideAdjustment ],
+          knobSize = knobSize,
+          wallThickness = wallThickness,
+          tubeZSize = tubeZSize);
+  }