Help Home·Table of Contents·GitHub

    Docs Tree

    BREP.io
    • Workbenches
      • All Workbench
      • Assemblies Workbench
      • Import Workbench
      • Modeling Workbench
      • PMI Workbench
      • Sheet Metal Workbench
      • Surfacing Workbench
      • Wire Harness Workbench
    • Modes
      • 2D Sheets Mode
      • Modeling Mode
      • PMI Mode
      • Sketch Mode
    • Features
      • Assembly Component
      • Boolean
      • Chamfer
      • Collapse Edge
      • Datium
      • Datum
      • Edge Smooth
      • Extrude
      • Fillet
      • Helix
      • Hole
      • Image Editor (Shared)
      • Image Heightmap Solid
      • Image to Face
      • Import 3D Model
      • Loft
      • Mirror
      • NURBS Face Solid
      • Offset Face
      • Offset Shell
      • Overlap Cleanup
      • Pattern (Legacy)
      • Pattern Linear
      • Pattern Radial
      • Plane
      • Polygon Solid
      • Primitive Cone
      • Primitive Cube
      • Primitive Cylinder
      • Primitive Pyramid
      • Primitive Sphere
      • Primitive Torus
      • Push Face
      • Remesh
      • Revolve
      • Sheet Metal Contour Flange
      • Sheet Metal Cutout
      • Sheet Metal Flange
      • Sheet Metal Hem
      • Sheet Metal Tab
      • Sketch
      • Smooth With Subdivision
      • Spline
      • Sweep
      • Text to Face
      • Thicken
      • Transform
      • Tube
    • Assembly Constraints
      • Angle Constraint
      • Assembly Constraint Solver
      • Coincident Constraint
      • Distance Constraint
      • Fixed Constraint
      • Parallel Constraint
      • Touch Align Constraint
    • PMI Annotations
      • Angle Dimension
      • Explode Body
      • Hole Callout
      • Leader
      • Linear Dimension
      • Note
      • Radial Dimension
    • Developer Docs
      • Application Architecture Docs
      • Application Subsystems Docs
      • Embedding and Integration Docs
      • Kernel and Geometry Docs
    • BREP Class API Reference
      • Edge Method Index
        • Edge.collapseToPoint()
        • Edge.constructor()
        • Edge.getMetadata()
        • Edge.length()
        • Edge.points()
        • Edge.setMetadata()
      • Face Method Index
        • Face.constructor()
        • Face.getAverageNormal()
        • Face.getMetadata()
        • Face.getNeighbors()
        • Face.points()
        • Face.renameFace()
        • Face.setMetadata()
        • Face.surfaceArea()
        • Face.thicken()
      • Solid Method Index
        • Solid._combineFaceMetadata()
        • Solid._combineIdMaps()
        • Solid._ensureFaceIndex()
        • Solid._expandTriIDsFromMesh()
        • Solid._fromManifold()
        • Solid._getOrCreateID()
        • Solid._getPointIndex()
        • Solid._isCoherentlyOrientedManifold()
        • Solid._key()
        • Solid._manifoldize()
        • Solid._weldVerticesByEpsilon()
        • Solid.addAuxEdge()
        • Solid.addCenterline()
        • Solid.addTriangle()
        • Solid.bakeTransform()
        • Solid.bakeTRS()
        • Solid.chamfer()
        • Solid.cleanupTinyFaceIslands()
        • Solid.clone()
        • Solid.collapseTinyTriangles()
        • Solid.constructor()
        • Solid.difference()
        • Solid.faces
        • Solid.fillet()
        • Solid.fixTriangleWindingsByAdjacency()
        • Solid.free()
        • Solid.getBoundaryEdgePolylines()
        • Solid.getEdgeMetadata()
        • Solid.getFace()
        • Solid.getFaceMetadata()
        • Solid.getFaceNames()
        • Solid.getFaceNormal()
        • Solid.getFaces()
        • Solid.getMesh()
        • Solid.getTriangleCount()
        • Solid.intersect()
        • Solid.invertNormals()
        • Solid.mergeTinyFaces()
        • Solid.mirrorAcrossPlane()
        • Solid.pushFace()
        • Solid.remesh()
        • Solid.removeDegenerateTriangles()
        • Solid.removeInternalTriangles()
        • Solid.removeInternalTrianglesByRaycast()
        • Solid.removeInternalTrianglesByWinding()
        • Solid.removeOppositeSingleEdgeFaces()
        • Solid.removeSmallInternalIslands()
        • Solid.removeSmallIslands()
        • Solid.removeTinyBoundaryTriangles()
        • Solid.renameFace()
        • Solid.setEdgeMetadata()
        • Solid.setEpsilon()
        • Solid.setFaceMetadata()
        • Solid.setTolerance()
        • Solid.simplify()
        • Solid.splitSelfIntersectingTriangles()
        • Solid.subtract()
        • Solid.surfaceArea()
        • Solid.toSTEP()
        • Solid.toSTL()
        • Solid.union()
        • Solid.visualize()
        • Solid.volume()
        • Solid.writeSTEP()
        • Solid.writeSTL()
    • 2D Sketch Solver (Standalone)
    • API Examples
    • BREP Kernel Reference
    • BREP Model and Classes
    • BREP.js Export Map and Usage
    • Bug Reporting and Repro Test Cases
    • C++ Solid Porting
    • CONTRIBUTING
    • Cylindrical Face Radius Embedding
    • Documentation Screenshots
    • Embeddable 2D Sketcher
    • Embeddable CAD App
    • Expressions and Configurator
    • Feature Dimension Gizmos (Developer)
    • File Formats: Import and Export
    • Fillet Process
    • Font Licenses
    • Getting Started
    • GitHub Repo Storage
    • Highlights
    • History Systems
    • How It Works
    • Input Params Schema
    • Inspector
    • LICENSE
    • PartHistory Reference
    • Plugins and Examples
    • Radius Metadata for Extruded Sketches
    • Recent Inspector Improvements
    • Simplified Radial Dimension Interface
    • Solid Developer Guide
    • Topological Face and Edge Naming Specification
    • UI Overview (Browser)
    • What's New
    • Workbench Implementation Plan
    Features

    Features

    Reference docs for the built-in modeling features.

    • Assembly Component
    • Boolean
    • Chamfer
    • Collapse Edge
    • Datium
    • Edge Smooth
    • Extrude
    • Fillet
    • Helix
    • Hole
    • Image Editor (Shared)
    • Image to Face
    • Image Heightmap Solid
    • Import 3D Model
    • Loft
    • Mirror
    • NURBS Face Solid
    • Offset Face
    • Offset Shell
    • Overlap Cleanup
    • Pattern (Legacy)
    • Pattern Linear
    • Pattern Radial
    • Plane
    • Polygon Solid
    • Primitive Cone
    • Primitive Cube
    • Primitive Cylinder
    • Primitive Pyramid
    • Primitive Sphere
    • Primitive Torus
    • Push Face
    • Remesh
    • Revolve
    • Sheet Metal Contour Flange
    • Sheet Metal Cutout
    • Sheet Metal Flange
    • Sheet Metal Hem
    • Sheet Metal Tab
    • Sketch
    • Smooth With Subdivision
    • Spline
    • Sweep
    • Text to Face
    • Thicken
    • Transform
    • Tube

    Datum remains as a legacy alias page; Datium is the canonical feature doc.