Changelog

Version 1.0.1 (Development)

what’s new:

• 3D Text Support: New yapcad.text3d module provides 3D text generation for labeling parts and creating extruded or engraved text:

  • text_solid() - Creates extruded 3D text as a solid

  • engrave_text() - Cuts text into a solid surface using boolean difference

  • text_to_polygons() - Converts text to 2D polygons for custom workflows

  • Supports TrueType/OpenType fonts (via freetype-py) or built-in block font

  • Auto-detects Arial font or falls back to simple printable block characters

• Fillet and Chamfer Operations: New BREP edge operations in yapcad.brep for rounding and beveling edges (requires pythonocc-core):

  • fillet_all_edges() - Apply rounded fillets to all edges of a solid

  • chamfer_all_edges() - Apply beveled chamfers to all edges of a solid

  • fillet_edges() - Apply fillets to specific selected edges

  • chamfer_edges() - Apply chamfers to specific selected edges

  • Integrates with DSL via new builtins (fillet_all, chamfer_all)

• Edge Selection Predicates: New yapcad.brep_edge_select module provides sophisticated edge selection for selective fillet/chamfer operations:

  • select_vertical_edges() - Select edges parallel to the Z axis

  • select_horizontal_edges() - Select edges perpendicular to the Z axis

  • select_edges_by_direction() - Select edges parallel to an arbitrary direction

  • select_edges_by_length() - Select edges within a length range

  • select_edges_at_z() - Select edges at a specific Z height

  • select_edges_in_z_range() - Select edges within a Z coordinate range

  • select_edges_crossing_z() - Select vertical edges spanning a Z value

  • select_top_edges() - Select edges at the maximum Z height

  • select_bottom_edges() - Select edges at the minimum Z height

  • select_edges_near_point() - Select edges near a target point

  • select_edges_in_cylinder() - Select edges within a cylindrical region

  • filter_linear_edges() - Filter to keep only straight edges

  • filter_curved_edges() - Filter to keep only curved edges

  • Set operations: union_edges(), intersect_edges(), subtract_edges() for combining selections

  • edge_info() - Query detailed geometric properties of edges

• Helical Extrusion: New helical_extrude() function in yapcad.geom3d_util creates smooth helical/twisted extrusions using high-resolution lofting. Ideal for helical gears, twisted columns, and spiral features. Requires pythonocc-core.

• Pattern Functions: New pattern generation functions for creating arrays of geometry:

  • radial_pattern() in yapcad.geom_util - Creates circular patterns of 2D geometry

  • linear_pattern() in yapcad.geom_util - Creates linear arrays of 2D geometry

  • radial_pattern_solid() in yapcad.geom3d_util - Creates circular patterns of 3D solids

  • linear_pattern_solid() in yapcad.geom3d_util - Creates linear arrays of 3D solids

  • radial_pattern_surface() in yapcad.geom3d_util - Creates circular patterns of surfaces

  • linear_pattern_surface() in yapcad.geom3d_util - Creates linear arrays of surfaces

• OCC Helix Helper: New make_occ_helix() function creates mathematically exact helix curves using OpenCascade’s 2D parametric curve on cylindrical surface technique. Used internally by helical_extrude() but also available for advanced users.

• Bezier Curve Support: New Bezier curve primitives in yapcad.geom and yapcad.spline modules for creating smooth parametric curves:

  • bezier() - Constructor for Bezier curves of any degree (linear, quadratic, cubic, etc.)

  • bezier_point() - Evaluate Bezier curve at parameter t using De Casteljau’s algorithm

  • bezier_tangent() - Compute tangent vector at any point on the curve

  • bezier_curve() - Sample Bezier curve as a polyline for rendering

  • isbezier() - Type predicate for Bezier curve objects

  • Full integration with sample(), length(), center(), and bbox() functions

• B-spline Curve Support: New B-spline curve primitives for complex smooth curves with local control in yapcad.geom and yapcad.spline modules:

  • bspline() - Constructor for open or closed B-spline curves with configurable degree

  • bspline_point() - Evaluate B-spline curve at parameter t

  • bspline_tangent() - Compute tangent vector using numerical differentiation

  • bspline_curve() - Sample B-spline curve as a polyline

  • isbspline() - Type predicate for B-spline curve objects

  • Support for both open and closed curves via closed=True parameter

  • Full integration with yapCAD geometry functions (sample(), length(), center(), bbox())

• Curve-based 3D Operations: New functions in yapcad.geom3d_util for creating solids from curved paths:

  • loft() - Create smooth solids by transitioning between 2D profiles at different Z heights

  • sweep_along_path() - Extrude 2D profiles along Bezier or B-spline path curves

  • Support for organic shapes, tapered forms, and complex swept geometries

• Documentation Improvements: All new functions include comprehensive docstrings with parameter descriptions, return values, usage examples, and notes following Sphinx documentation standards.

Version 1.0.0rc1 (2025-12-30)

First release candidate for yapCAD 1.0

This release represents the culmination of the yapCAD 1.0 roadmap, delivering a requirements-driven, provenance-aware design platform with full solid modeling, packaging, and validation capabilities.

what’s new:

• Validation Schema Implementation: Complete validation test schema with yapcad.package.analysis.schema module providing ValidationKind, ResultStatus, ComparisonOp enums and validate_plan(), validate_result() APIs. Supports geometric, measurement, structural, thermal, CFD, multiphysics, and assembly test kinds.

• Package Signing: Provisional package signing with GPG and SSH keys. sign_package(), verify_package(), list_signatures() APIs for cryptographic verification of package integrity and authorship.

• DSL Enhancements: Conditional expressions (value if cond else other), nested list comprehensions ([f(x,y) for x in xs for y in ys if cond]), and functional combinators (union_all, difference_all, sum, product, min_of, max_of, any_true, all_true).

• Documentation Reorganization: Historical planning documents moved to docs/historical/. All specification documents updated to v1.0 status.

• Test Suite: 584 passing tests covering geometry, DSL, import/export, packaging, validation schema, and fasteners.

specifications finalized:

• ycpkg-spec-v1.0 - Package format specification

• metadata-namespace-v1.0 - Metadata dictionary specification

• validation-schema-v1.0 - Validation test schema

• ycpkg-signing-v1.0 - Package signing specification

• yapcad-geometry-json-v1.0 - Geometry JSON schema

• Material schema specification v1.0

deferred to 1.1:

• Multi-signature approval workflows

• Delegation and authority chains

• Revocation lists

• Full audit trails

• Solver adapter framework (generalized FEA/simulation integration)

Version 0.6.3 (2025-12-17)

what’s new:

• DSL 2D Geometry Features: New curve types (ellipse, catmull-rom splines, NURBS), 2D regions (polygon, disk), and 2D boolean operations (union2d, difference2d, intersection2d) with proper hole accumulation for chained operations.

• DXF Export: 2D geometry can now be exported to DXF format via --output foo.dxf for visualization in CAD programs. Supports lines, arcs, ellipses, splines, polylines, and regions.

• Curve Operations: New sample_curve() and curve_length() builtins for sampling points along curves and measuring arc length.

• OCC BREP Kernel Complete: Full bidirectional conversion between native yapCAD BREP representation and OpenCascade shapes. Box, cylinder, sphere, and cone primitives achieve 100% volume fidelity in round-trip testing. All seven development phases documented in docs/BREP_integration_strategy.md are now complete.

• Adaptive Sweep Operations: sweep_adaptive() and sweep_adaptive_hollow() with tangent-tracking profile orientation and ruled lofting.

• Materials & Fasteners: Added material property schema (docs/material_schema_spec.md) supporting density, color, finish, and physical properties. Complete metric and unified fastener catalogs with proper thread geometry.

• Documentation Accuracy: Updated docs/yapCADone.rst roadmap to clearly separate implemented features from planned work.

• Viewer Clipping Planes: Added X/Y/Z clipping plane toggles to the package viewer for inspecting interior geometry. Press X, Y, or Z to cycle through off/+/- states; press C to clear all planes. Essential for examining screw/nut fit and internal features.

bug fixes:

• Fixed difference2d to properly accumulate holes in chained operations. Previously, subtracting multiple holes would lose earlier holes due to structure flattening.

• Fixed isinsideXY corner case workaround in 2D booleans where test rays passing through polygon vertices caused incorrect inside/outside detection.

• Removed unsupported SOLID entities from DXF output by using setup=False in ezdxf initialization, improving FreeCAD compatibility.

Known problems

• Analytic STEP export preserves BREP data but complex surfaces may tessellate.

Version 0.6.1 (2025-10-30)

what’s new:

• Documentation Polish: Converted packaging/DSL/BREP specifications to reStructuredText, added the roadmap snapshot to the Sphinx toctree, and rebased all release references on the refreshed docs set. Sphinx builds now complete without missing toctree warnings.

• Analysis Planning: Documented validation plan schema, expanded the metadata namespace for analysis annotations, and introduced the ycpkg_analyze CLI plus plan-loading APIs. The bundled CalculiX backend now generates an axisymmetric plate approximation, invokes ccx when available, and records maximum axial deflection for acceptance checks.

• Viewer Performance: Layered triangle meshes are cached as pyglet vertex lists, eliminating per-frame immediate-mode uploads and noticeably improving pan/rotate responsiveness in the four-view window.

Known problems

• Analytic STEP export and full BREP kernel support remain in planning (docs/yapBREP.rst).

• DSL compiler/validator tooling tracked in docs/dsl_spec.rst remains under development.

Version 0.6.0 (2025-10-28)

what’s new:

• Package Format: .ycpkg manifests now capture canonical entities, reusable instances, metadata layers, and JSON geometry version 0.6.0 for reliable round-tripping between authoring, export, and viewer tooling.

• Involute Gear Toolkit: Vendored the MIT-licensed figgear generator (yapcad.contrib.figgear) so gear examples and tests no longer require external clones. Canonical gear packages embed both 2D profiles and extruded solids with provenance metadata.

• Viewer Enhancements: Added four-view layout updates (grids, lighting, layer toggles, help overlay) and fixed revolution solid cap normals along with trackpad gesture support.

• DXF / Spline Upgrades: Native exporter writes analytic CIRCLE/ARC elements, spline loops remain watertight, and extrusion tests cover spline-based perimeters and holes.

• Documentation Refresh: Roadmap snapshot (docs/yapCADone.rst), BREP plan (docs/yapBREP.rst), and README/Sphinx front matter updated for the 0.6 series.

Known problems

• Analytic STEP export and full BREP kernel support remain in planning (docs/yapBREP.rst).

• DSL compiler/validator tooling tracked in docs/dsl_spec.rst remains under development.

Version 0.5.1 (2025-10-14)

what’s new:

• 3D Boolean Operations Fixes: Complete overhaul of solid boolean operations with robust normal orientation and interior triangle filtering.

  • Fixed sphere union normal orientation issues by filtering interior overlap triangles

  • Added quality-based filtering for degenerate sliver triangles (aspect ratio checks)

  • Implemented containment-based filtering to remove artifacts in overlap regions

  • All primitive tests now pass with correct watertight geometry

• 2D Boolean Operations Fixes: Resolved crash when performing boolean operations on Circle and other single-geometry primitives.

  • Fixed geometry wrapping in Boolean._prepare_geom() to handle unwrapped arc format

  • Added comprehensive regression tests for 2D boolean operations

• Primitive Improvements: Enhanced reliability of 3D geometric primitives.

  • Fixed conic() primitive to generate proper watertight solids

  • Fixed tube() primitive normal orientation and end cap connectivity

  • All 9 core primitives (box, sphere, cylinder, cone, tube, etc.) validated as watertight

• Modular Boolean Engine Architecture: Separated boolean operations into yapcad.boolean.native module for better maintainability.

  • Support for multiple boolean engine backends (native, trimesh:manifold, trimesh:blender)

  • Engine selection via solid_boolean(..., engine='native') parameter

  • Environment variable support (YAPCAD_BOOLEAN_ENGINE, YAPCAD_TRIMESH_BACKEND)

• Test Suite Improvements: Enhanced test coverage and reliability.

  • 106 tests passing (up from 99 in v0.5.0)

  • Added boolean regression test suite

  • Improved solid topology tests with better error reporting

Known problems

• Incomplete documentation for some advanced 3D features.

• STEP export currently supports tessellated geometry; analytical BREP support planned for 1.0.

Version 0.5.0 (2024-09-30)

what’s new:

• Adds shared geometry utilities and metadata helpers.

• Introduces STL export (yapcad.io.stl) plus tests.

• Provides examples/rocket_demo.py showing a full 3D workflow.

• Updates documentation with 3D-focused imagery and instructions.

Known problems

• Incomplete documentation, though this is improving.

Version 0.4.0 (Development)

what’s new:

• Testing Infrastructure Overhaul: Completely redesigned test execution system to properly support both automated and interactive visual tests.

  • Added comprehensive pytest markers: @pytest.mark.visual for interactive tests

  • Created run_visual_tests.py and run_visual_tests_venv.sh for isolated visual test execution using subprocess isolation

  • Enhanced test discovery using AST parsing to automatically find decorated visual tests

  • Fixed visual test termination issues that were causing pytest to exit prematurely

  • Updated all test documentation with clear separation between non-visual and visual testing

• 3D Geometry Enhancements: Merged advanced 3D surface representation and geometry system improvements from development branch, including enhanced Geometry class architecture and improved computational geometry operations.

Known problems

• Incomplete documentation, especially outside the yapcad.geom module.

• Occasional problems with complex boolean operations.

• Incomplete functionality around 3D modeling.

Version 0.3.1

what’s new:

• Added Read the Docs configuration and docs/requirements.txt so hosted builds use a consistent environment.

• Updated README instructions for building documentation and running tests.

• Follow-up to 0.3.0 (no functional code changes).

Known problems

• Incomplete documentation, especially outside the yapcad.geom module.

• Occasional problems with complex boolean operations.

• Incomplete functionality around 3D modeling.

Version 0.3.0

what’s new:

• Require Python 3.10+ and align dependency metadata with current interpreter and library versions.

• Pin pyglet to 1.x rendering backend and add fallback guards to every OpenGL-enabled example so they degrade gracefully on systems without a working pyglet/Cocoa stack.

• Sphinx documentation now builds even when optional themes are missing, and sphinx-apidoc no longer depends on pkg_resources.

Known problems

• Incomplete documentation, especially outside the yapcad.geom module.

• Occasional problems with complex boolean operations.

• Incomplete functionality around 3D modeling.

Version 0.2.0

what’s new:

• First announced version of yapCAD. Yay!

• Added new boxcut example, showing a fully worked (if simple) parametric design system.

• Additional documentation updates and minor bugfixes.

Known problems

• Our yapCAD readthedocs documentation is missing the expanded documentation from submodules, which is a problem since much of yapCAD’s documentation is in the form of docstrings in the source. I’m working on getting this sorted out. In the mean time, you may want to build a local copy of the documentation as described in the main README file. Or, checkout and read the source.

• Incomplete documentation, especially outside the yapcad.geom module.

• Occasional problems with complex boolean operations. A bug in the intersectXY method of the Boolean class.

• Incomplete functionality around 3D modeling

• Inconsistent inclusion of licensing boilerplate, other minor formatting issues.

Version 0.1.5

what’s new:

• Pre-release, heading towards V0.2.x

• Restructuring for package release

• Lots more documentation (still incomplete)

• Fixes to package configuration

Known problems

• Incomplete documentation, especially outside the yapcad.geom module.

• Occasional problems with complex boolean operations

• Incomplete functionality around 3D modeling

• Inconsistent inclusion of licensing boilerplate