Added in Doc module

traverseda · traverseda · commit 5a9e8ab38c70 · 2023-02-17T14:23:08.000-04:00
diff --git a/README.md b/README.md
@@ -84,5 +84,5 @@ interpreter.
 I don't want to give a false impression that it works from this carefully staged screenshot,
 it mostly doesn't.
 
-![](Screenshot_0.png)
+![](docs/Screenshot_0.png)
 
diff --git a/doc_extra.py b/doc_extra.py
@@ -0,0 +1,30 @@
+import multiprocessing
+from pathlib import Path
+import hashlib
+
+#Need to run this in a subprocess because of https://github.com/pyqtgraph/pyqtgraph/issues/2618
+def scad_image_subprocess(path, code_block):
+    from pysdfscad.main import OpenscadFile
+
+    file = OpenscadFile()
+    file.text=code_block
+    image = file.as_image()
+    image.save(str(path))
+
+
+def define_env(env):
+
+    @env.macro
+    def scad_image(code_block):
+        manager = multiprocessing.Manager()
+        digest = hashlib.md5(code_block.encode()).hexdigest()
+
+        imageRoot = Path('docs/images/auto')
+        imageRoot.mkdir(parents=True, exist_ok=True)
+        imagePath = imageRoot/(digest+".png")
+
+        if not imagePath.exists():
+            p = multiprocessing.Process(target=scad_image_subprocess, args=(imagePath, code_block))
+            p.start()
+            p.join()
+        return '```openscad'+code_block+'```\n\n'+f"![Preview of code block](/images/auto/{digest}.png)\n\n"
diff --git a/docs/3D_objects.md b/docs/3D_objects.md
@@ -0,0 +1,23 @@
+
+## Primitive Solids
+
+### Cube
+
+{{scad_image("""
+cube([10,10,10]);
+""")}}
+
+### Cylinder
+
+{{scad_image(
+"""
+cylinder(r=5,h=10);
+"""
+)}}
+
+### Sphere
+
+{{scad_image("""
+sphere(r=5);
+""")}}
+
diff --git a/docs/Screenshot_0.png b/docs/Screenshot_0.png
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1 @@
+::: pysdfscad.openscad_builtins
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,5 @@
+# Hephorge
+
+Programmers CAD with advanced features like bevels.
+
+![Main Screenshot](Screenshot_0.png)
diff --git a/docs/transformations.md b/docs/transformations.md
@@ -0,0 +1,92 @@
+# Transformations
+
+## From Openscad
+
+### Movement operations
+
+#### Translate
+
+{{scad_image(
+"""
+translate([-10,-10,5])cube([10,10,10]);
+"""
+)}}
+
+#### rotate
+
+{{scad_image(
+"""
+rotate([0,0,45])cube([10,10,10]);
+"""
+)}}
+
+### CSG operations
+
+Under Hephorge most CSG operations support the "smooth" argument.
+
+#### Difference
+
+{{scad_image(                       
+"""                                
+difference(){
+        cube([10,10,10]);
+        translate([12,12,-1])cylinder(r=10,h=12); 
+}
+"""
+)}}
+
+{{scad_image(                       
+"""                                
+difference(smooth = 1){
+        cube([10,10,10]);
+        translate([12,12,-1])cylinder(r=10,h=12); 
+}
+"""
+)}}
+
+#### Intersection
+
+{{scad_image(
+"""                                
+intersection(){
+        cube([10,10,10]);                  
+        cylinder(r=10,h=12); 
+}
+"""
+)}}
+
+{{scad_image(
+"""                                
+intersection(smooth=1){
+        cube([10,10,10]);                  
+        cylinder(r=10,h=12); 
+}
+"""
+)}}
+
+
+## Hephorge extentions
+
+### Blend
+
+{{scad_image(
+"""
+blend(ratio=0.5){
+	cube([10,10,10]);
+	translate([5,5,5])sphere(r=10);
+}
+"""
+)}}
+
+### Shell
+
+Very usefull for making things like pipes or moulds.
+
+{{scad_image(
+"""
+difference(){
+	shell(thickness=1)cube([10,10,10]);
+	translate([12,12,-1])cylinder(r=10,h=12);
+}
+"""
+)}}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,18 @@
+site_name: Hephorge
+theme:
+  name: readthedocs
+  highlightjs: true
+  hljs_languages:
+    - python
+    - openscad
+
+plugins:
+  - mkdocstrings
+  - search
+  - macros:
+      module_name: doc_extra
+
+nav:
+  - 3D_objects.md
+  - transformations.md
+  - api.md
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -25,6 +25,7 @@ pyqtgraph = {version = "^0.13.1", optional = true}
 pyopengl = {version = "^3.1.6", optional=true}
 appdirs = "^1.4.4"
 astor = "^0.8.1"
+mkdocs-macros-plugin = "^0.7.0"
 
 [tool.poetry.extras]
 qtgui = ["PyQt5","qscintilla","pysdfscad_qtgui","pyqtgraph","pyopengl"]
@@ -43,6 +44,9 @@ ordered-set = "^4.1.0"
 zstandard = "^0.19.0"
 pyinstaller = "^5.8.0"
 pyinstaller-hooks-contrib = "^2022.15"
+mkdocs = "^1.4.2"
+mkdocstrings = {extras = ["python"], version = "^0.20.0"}
+mkdocs-material = "^9.0.12"
 
 [build-system]
 requires = ["poetry-core"]
diff --git a/pysdfscad/main.py b/pysdfscad/main.py
@@ -3,6 +3,7 @@
 import pathlib, sys
 from pathlib import Path
 from pysdfscad.compiler import OpenscadToPy
+import numpy as np
 import astor
 
 #We can get general language definitions here: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Chapter_1_--_General
@@ -68,6 +69,50 @@ def run(self):
             scad_locals,
         )
         return list(scad_locals['main']())
+
+    def as_image(self):
+        from PyQt5 import QtWidgets, QtCore, QtGui, QtOpenGL
+        import pyqtgraph.opengl as gl
+        import pyqtgraph as pg
+
+        app = QtWidgets.QApplication([])
+
+        #Horrible hack to reset the shared opengl context
+
+        viewport = gl.GLViewWidget()        
+        viewport.setCameraPosition(distance=40)
+
+        result = list(self.run())[0]
+
+        points = result.generate()
+        points, cells = np.unique(points, axis=0, return_inverse=True)
+        cells = cells.reshape((-1, 3))
+    
+        meshdata = gl.MeshData(vertexes=points, faces=cells)
+        mesh = gl.GLMeshItem(meshdata=meshdata,
+                             smooth=False, drawFaces=True,
+                             drawEdges=False,
+                             shader="normalColor",
+                             color = (1,1,1,1), edgeColor=(0.2, 0.5, 0.2, 1)
+                             )
+
+        g = gl.GLGridItem()
+        g.setSize(200, 200)
+        g.setSpacing(10, 10) 
+
+        a=gl.GLAxisItem()                      
+        a.setSize(10,10,10)
+
+        viewport.addItem(a)
+        viewport.addItem(g)
+        viewport.addItem(mesh)
+        viewport.show()
+
+        imageData = viewport.renderToArray((1000, 1000))
+        image = pg.makeQImage(imageData).transformed(QtGui.QTransform().rotate(90))
+
+        return image 
+
     def as_ast(self):
         return astor.dump_tree(self.ast())
     def as_python(self):
diff --git a/pysdfscad/openscad_builtins.py b/pysdfscad/openscad_builtins.py
@@ -192,16 +192,18 @@ def inner(children):
         yield reduce(lambda a,b: sdf.difference(a,b,k=var_smooth), children)
     return inner
 
-def blend(context,ratio=0.5):
-    children=context.functions['children_list']()
-    child1 = children[0]
-    child2 = reduce(sdf.union,children[1:])
-    return child1.blend(child2,k=ratio)
+def module_blend(var_ratio=0.5):
+    def inner(children):
+        children = list(children()(no_children))
+        child1 = children[0]
+        child2 = reduce(sdf.union,children[1:])
+        yield child1.blend(child2,k=var_ratio)
+    return inner
 
-def module_shell(context,thickness=10):
-    def inner(children=lambda:()):
-        children = list(module_union()(children()))[0]
-        return children.shell(thickness)
+def module_shell(var_thickness=10):
+    def inner(children):
+        children = list(module_union()(children))[0]
+        yield children.shell(var_thickness)
     return inner
 
 def twist(context,degrees):
