yapCAD 0.5.0__py2.py3-none-any.whl → 0.5.1__py2.py3-none-any.whl

yapcad/spline.py

@@ -0,0 +1,232 @@
+"""Spline helpers for yapCAD.
+
+Provides evaluation and sampling routines for spline primitives defined in
+:mod:`yapcad.geom`, including Catmull-Rom and NURBS curves.
+"""
+
+from __future__ import annotations
+
+from math import pow
+from typing import Iterable, List, Sequence, Tuple
+
+from yapcad.geom import point
+from yapcad.geometry_utils import to_vec3
+
+Vec3 = Tuple[float, float, float]
+
+
+def is_catmullrom(curve) -> bool:
+    """Return ``True`` if *curve* is a Catmull-Rom spline definition."""
+
+    return isinstance(curve, list) and len(curve) == 3 and curve[0] == 'catmullrom'
+
+
+
+
+def evaluate_catmullrom(curve, u: float) -> list:
+    """Evaluate a Catmull-Rom spline at parameter ``u`` in ``[0, 1]``."""
+
+    if not is_catmullrom(curve):
+        raise ValueError('curve is not a Catmull-Rom spline')
+    _, pts, meta = curve
+    ctrl = [point(p) for p in pts]
+    count = len(ctrl)
+    if count == 0:
+        raise ValueError('Catmull-Rom spline has no control points')
+    if count == 1:
+        return point(ctrl[0])
+
+    closed = bool(meta.get('closed', False))
+    segment_count = count if closed else count - 1
+    if segment_count <= 0:
+        return point(ctrl[-1])
+
+    u_clamped = max(0.0, min(1.0, float(u)))
+    span = u_clamped * segment_count
+    idx = int(span)
+    tau = span - idx
+    if idx >= segment_count:
+        idx = segment_count - 1
+        tau = 1.0
+
+    p0 = ctrl[(idx - 1) % count] if closed else ctrl[max(idx - 1, 0)]
+    p1 = ctrl[idx % count]
+    p2 = ctrl[(idx + 1) % count] if closed else ctrl[min(idx + 1, count - 1)]
+    p3 = ctrl[(idx + 2) % count] if closed else ctrl[min(idx + 2, count - 1)]
+
+    alpha = float(meta.get('alpha', 0.5))
+    return _catmullrom_point(p0, p1, p2, p3, alpha, tau)
+
+
+def evaluate_nurbs(curve, u: float) -> list:
+    """Evaluate a NURBS curve at parameter ``u`` in ``[0, 1]``."""
+
+    if not is_nurbs(curve):
+        raise ValueError('curve is not a NURBS definition')
+    _, ctrl, meta = curve
+    degree = int(meta['degree'])
+    knots = meta['knots']
+    weights = meta['weights']
+    u_start = knots[degree]
+    u_end = knots[-degree - 1]
+    u_clamped = max(0.0, min(1.0, float(u)))
+    real_u = u_start + (u_end - u_start) * u_clamped
+    return _nurbs_point([point(p) for p in ctrl], weights, knots, degree, real_u)
+
+def sample_catmullrom(curve, *, segments_per_span: int = 12) -> List[list]:
+    """Sample a Catmull-Rom spline into a list of :func:`point` values."""
+
+    if segments_per_span < 1:
+        raise ValueError('segments_per_span must be >= 1')
+    if not is_catmullrom(curve):
+        raise ValueError('curve is not a Catmull-Rom spline')
+
+    _, pts, meta = curve
+    alpha = float(meta.get('alpha', 0.5))
+    closed = bool(meta.get('closed', False))
+    ctrl = [point(p) for p in pts]
+    count = len(ctrl)
+    if count < 2:
+        raise ValueError('Catmull-Rom spline needs at least 2 control points')
+
+    samples: List[list] = []
+    segment_count = count if closed else count - 1
+    for i in range(segment_count):
+        p0 = ctrl[(i - 1) % count] if closed else ctrl[max(i - 1, 0)]
+        p1 = ctrl[i % count]
+        p2 = ctrl[(i + 1) % count] if closed else ctrl[min(i + 1, count - 1)]
+        p3 = ctrl[(i + 2) % count] if closed else ctrl[min(i + 2, count - 1)]
+
+        if not samples:
+            samples.append(point(p1))
+
+        for step in range(1, segments_per_span + 1):
+            tau = step / segments_per_span
+            samples.append(_catmullrom_point(p0, p1, p2, p3, alpha, tau))
+
+    return samples
+
+
+def _catmullrom_point(p0, p1, p2, p3, alpha: float, tau: float) -> list:
+    v0 = to_vec3(p0)
+    v1 = to_vec3(p1)
+    v2 = to_vec3(p2)
+    v3 = to_vec3(p3)
+
+    def tj(ti: float, pa: Vec3, pb: Vec3) -> float:
+        delta = ((pb[0] - pa[0]) ** 2 + (pb[1] - pa[1]) ** 2 + (pb[2] - pa[2]) ** 2) ** 0.5
+        return ti + pow(delta, alpha)
+
+    t0 = 0.0
+    t1 = tj(t0, v0, v1)
+    t2 = tj(t1, v1, v2)
+    t3 = tj(t2, v2, v3)
+
+    if t2 - t1 < 1e-12:
+        return point(*v2, 1.0)
+
+    t = t1 + (t2 - t1) * tau
+
+    A1 = _catmull_blend(v0, v1, t0, t1, t)
+    A2 = _catmull_blend(v1, v2, t1, t2, t)
+    A3 = _catmull_blend(v2, v3, t2, t3, t)
+
+    B1 = _catmull_blend(A1, A2, t0, t2, t)
+    B2 = _catmull_blend(A2, A3, t1, t3, t)
+
+    C = _catmull_blend(B1, B2, t1, t2, t)
+    return point(C[0], C[1], C[2])
+
+
+def _catmull_blend(a: Vec3, b: Vec3, t0: float, t1: float, t: float) -> Vec3:
+    denom = t1 - t0
+    if abs(denom) < 1e-12:
+        return b
+    w0 = (t1 - t) / denom
+    w1 = (t - t0) / denom
+    return (
+        a[0] * w0 + b[0] * w1,
+        a[1] * w0 + b[1] * w1,
+        a[2] * w0 + b[2] * w1,
+    )
+
+
+def is_nurbs(curve) -> bool:
+    """Return ``True`` if *curve* is a NURBS definition."""
+
+    return isinstance(curve, list) and len(curve) == 3 and curve[0] == 'nurbs'
+
+
+def sample_nurbs(curve, *, samples: int = 64) -> List[list]:
+    """Sample a NURBS curve into :func:`point` values."""
+
+    if samples < 2:
+        raise ValueError('samples must be >= 2')
+    if not is_nurbs(curve):
+        raise ValueError('curve is not a NURBS definition')
+
+    _, ctrl_points, meta = curve
+    degree = int(meta['degree'])
+    knots: Sequence[float] = meta['knots']
+    weights: Sequence[float] = meta['weights']
+    ctrl = [point(p) for p in ctrl_points]
+
+    u_start = knots[degree]
+    u_end = knots[-degree - 1]
+
+    samples_out: List[list] = []
+    for i in range(samples):
+        if i == samples - 1:
+            u = u_end
+        else:
+            u = u_start + (u_end - u_start) * (i / (samples - 1))
+        samples_out.append(_nurbs_point(ctrl, weights, knots, degree, u))
+    return samples_out
+
+
+def _nurbs_point(ctrl: Sequence[list], weights: Sequence[float], knots: Sequence[float], degree: int, u: float) -> list:
+    n = len(ctrl) - 1
+    numerator = [0.0, 0.0, 0.0]
+    denominator = 0.0
+    for i in range(n + 1):
+        basis = _nip(i, degree, u, knots)
+        if basis == 0.0:
+            continue
+        w = weights[i] * basis
+        v = to_vec3(ctrl[i])
+        numerator[0] += w * v[0]
+        numerator[1] += w * v[1]
+        numerator[2] += w * v[2]
+        denominator += w
+    if denominator == 0.0:
+        return point(ctrl[0])
+    return point(numerator[0] / denominator, numerator[1] / denominator, numerator[2] / denominator)
+
+
+def _nip(i: int, p: int, u: float, knots: Sequence[float]) -> float:
+    if p == 0:
+        if knots[i] <= u < knots[i + 1] or (u == knots[-1] and knots[i] < knots[i + 1]):
+            return 1.0
+        return 0.0
+
+    left = 0.0
+    denom = knots[i + p] - knots[i]
+    if denom != 0.0:
+        left = (u - knots[i]) / denom * _nip(i, p - 1, u, knots)
+
+    right = 0.0
+    denom = knots[i + p + 1] - knots[i + 1]
+    if denom != 0.0:
+        right = (knots[i + p + 1] - u) / denom * _nip(i + 1, p - 1, u, knots)
+
+    return left + right
+
+
+__all__ = [
+    'is_catmullrom',
+    'sample_catmullrom',
+    'evaluate_catmullrom',
+    'is_nurbs',
+    'sample_nurbs',
+    'evaluate_nurbs',
+]

{yapcad-0.5.0.dist-info → yapcad-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yapCAD
-Version: 0.5.0
+Version: 0.5.1
 Summary: yet another procedural CAD and computational geometry system
 Author-email: Richard DeVaul <richard.devaul@gmail.com>
 Project-URL: Homepage, https://github.com/rdevaul/yapCAD/
@@ -24,6 +24,9 @@ Requires-Dist: pyobjc-framework-Quartz; platform_system == "Darwin"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: meshcheck
+Requires-Dist: trimesh>=4.0; extra == "meshcheck"
+Requires-Dist: pymeshfix>=0.16; extra == "meshcheck"
 Dynamic: license-file
 
 **yapCAD**
@@ -37,6 +40,24 @@ python 3, now with a growing focus on 3D generative design and STL export
 
    **yapCAD** rocket example
 
+.. note::
+
+   The 3D rocket demo above was produced in a single shot by
+   ``gpt-5-codex`` from the prompt::
+
+      Using what you know about yapCAD, I'd like you to create a demo that
+      builds a simple 3D model of a rocket, visualizes it using pyglet, and
+      then writes out the STL file. I'd like the rocket to have a cluster of
+      five engines, guidance fins, a cylindrical body with at least one
+      diameter transition before the payload fairing, and an aerodynamic
+      fairing. Can you do this for me?
+
+.. figure:: images/RocketCutawaySTEP.png
+   :alt: **yapCAD** rocket cutaway STEP export
+
+   Internal layout generated with ``examples/rocket_cutaway_internal.py`` and
+   rendered from the exported STEP file in FreeCAD.
+
 what’s **yapCAD** for?
 ----------------------
 
@@ -52,10 +73,14 @@ geometry experiments.
 software status
 ---------------
 
-**yapCAD** is still very much in **beta**, although it is already being
-used by for professional engineering purposes. If you are using
-**yapCAD** in interesting ways, feel free to let us know in the `yapCAD
-discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
+**yapCAD** is in **active development** and is already being used for
+professional engineering purposes. Recent improvements include robust 3D
+boolean operations (union, intersection, difference) with proper normal
+orientation and degenerate triangle filtering. The 0.5.x series focuses on
+production-ready 3D workflows with validated STL and STEP export.
+
+If you are using **yapCAD** in interesting ways, feel free to let us know in the
+`yapCAD discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
 
 **yapCAD** installation, documentation, and examples
 ----------------------------------------------------
@@ -89,8 +114,10 @@ PYTHONPATH includes the cloned top-level ``yapCAD`` directory. You will
 find the examples in the ``yapCAD/examples`` directory.
 
 For a fully worked 2D parametric design system, see the ``boxcut`` example.
-For a 3D generative example that builds a multi-stage rocket, visualises
-it, and exports STL, see ``examples/rocket_demo.py``.
+For a 3D generative example that builds a multi-stage rocket, visualises it,
+and exports STL, see ``examples/rocket_demo.py``. To explore the new stacking
+and cutaway helpers while exporting STEP, run
+``examples/rocket_cutaway_internal.py`` whose output is shown above.
 
 documentation
 ~~~~~~~~~~~~~
@@ -99,7 +126,18 @@ Online **yapCAD** documentation can be found here:
 https://yapcad.readthedocs.io/en/latest/ — some module references lag
 behind the latest 3D-focused APIs, so you may want to build a local copy
 as described below to explore ``geometry_utils``, ``geometry_checks``,
-``metadata``, and ``io.stl``.
+``metadata``, and the ``yapcad.io`` exporters. Highlights from the most
+recent updates include:
+
+* ``yapcad.geometry_utils`` and ``yapcad.triangulator`` – triangle helpers
+  backing the ear-cut tessellator and faceted exporters.
+* ``yapcad.geom3d_util.stack_solids`` – quickly pack solids along an axis
+  using bounding boxes and optional ``space:<distance>`` directives.
+* ``yapcad.geom3d_util.cutaway_solid_x`` – trim solids against a plane to
+  create sectional visualisations.
+* ``yapcad.io.step``/``yapcad.io.stl`` – production-ready faceted exporters
+  suitable for interchange with FreeCAD, slicers, and other simulation tools.
+  STEP export supports multi-component assemblies with proper face orientation.
 
 To build the HTML **yapCAD** documentation locally, install the
 documentation dependencies and run Sphinx from the project root::
@@ -179,14 +217,18 @@ drawing file format. At present, **yapCAD** supports:
 
 * AutoCAD DXF output for two-dimensional drawings (via
   `ezdxf <https://github.com/mozman/ezdxf>`__).
-* STL export for 3D solids (via the new ``yapcad.io.stl`` module).
+* STL and STEP export for 3D solids (via ``yapcad.io.stl`` and
+  ``yapcad.io.step`` modules).
 * OpenGL visualisation for 2D/3D geometries using
   `pyglet <https://github.com/pyglet/pyglet>`__.
+* Modular 3D boolean operations supporting both native and external engines
+  (trimesh with Manifold/Blender backends).
 
-The 0.5.0 release lays the shared foundations (triangle utilities,
-metadata, validation checks, and STL export) that pave the way toward STEP
-support and a packaged, provenance-aware project model targeted for the
-forthcoming 1.0 release.
+The 0.5.x series delivers robust 3D boolean operations, validated primitive
+generation (sphere, cylinder, cone, tube, etc.), comprehensive mesh validation
+tools, and production-ready export capabilities. These foundations pave the way
+toward enhanced STEP support and a packaged, provenance-aware project model
+targeted for the forthcoming 1.0 release.
 
 The foundations of **yapCAD** are grounded in decades of the author’s
 experience with graphics system programming, 3D CAD and simulation.
@@ -242,13 +284,17 @@ is a DXF example:
    dd.display()
 
 For a 3D example that generates a complete rocket assembly and exports
-STL::
+STL and STEP::
 
    from pathlib import Path
    from examples.rocket_demo import build_rocket, export_stl
+   from yapcad.io.step import write_step
 
    components, assembly = build_rocket()
    export_stl(assembly, Path("rocket_demo.stl"))
+   write_step(assembly, Path("rocket_demo.step"))
+
+There is also an advanced ``rocket_grid_demo.py`` example featuring grid fins, a linear exploded view, and simultaneous STL/STEP export.
 
 The **yapCAD** system isn’t just about rendering, of course, it’s about
 computational geometry. For example, if you want to calculate the

yapcad-0.5.1.dist-info/RECORD

@@ -0,0 +1,32 @@
+yapcad/__init__.py,sha256=CUEd7EOL-ne31ggDprsi4lwLWMV1SRV5KYqkuDTdxrQ,400
+yapcad/combine.py,sha256=GXUH8viTW2hh937xggFi22FPJKB40NgZsJlvF4Rm-TM,4071
+yapcad/drawable.py,sha256=8q_THd5Hc6smtAgb4kczYWG_7cjOA1YeEJxChnO0puE,31988
+yapcad/ezdxf_drawable.py,sha256=o6Rei044ROkaniHZJwyBGtahaD3BU1927-AkFpPzqwE,5966
+yapcad/geom.py,sha256=vly-FqZgiBaoN5XeFKgpcIVDGVkVJ-2RFAMXgbvexI0,109138
+yapcad/geom3d.py,sha256=0RC6PS3ZjbQRMYVax-HShxXAKq2urVIXlyjGiVwzfyg,41225
+yapcad/geom3d_util.py,sha256=Wf8aZaK04riqtD38MrbWJudl5gNvllFNIeK74EVgtgo,33019
+yapcad/geom_util.py,sha256=LpiCUI7gaSIPHWKvrWQTalGwgHGp4m01YBiHe3EpTnQ,29888
+yapcad/geometry.py,sha256=FcIF94a_usw04C0RDJDRDCCi44eya7lyahlU1Vw9wXM,16145
+yapcad/geometry_checks.py,sha256=ABI0t5kls2HAidyyPp_EdoVqPxJAEtCWysPKvCeSK3s,2975
+yapcad/geometry_utils.py,sha256=N_073tEV08AKjJRTeuNJMPjPgonFPUeiuh_jY7Xx7mA,3438
+yapcad/mesh.py,sha256=QmPMeqdToyLztPupY8vSHQfrUz3UEBH1p8Pa9XFVPCg,1329
+yapcad/metadata.py,sha256=6foSa_4N9-PO4kL8YchbXboXZZFjEcUSG6F1spwGCVE,3096
+yapcad/octtree.py,sha256=MxyNMgozeLUBK5cC5_IC_9fK4BqSg4VeoKP389AUVmM,19793
+yapcad/poly.py,sha256=y5cSiCbA-pCbkO5zIa9kVk2_00w7FkWxY380nK14wt4,16549
+yapcad/pyglet_drawable.py,sha256=etgul99FOywq3rXf9uNu6cd59cECe4OMYX_ht5BcyMw,38424
+yapcad/spline.py,sha256=f0ClanLQIUXIcQElgo5asgsx6W1Z8xJb9KHvrfseKPM,6983
+yapcad/triangulator.py,sha256=hwxoxb564wZRYPEYbGiD-SDPu_x_SueYha0Kjmnu3Bo,3210
+yapcad/xform.py,sha256=Qy_KYqbTcmspmKZfo-OGU_1Z3XRpL7p5buwc5uAzlvo,9537
+yapcad/boolean/__init__.py,sha256=Q9_kUUk1OnBWdxoHGzXoIuA9l5X0IGtTe_snUfxYoxE,420
+yapcad/boolean/native.py,sha256=pRqvuMkrnB6r7BLmNU73gH8P_xM9fktSEq8jqOAlypE,33114
+yapcad/boolean/trimesh_engine.py,sha256=2CwsnZsW7GJLoEpIw33PlhZFhDPXm3wUo5pJRgYyyLQ,5567
+yapcad/io/__init__.py,sha256=-OfsQgxQ08DjDXUKF9zuLFT6rhapZXSmXluh8m4_hu0,128
+yapcad/io/step.py,sha256=sN19LSjAnr2E9KbT8yNuwBVBI2ZEeTYo8DL1cnXi2p8,11387
+yapcad/io/stl.py,sha256=HNICfPz_CXYIbTP7d4spdSkMdmrt3d825MNzYA9ah9w,2596
+yapcad-0.5.1.dist-info/licenses/AUTHORS.rst,sha256=JzvJA3p1aSIOTaaB3aCtB-ZrUQrVm869gdROUV5bRh8,84
+yapcad-0.5.1.dist-info/licenses/LICENSE,sha256=NkGvciCD5MEHmCtnivAi2PqcEhBYAkSAarP-bWAoknM,1071
+yapcad-0.5.1.dist-info/licenses/LICENSE.txt,sha256=FyT_Hxn5USuJ1Mu3-4Ou4T2x-Dzfiy06ZOnWkfdJ33o,1081
+yapcad-0.5.1.dist-info/METADATA,sha256=gnE0OaZO6gryOzWJ2qfsoybo5k6orpp0wcPM8oAVLR0,24096
+yapcad-0.5.1.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+yapcad-0.5.1.dist-info/top_level.txt,sha256=NAtnfsyeALrvhI63FGS3_TEUh26OKRvnm1_lCOOgjKA,7
+yapcad-0.5.1.dist-info/RECORD,,

yapcad-0.5.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-yapcad/__init__.py,sha256=CUEd7EOL-ne31ggDprsi4lwLWMV1SRV5KYqkuDTdxrQ,400
-yapcad/combine.py,sha256=WhI3D9lSZFzu1HD68HGUTbNNrJsT4SeCl1MOcjxsa1k,2932
-yapcad/drawable.py,sha256=kPYbIhOD5MesmRSeXTiFJoE1UwVQWekoeu19athfH7Y,15843
-yapcad/ezdxf_drawable.py,sha256=o6Rei044ROkaniHZJwyBGtahaD3BU1927-AkFpPzqwE,5966
-yapcad/geom.py,sha256=bg_ayg1aovT17HwgFwoJ7HbvI2InEjii9Bvr8PoZ04g,105604
-yapcad/geom3d.py,sha256=c6MleS-AiCWdju_mtPzUd7vhzkoT5nlJvoz7yimwdwU,33415
-yapcad/geom3d_util.py,sha256=O-LUVqk2-BmFb-g-2ex44vHwKK_U4xCfqMY5Cevbvi8,15663
-yapcad/geom_util.py,sha256=GMfgCyXuv9J4mdOfkqxNZT7EZZFEMV_ZpVTfuol8ve8,26370
-yapcad/geometry.py,sha256=FcIF94a_usw04C0RDJDRDCCi44eya7lyahlU1Vw9wXM,16145
-yapcad/geometry_checks.py,sha256=ABI0t5kls2HAidyyPp_EdoVqPxJAEtCWysPKvCeSK3s,2975
-yapcad/geometry_utils.py,sha256=N_073tEV08AKjJRTeuNJMPjPgonFPUeiuh_jY7Xx7mA,3438
-yapcad/mesh.py,sha256=QmPMeqdToyLztPupY8vSHQfrUz3UEBH1p8Pa9XFVPCg,1329
-yapcad/metadata.py,sha256=6foSa_4N9-PO4kL8YchbXboXZZFjEcUSG6F1spwGCVE,3096
-yapcad/octtree.py,sha256=MxyNMgozeLUBK5cC5_IC_9fK4BqSg4VeoKP389AUVmM,19793
-yapcad/poly.py,sha256=y5cSiCbA-pCbkO5zIa9kVk2_00w7FkWxY380nK14wt4,16549
-yapcad/pyglet_drawable.py,sha256=etgul99FOywq3rXf9uNu6cd59cECe4OMYX_ht5BcyMw,38424
-yapcad/triangulator.py,sha256=hwxoxb564wZRYPEYbGiD-SDPu_x_SueYha0Kjmnu3Bo,3210
-yapcad/xform.py,sha256=Qy_KYqbTcmspmKZfo-OGU_1Z3XRpL7p5buwc5uAzlvo,9537
-yapcad/io/__init__.py,sha256=EDwSGx-0na9fZabaK57zrq3GwEtkwN5Vo_pTS-ZtuXQ,85
-yapcad/io/stl.py,sha256=HNICfPz_CXYIbTP7d4spdSkMdmrt3d825MNzYA9ah9w,2596
-yapcad-0.5.0.dist-info/licenses/AUTHORS.rst,sha256=JzvJA3p1aSIOTaaB3aCtB-ZrUQrVm869gdROUV5bRh8,84
-yapcad-0.5.0.dist-info/licenses/LICENSE,sha256=NkGvciCD5MEHmCtnivAi2PqcEhBYAkSAarP-bWAoknM,1071
-yapcad-0.5.0.dist-info/licenses/LICENSE.txt,sha256=FyT_Hxn5USuJ1Mu3-4Ou4T2x-Dzfiy06ZOnWkfdJ33o,1081
-yapcad-0.5.0.dist-info/METADATA,sha256=mWZ0DsMbSzQc7KiStxZIsGzsyEVCr9dor9KnrDtH2m0,21651
-yapcad-0.5.0.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-yapcad-0.5.0.dist-info/top_level.txt,sha256=NAtnfsyeALrvhI63FGS3_TEUh26OKRvnm1_lCOOgjKA,7
-yapcad-0.5.0.dist-info/RECORD,,