brepjs API Reference
    Preparing search index...

    Module index

    Drawing

    Drawing
    DrawingPen
    drawRectangle
    draw
    drawCircle
    drawEllipse
    drawFaceOutline
    drawParametricFunction
    drawPointsInterpolation
    drawPolysides
    drawProjection
    drawRoundedRectangle
    drawSingleCircle
    drawSingleEllipse
    drawText

    Other

    booleans
    construction
    io
    measurement
    modifiers
    patterns
    primitives
    query
    transforms
    BrepBugError
    BrepkitAdapter
    BrepWrapperError
    DisposalScope
    OcctWasmAdapter
    ApproximateCurveOptions
    AssemblyNode
    AssemblyNodeOptions
    AssemblySolveResult
    AutoHealOptions
    Blueprint
    Blueprints
    BooleanDiagnostics
    BooleanIssue
    BooleanOptions
    BooleanPipelineStep
    BossOptions
    BoundingBox2d
    Bounds3D
    BoxOptions
    BrepError
    BrepkitHandle
    BrokenRef
    BufferGeometryData
    BufferGeometryGroup
    Camera
    CheckBooleanResult
    CircleOptions
    CleanLoftOptions
    ComposedTransform
    CompoundBlueprint
    ConeOptions
    ConstraintSketchCapability
    CornerFilter
    CornerFinderFn
    CurvatureResult
    Curve2D
    Curve2DHandle
    CurveLike
    CylinderOptions
    Deletable
    DisposalStats
    DisposeRequest
    DistanceProps
    DraftOptions
    DrawingInterface
    DrawingLike
    DrillOptions
    DXFExportOptions
    DXFImportOptions
    EdgeFinderFn
    EdgeMesh
    EllipseArcOptions
    EllipseOptions
    EllipsoidOptions
    Err
    ErrorResponse
    EvolutionResult
    ExtrudeAllEntry
    ExtrusionProfile
    FaceFinderFn
    FontMetricsResult
    GeometricHint
    GltfExportOptions
    GltfMaterial
    GroupedBufferGeometryData
    GuidedSweepOptions
    HealingReport
    HealingStepDiagnostic
    HelixOptions
    HistoryOperationRegistry
    HullOptions
    InitRequest
    InterferencePair
    InterferenceResult
    InterpolateCurveOptions
    KernelBooleanOps
    KernelBuilderOps
    KernelCore
    KernelCurveOps
    KernelEvolutionOps
    KernelHandle
    KernelIOOps
    KernelMeasureOps
    KernelMeshOps
    KernelModifierOps
    KernelPrimitiveOps
    KernelRepairOps
    KernelSurfaceOps
    KernelSweepOps
    KernelTopologyOps
    KernelTransformOps
    LinearProps
    LineGeometryData
    LODGeometryData
    LoftAllEntry
    MateEntity
    MatrixTransform
    MeshCacheContext
    MeshOptions
    MinkowskiOptions
    MirrorJoinOptions
    MirrorOptions
    ModelHistory
    MultiLODMesh
    MultiSweepOptions
    NurbsCurveData
    NurbsSurfaceData
    OcctKernelWasm
    OcctWasmHandle
    OcctWasmModule
    Ok
    OperationRegistry
    OperationRequest
    OperationStep
    PendingTask
    PhysicalProps
    Plane
    PocketOptions
    PointProjectionResult
    PolyhedronOptions
    ProjectionCapability
    RectangularPatternOptions
    ResolvedRef
    ResultPipeline
    RevolveOptions
    RoofOptions
    RotateOptions
    ScaleOptions
    SerializedHistory
    ShapeDescription
    ShapeEvolution
    ShapeFinder
    ShapeHandle
    ShapeMesh
    ShapeOptions
    ShapeRef
    SkeletonFace
    SkeletonNode
    SketchData
    SketchInterface
    SkPoint2D
    SphereOptions
    StepExportOptions
    StepExportPart
    StraightSkeleton
    SuccessResponse
    SurfaceFromGridOptions
    SurfaceFromImageOptions
    SurfaceProps
    SVGImportOptions
    SweepOptions
    SweepSectionConfig
    TaskQueue
    TextMetricsResult
    ThreeMFExportOptions
    ThreeMFMaterial
    TorusOptions
    UVBounds
    VariableFilletRadius
    VertexFinderFn
    VolumeProps
    WireFinderFn
    WorkerClient
    WorkerClientOptions
    WorkerRequest
    WorkerResponse
    WorkerResult
    Wrapped
    Wrapped3D
    WrappedCurve
    WrappedFace
    WrappedMarker
    AnyShape
    AssemblyExporter
    BooleanOpType
    BrepErrorCode
    BrepErrorKind
    ChamferDistance
    ChamferRadius
    ClosedWire
    Color
    ColorInput
    Compound
    CompSolid
    CubeFace
    CurveType
    Dimension
    DimensionError
    DirectionInput
    DraftAngle
    DXFEntity
    Edge
    Face
    FaceScorer
    FilletRadius
    FinderFn
    GenericTopo
    KernelAdapter
    ManifoldShell
    MateConstraint
    Matrix4x4
    MatrixInput
    OperationFn
    OperationHandler
    OrientedFace
    PerformanceStats
    PipelineOp
    PlanarFace
    PlanarWire
    PlaneInput
    PlaneName
    Point2D
    PointInput
    ProjectionPlane
    RadiusOptions
    RequireDimension
    Result
    RoleTable
    SameDimension
    ScaleMode
    Shape1D
    Shape2D
    Shape3D
    Shapeable
    ShapeKind
    ShapeOrientation
    ShapeType
    Shell
    SingleFace
    Solid
    SplineOptions
    SupportedUnit
    SurfaceType
    TopoEntity
    TransformOp
    Unit
    UnknownDimShape
    ValidSolid
    Vec2
    Vec3
    Vertex
    Wire
    all
    BrepErrorCode
    DEG2RAD
    flatMap
    HASH_CODE_MAX
    OK
    RAD2DEG
    addChild
    addHoles
    addMate
    addStep
    adjacentFaces
    andThen
    applyGlue
    applyMatrix
    approximateCurve
    as2D
    as3D
    assignRoles
    asTopo
    autoHeal
    bezier
    blueprintToDXF
    booleanPipeline
    boss
    box
    bsplineApprox
    bug
    cameraFromPlane
    cameraLookAt
    captureHint
    cast
    castShape
    castShape3D
    chamfer
    chamferDistAngleShape
    chamferWithEvolution
    checkAllInterferences
    checkBoolean
    checkInterference
    circle
    circularPattern
    classifyPointOnFace
    clearMeshCache
    clone
    closedWire
    collect
    collectShapes
    colorFaces
    colorShape
    complexExtrude
    composeTransforms
    compound
    compoundSketchExtrude
    compoundSketchFace
    compoundSketchLoft
    compoundSketchRevolve
    computationError
    computeStraightSkeleton
    cone
    convexHull
    cornerFinder
    countNodes
    createAssembly
    createAssemblyNode
    createBlueprint
    createCamera
    createCompound
    createCompoundBlueprint
    createDistanceQuery
    createEdge
    createFace
    createHandle
    createHistory
    createKernelHandle
    createMeshCache
    createNamedPlane
    createOperationRegistry
    createPlane
    createRef
    createRegistry
    createShell
    createSolid
    createTaskQueue
    createVertex
    createWire
    createWorkerClient
    createWorkerHandler
    curve2dBoundingBox
    curve2dDistanceFrom
    curve2dFirstPoint
    curve2dIsOnCurve
    curve2dLastPoint
    curve2dParameter
    curve2dSplitAt
    curve2dTangentAt
    curveEndPoint
    curveIsClosed
    curveIsPeriodic
    curveLength
    curvePeriod
    curvePointAt
    curveStartPoint
    curveTangentAt
    cut
    cut2D
    cutAll
    cutBlueprints
    cutWithEvolution
    cylinder
    defaultScorer
    dequeueTask
    describe
    deserializeDrawing
    deserializeHistory
    deserializeShape
    downcast
    draft
    drawingChamfer
    drawingCut
    drawingFillet
    drawingFuse
    drawingIntersect
    drawingToSketchOnPlane
    drill
    edgeFinder
    edgesOfFace
    ellipse
    ellipseArc
    ellipsoid
    enqueueTask
    err
    exportAssemblySTEP
    exportDXF
    exportGlb
    exportGltf
    exportIGES
    exportOBJ
    exportSTEP
    exportSTEPConfigured
    exportSTL
    exportThreeMF
    extrude
    extrudeAll
    face
    faceCenter
    faceFinder
    faceGeomType
    faceOrientation
    facesOfEdge
    fill
    filledFace
    fillet
    filletWithEvolution
    findFacesByTag
    findNode
    findStep
    fixSelfIntersection
    fixShape
    flatten
    flipFaceOrientation
    flipOrientation
    fontMetrics
    fromBREP
    fromKernelDir
    fromKernelPnt
    fromKernelVec
    fromNullable
    fuse
    fuse2D
    fuseAll
    fuseBlueprints
    fuseWithEvolution
    getBounds
    getBounds2D
    getCurveType
    getDisposalStats
    getEdges
    getFaceColor
    getFaceOrigins
    getFaces
    getFaceTags
    getFont
    getHashCode
    getHistoryShape
    getKernel
    getNurbsCurveData
    getNurbsSurfaceData
    getOrientation
    getOrientation2D
    getPerformanceStats
    getShapeColor
    getShapeKind
    getSingleFace
    getSurfaceType
    getTagMetadata
    getVertices
    getWires
    guidedSweep
    heal
    healFace
    healSolid
    healWire
    helix
    hull
    importDXF
    importGLB
    importIGES
    importOBJ
    importSTEP
    importSTL
    importSVG
    importSVGPathD
    importThreeMF
    init
    initFromOC
    innerWires
    interpolateCurve
    intersect
    intersect2D
    intersectBlueprints
    intersectWithEvolution
    invalidateShapeCache
    ioError
    is2D
    is3D
    isChamferRadius
    isClosedWire
    isCompound
    isCompSolid
    isDisposeRequest
    isEdge
    isEmpty
    isEqualShape
    isErr
    isErrorResponse
    isFace
    isFilletRadius
    isInitRequest
    isInside2D
    isLive
    isManifoldShell
    isNumber
    isOk
    isOperationRequest
    isOrientedFace
    isPlanarFace
    isPlanarWire
    isProjectionPlane
    isQueueEmpty
    isSameShape
    isShape1D
    isShape3D
    isShell
    isSolid
    isSuccessResponse
    isValid
    isValidSolid
    isVertex
    isWire
    iterEdges
    iterFaces
    iterTopo
    iterVertices
    iterWires
    kernelCall
    kernelCallRaw
    kernelCallScoped
    kernelError
    line
    linearPattern
    loadFont
    loft
    loftAll
    makeBaseBox
    makePlane
    makeProjectedEdges
    manifoldShell
    map
    mapBoth
    mapErr
    match
    measureArea
    measureCurvatureAt
    measureCurvatureAtMid
    measureDistance
    measureDistanceProps
    measureLength
    measureLinearProps
    measureSurfaceProps
    measureVolume
    measureVolumeProps
    mesh
    meshEdges
    meshMultiLOD
    minkowski
    mirror
    mirror2D
    mirrorDrawing
    mirrorJoin
    modifyStep
    moduleInitError
    multiSectionSweep
    normalAt
    offset
    offsetFace
    offsetWire2D
    ok
    or
    orElse
    organiseBlueprints
    orientedFace
    outerWire
    pendingCount
    pipeline
    pivotPlane
    planarFace
    planarWire
    pocket
    pointOnSurface
    polygon
    polyhedron
    polysideInnerRadius
    polysidesBlueprint
    positionOnCurve
    prewarm
    projectEdges
    projectPointOnFace
    queryError
    rectangularPattern
    registerHandler
    registerKernel
    registerOperation
    registerShape
    rejectAll
    removeChild
    removeHolesFromFace
    replayFrom
    replayHistory
    resetDisposalStats
    resetPerformanceStats
    resize
    resolve
    resolve3D
    resolveDirection
    resolvePlane
    resolveRef
    reverseCurve
    revolve
    roof
    rotate
    rotate2D
    rotateDrawing
    roundedRectangleBlueprint
    scale
    scale2D
    scaleDrawing
    section
    sectionToFace
    serializeHistory
    setShapeOrigin
    setTagMetadata
    sewShells
    shape
    shapeType
    sharedEdges
    shell
    shellWithEvolution
    simplify
    sketcherStateError
    sketchExtrude
    sketchFace
    sketchLoft
    sketchOnFace2D
    sketchOnPlane2D
    sketchRevolve
    sketchSweep
    sketchText
    sketchWires
    slice
    solid
    solidFromShell
    solveAssembly
    sphere
    split
    stepCount
    stepsFrom
    stretch2D
    subFace
    supportExtrude
    supportsConstraintSketch
    supportsProjection
    surfaceFromGrid
    surfaceFromImage
    sweep
    tagFaces
    tangentArc
    tap
    tapErr
    textBlueprints
    textMetrics
    thicken
    threePointArc
    toBREP
    toBufferGeometryData
    toGroupedBufferGeometryData
    toKernelVec
    toLineGeometryData
    toLODGeometryData
    torus
    toSVGPathD
    toVec2
    toVec3
    transformCopy
    translate
    translate2D
    translateDrawing
    translatePlane
    tryCatch
    tryCatchAsync
    twistExtrude
    typeCastError
    undoLast
    unsupportedError
    unwrap
    unwrapErr
    unwrapOr
    unwrapOrElse
    updateNode
    updateRoles
    uvBounds
    uvCoordinates
    validationError
    validSolid
    variableFillet
    vecAdd
    vecAngle
    vecCross
    vecDistance
    vecDot
    vecEquals
    vecIsZero
    vecLength
    vecLengthSq
    vecNegate
    vecNormalize
    vecProjectToPlane
    vecRepr
    vecRotate
    vecScale
    vecSub
    vertex
    vertexFinder
    vertexPosition
    verticesOfEdge
    walkAssembly
    wire
    wireFinder
    wireLoop
    wiresOfFace
    withKernel
    withKernelDir
    withKernelPnt
    withKernelVec
    withScope
    withScopeResult
    withScopeResultAsync
    zipResults
    CleanSweepOptions → SweepOptions

    Sketching

    CompoundSketch
    Sketch
    Sketches
    BaseSketcher2d
    BlueprintSketcher
    FaceSketcher
    GenericSketcher
    Sketcher
    sketchCircle
    sketchEllipse
    sketchFaceOffset
    sketchHelix
    sketchParametricFunction
    sketchPolysides
    sketchRectangle
    sketchRoundedRectangle