brepjs API Reference
    Preparing search index...

    Interface OcctKernelWasm

    Type-safe view of occt-wasm's Embind OcctKernel class.

    All handle parameters and return values are number (u32 arena indices).

    interface OcctKernelWasm {
        addHolesInFace(faceId: number, holeWireIds: EmVectorUint32): number;
        adjacentFaces(shapeId: number, faceId: number): EmVectorUint32;
        approximatePoints(flatPoints: EmVectorDouble, tolerance: number): number;
        bsplineSurface(
            flatPoints: EmVectorDouble,
            rows: number,
            cols: number,
        ): number;
        buildCurves3d(wireId: number): void;
        buildSolidFromFaces(faceIds: EmVectorUint32, tolerance: number): number;
        buildTriFace(
            ax: number,
            ay: number,
            az: number,
            bx: number,
            by: number,
            bz: number,
            cx: number,
            cy: number,
            cz: number,
        ): number;
        chamfer(solidId: number, edgeIds: EmVectorUint32, distance: number): number;
        chamferDistAngle(
            solidId: number,
            edgeIds: EmVectorUint32,
            distance: number,
            angleDeg: number,
        ): number;
        chamferWithHistory(
            solidId: number,
            edgeIds: EmVectorUint32,
            distance: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        circularPattern(
            id: number,
            cx: number,
            cy: number,
            cz: number,
            ax: number,
            ay: number,
            az: number,
            angle: number,
            count: number,
        ): number;
        classifyPointOnFace(faceId: number, u: number, v: number): string;
        common(a: number, b: number): number;
        composeTransform(m1: EmVectorDouble, m2: EmVectorDouble): EmVectorDouble;
        copy(id: number): number;
        curveDegreeElevate(edgeId: number, elevateBy: number): number;
        curveIsClosed(edgeId: number): boolean;
        curveIsPeriodic(edgeId: number): boolean;
        curveKnotInsert(edgeId: number, knot: number, times: number): number;
        curveKnotRemove(edgeId: number, knot: number, tolerance: number): number;
        curveLength(edgeId: number): number;
        curveParameters(edgeId: number): EmVectorDouble;
        curvePointAtParam(edgeId: number, param: number): EmVectorDouble;
        curveSplit(edgeId: number, param: number): EmVectorUint32;
        curveTangent(edgeId: number, param: number): EmVectorDouble;
        curveType(edgeId: number): string;
        cut(a: number, b: number): number;
        cutAll(shapeId: number, toolIds: EmVectorUint32): number;
        cutWithHistory(
            a: number,
            b: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        defeature(
            shapeId: number,
            faceIds: EmVectorUint32,
            tolerance: number,
        ): number;
        distanceBetween(a: number, b: number): number;
        downcast(id: number, targetType: string): number;
        draft(
            shapeId: number,
            faceId: number,
            angleRad: number,
            dx: number,
            dy: number,
            dz: number,
        ): number;
        draftPrism(
            shapeId: number,
            dx: number,
            dy: number,
            dz: number,
            angleDeg: number,
        ): number;
        edgeToFaceMap(id: number, hashUpperBound: number): EmVectorInt;
        exportIges(id: number): string;
        exportStep(id: number): string;
        exportStl(id: number, linearDeflection: number, ascii: boolean): string;
        extrude(shapeId: number, dx: number, dy: number, dz: number): number;
        fillet(solidId: number, edgeIds: EmVectorUint32, radius: number): number;
        filletVariable(
            solidId: number,
            edgeId: number,
            startRadius: number,
            endRadius: number,
        ): number;
        filletWithHistory(
            solidId: number,
            edgeIds: EmVectorUint32,
            radius: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        fixFaceOrientations(id: number): number;
        fixShape(id: number): number;
        fixWireOnFace(wireId: number, faceId: number, tolerance: number): number;
        fromBREP(data: string): number;
        fuse(a: number, b: number): number;
        fuseAll(shapeIds: EmVectorUint32): number;
        fuseWithHistory(
            a: number,
            b: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        generalTransform(id: number, matrix: EmVectorDouble): number;
        getBoundingBox(id: number, useTriangulation: boolean): EmBBoxData;
        getCenterOfMass(id: number): EmVectorDouble;
        getLength(id: number): number;
        getLinearCenterOfMass(id: number): EmVectorDouble;
        getNurbsCurveData(edgeId: number): EmNurbsCurveData;
        getShapeCount(): number;
        getShapeType(id: number): string;
        getSubShapes(id: number, shapeType: string): EmVectorUint32;
        getSurfaceArea(id: number): number;
        getSurfaceCenterOfMass(faceId: number): EmVectorDouble;
        getVolume(id: number): number;
        hashCode(id: number, upperBound: number): number;
        hasTriangulation(id: number): boolean;
        healFace(id: number, tolerance: number): number;
        healSolid(id: number, tolerance: number): number;
        healWire(id: number, tolerance: number): number;
        importIges(data: string): number;
        importStep(data: string): number;
        importStl(data: string): number;
        interpolatePoints(flatPoints: EmVectorDouble, periodic: boolean): number;
        intersect(a: number, b: number): number;
        intersectWithHistory(
            a: number,
            b: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        isEqual(a: number, b: number): boolean;
        isNull(id: number): boolean;
        isSame(a: number, b: number): boolean;
        isValid(id: number): boolean;
        iterShapes(id: number): EmVectorUint32;
        liftCurve2dToPlane(
            flatPoints2d: EmVectorDouble,
            planeOx: number,
            planeOy: number,
            planeOz: number,
            planeZx: number,
            planeZy: number,
            planeZz: number,
            planeXx: number,
            planeXy: number,
            planeXz: number,
        ): number;
        linearPattern(
            id: number,
            dx: number,
            dy: number,
            dz: number,
            spacing: number,
            count: number,
        ): number;
        located?(id: number, matrix: EmVectorDouble): number;
        loft(wireIds: EmVectorUint32, isSolid: boolean, ruled: boolean): number;
        loftWithVertices(
            wireIds: EmVectorUint32,
            isSolid: boolean,
            ruled: boolean,
            startVertexId: number,
            endVertexId: number,
        ): number;
        makeArcEdge(
            x1: number,
            y1: number,
            z1: number,
            x2: number,
            y2: number,
            z2: number,
            x3: number,
            y3: number,
            z3: number,
        ): number;
        makeBezierEdge(flatPoints: EmVectorDouble): number;
        makeBox(dx: number, dy: number, dz: number): number;
        makeBoxFromCorners(
            x1: number,
            y1: number,
            z1: number,
            x2: number,
            y2: number,
            z2: number,
        ): number;
        makeCircleArc(
            cx: number,
            cy: number,
            cz: number,
            nx: number,
            ny: number,
            nz: number,
            radius: number,
            startAngle: number,
            endAngle: number,
        ): number;
        makeCircleEdge(
            cx: number,
            cy: number,
            cz: number,
            nx: number,
            ny: number,
            nz: number,
            radius: number,
        ): number;
        makeCompound(shapeIds: EmVectorUint32): number;
        makeCone(r1: number, r2: number, height: number): number;
        makeCylinder(radius: number, height: number): number;
        makeEdge(v1: number, v2: number): number;
        makeEllipseArc(
            cx: number,
            cy: number,
            cz: number,
            nx: number,
            ny: number,
            nz: number,
            majorRadius: number,
            minorRadius: number,
            startAngle: number,
            endAngle: number,
        ): number;
        makeEllipseEdge(
            cx: number,
            cy: number,
            cz: number,
            nx: number,
            ny: number,
            nz: number,
            majorRadius: number,
            minorRadius: number,
        ): number;
        makeEllipsoid(rx: number, ry: number, rz: number): number;
        makeFace(wireId: number): number;
        makeFaceOnSurface(faceId: number, wireId: number): number;
        makeHelixWire(
            px: number,
            py: number,
            pz: number,
            dx: number,
            dy: number,
            dz: number,
            pitch: number,
            height: number,
            radius: number,
        ): number;
        makeLineEdge(
            x1: number,
            y1: number,
            z1: number,
            x2: number,
            y2: number,
            z2: number,
        ): number;
        makeNonPlanarFace(wireId: number): number;
        makeNullShape(): number;
        makeRectangle(width: number, height: number): number;
        makeSolid(shellId: number): number;
        makeSphere(radius: number): number;
        makeTangentArc(
            x1: number,
            y1: number,
            z1: number,
            tx: number,
            ty: number,
            tz: number,
            x2: number,
            y2: number,
            z2: number,
        ): number;
        makeTorus(majorRadius: number, minorRadius: number): number;
        makeVertex(x: number, y: number, z: number): number;
        makeWire(edgeIds: EmVectorUint32): number;
        meshShape(
            id: number,
            linearDeflection: number,
            angularDeflection: number,
        ): EmMeshData;
        mirror(
            id: number,
            px: number,
            py: number,
            pz: number,
            nx: number,
            ny: number,
            nz: number,
        ): number;
        mirrorWithHistory(
            id: number,
            px: number,
            py: number,
            pz: number,
            nx: number,
            ny: number,
            nz: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        offset(solidId: number, distance: number, tolerance: number): number;
        offsetWire2D(wireId: number, offset: number, joinType: number): number;
        offsetWithHistory(
            solidId: number,
            distance: number,
            tolerance: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        outerWire(faceId: number): number;
        pipe(profileId: number, spineId: number): number;
        pointOnSurface(faceId: number, u: number, v: number): EmVectorDouble;
        projectEdges(
            shapeId: number,
            ox: number,
            oy: number,
            oz: number,
            dx: number,
            dy: number,
            dz: number,
            xx: number,
            xy: number,
            xz: number,
            hasXAxis: boolean,
        ): EmProjectionData;
        projectPointOnFace(
            faceId: number,
            x: number,
            y: number,
            z: number,
        ): EmVectorDouble;
        release(id: number): void;
        releaseAll(): void;
        removeDegenerateEdges(id: number): number;
        removeHolesFromFace(faceId: number, holeIndices: EmVectorInt): number;
        reverseShape(id: number): number;
        revolve(
            shapeId: number,
            px: number,
            py: number,
            pz: number,
            dx: number,
            dy: number,
            dz: number,
            angleRad: number,
        ): number;
        revolveVec(
            shapeId: number,
            cx: number,
            cy: number,
            cz: number,
            dx: number,
            dy: number,
            dz: number,
            angle: number,
        ): number;
        rotate(
            id: number,
            px: number,
            py: number,
            pz: number,
            dx: number,
            dy: number,
            dz: number,
            angleRad: number,
        ): number;
        rotateWithHistory(
            id: number,
            px: number,
            py: number,
            pz: number,
            dx: number,
            dy: number,
            dz: number,
            angle: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        scale(
            id: number,
            px: number,
            py: number,
            pz: number,
            factor: number,
        ): number;
        scaleWithHistory(
            id: number,
            cx: number,
            cy: number,
            cz: number,
            factor: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        section(a: number, b: number): number;
        sew(shapeIds: EmVectorUint32, tolerance: number): number;
        sewAndSolidify(faceIds: EmVectorUint32, tolerance: number): number;
        shapeOrientation(id: number): string;
        sharedEdges(faceA: number, faceB: number): EmVectorUint32;
        shell(
            solidId: number,
            faceIds: EmVectorUint32,
            thickness: number,
            tolerance: number,
        ): number;
        shellWithHistory(
            solidId: number,
            faceIds: EmVectorUint32,
            thickness: number,
            tolerance: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        simplePipe(profileId: number, spineId: number): number;
        simplify(id: number): number;
        solidFromShell(shellId: number): number;
        split(shapeId: number, toolIds: EmVectorUint32): number;
        surfaceCurvature(faceId: number, u: number, v: number): EmVectorDouble;
        surfaceNormal(faceId: number, u: number, v: number): EmVectorDouble;
        surfaceType(faceId: number): string;
        sweep(wireId: number, spineId: number, transitionMode: number): number;
        sweepPipeShell(
            profileId: number,
            spineId: number,
            freenet: boolean,
            smooth: boolean,
        ): number;
        tessellate(
            id: number,
            linearDeflection: number,
            angularDeflection: number,
        ): EmMeshData;
        thicken(shapeId: number, thickness: number, tolerance: number): number;
        thickenWithHistory(
            shapeId: number,
            thickness: number,
            tolerance: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        toBREP(id: number): string;
        transform(id: number, matrix: EmVectorDouble): number;
        translate(id: number, dx: number, dy: number, dz: number): number;
        translateWithHistory(
            id: number,
            dx: number,
            dy: number,
            dz: number,
            inputFaceHashes: EmVectorInt,
            hashUpperBound: number,
        ): EmEvolutionData;
        unifySameDomain(id: number): number;
        uvBounds(faceId: number): EmVectorDouble;
        uvFromPoint(
            faceId: number,
            x: number,
            y: number,
            z: number,
        ): EmVectorDouble;
        vertexPosition(vertexId: number): EmVectorDouble;
        wireframe(id: number, deflection: number): EmEdgeData;
        xcafAddShape(docId: number, shapeId: number): number;
        xcafClose(docId: number): void;
        xcafExportSTEP(docId: number): string;
        xcafGetRootLabels(docId: number): EmVectorInt;
        xcafNewDocument(): number;
        xcafSetColor(
            docId: number,
            labelId: number,
            r: number,
            g: number,
            b: number,
        ): void;
        xcafSetName(docId: number, labelId: number, name: string): void;
    }
    Index

    Methods

    addHolesInFace adjacentFaces approximatePoints bsplineSurface buildCurves3d buildSolidFromFaces buildTriFace chamfer chamferDistAngle chamferWithHistory circularPattern classifyPointOnFace common composeTransform copy curveDegreeElevate curveIsClosed curveIsPeriodic curveKnotInsert curveKnotRemove curveLength curveParameters curvePointAtParam curveSplit curveTangent curveType cut cutAll cutWithHistory defeature distanceBetween downcast draft draftPrism edgeToFaceMap exportIges exportStep exportStl extrude fillet filletVariable filletWithHistory fixFaceOrientations fixShape fixWireOnFace fromBREP fuse fuseAll fuseWithHistory generalTransform getBoundingBox getCenterOfMass getLength getLinearCenterOfMass getNurbsCurveData getShapeCount getShapeType getSubShapes getSurfaceArea getSurfaceCenterOfMass getVolume hashCode hasTriangulation healFace healSolid healWire importIges importStep importStl interpolatePoints intersect intersectWithHistory isEqual isNull isSame isValid iterShapes liftCurve2dToPlane linearPattern located? loft loftWithVertices makeArcEdge makeBezierEdge makeBox makeBoxFromCorners makeCircleArc makeCircleEdge makeCompound makeCone makeCylinder makeEdge makeEllipseArc makeEllipseEdge makeEllipsoid makeFace makeFaceOnSurface makeHelixWire makeLineEdge makeNonPlanarFace makeNullShape makeRectangle makeSolid makeSphere makeTangentArc makeTorus makeVertex makeWire meshShape mirror mirrorWithHistory offset offsetWire2D offsetWithHistory outerWire pipe pointOnSurface projectEdges projectPointOnFace release releaseAll removeDegenerateEdges removeHolesFromFace reverseShape revolve revolveVec rotate rotateWithHistory scale scaleWithHistory section sew sewAndSolidify shapeOrientation sharedEdges shell shellWithHistory simplePipe simplify solidFromShell split surfaceCurvature surfaceNormal surfaceType sweep sweepPipeShell tessellate thicken thickenWithHistory toBREP transform translate translateWithHistory unifySameDomain uvBounds uvFromPoint vertexPosition wireframe xcafAddShape xcafClose xcafExportSTEP xcafGetRootLabels xcafNewDocument xcafSetColor xcafSetName

    Methods

    • Parameters

      • flatPoints: EmVectorDouble
      • rows: number
      • cols: number

      Returns number

    • Parameters

      • ax: number
      • ay: number
      • az: number
      • bx: number
      • by: number
      • bz: number
      • cx: number
      • cy: number
      • cz: number

      Returns number

    • Parameters

      • solidId: number
      • edgeIds: EmVectorUint32
      • distance: number

      Returns number

    • Parameters

      • solidId: number
      • edgeIds: EmVectorUint32
      • distance: number
      • angleDeg: number

      Returns number

    • Parameters

      • solidId: number
      • edgeIds: EmVectorUint32
      • distance: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • id: number
      • cx: number
      • cy: number
      • cz: number
      • ax: number
      • ay: number
      • az: number
      • angle: number
      • count: number

      Returns number

    • Parameters

      • a: number
      • b: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • shapeId: number
      • faceIds: EmVectorUint32
      • tolerance: number

      Returns number

    • Parameters

      • shapeId: number
      • faceId: number
      • angleRad: number
      • dx: number
      • dy: number
      • dz: number

      Returns number

    • Parameters

      • shapeId: number
      • dx: number
      • dy: number
      • dz: number
      • angleDeg: number

      Returns number

    • Parameters

      • solidId: number
      • edgeId: number
      • startRadius: number
      • endRadius: number

      Returns number

    • Parameters

      • solidId: number
      • edgeIds: EmVectorUint32
      • radius: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • a: number
      • b: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • a: number
      • b: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • flatPoints2d: EmVectorDouble
      • planeOx: number
      • planeOy: number
      • planeOz: number
      • planeZx: number
      • planeZy: number
      • planeZz: number
      • planeXx: number
      • planeXy: number
      • planeXz: number

      Returns number

    • Parameters

      • id: number
      • dx: number
      • dy: number
      • dz: number
      • spacing: number
      • count: number

      Returns number

    • Cheap location-only move (a TopLoc_Location re-tag sharing the source TShape). Optional: absent on WASM builds published before this method landed, so callers must feature-detect (typeof k.located === 'function') and fall back to transform.

      Parameters

      • id: number
      • matrix: EmVectorDouble

      Returns number

    • Parameters

      • wireIds: EmVectorUint32
      • isSolid: boolean
      • ruled: boolean
      • startVertexId: number
      • endVertexId: number

      Returns number

    • Parameters

      • x1: number
      • y1: number
      • z1: number
      • x2: number
      • y2: number
      • z2: number
      • x3: number
      • y3: number
      • z3: number

      Returns number

    • Parameters

      • x1: number
      • y1: number
      • z1: number
      • x2: number
      • y2: number
      • z2: number

      Returns number

    • Parameters

      • cx: number
      • cy: number
      • cz: number
      • nx: number
      • ny: number
      • nz: number
      • radius: number
      • startAngle: number
      • endAngle: number

      Returns number

    • Parameters

      • cx: number
      • cy: number
      • cz: number
      • nx: number
      • ny: number
      • nz: number
      • radius: number

      Returns number

    • Parameters

      • cx: number
      • cy: number
      • cz: number
      • nx: number
      • ny: number
      • nz: number
      • majorRadius: number
      • minorRadius: number
      • startAngle: number
      • endAngle: number

      Returns number

    • Parameters

      • cx: number
      • cy: number
      • cz: number
      • nx: number
      • ny: number
      • nz: number
      • majorRadius: number
      • minorRadius: number

      Returns number

    • Parameters

      • px: number
      • py: number
      • pz: number
      • dx: number
      • dy: number
      • dz: number
      • pitch: number
      • height: number
      • radius: number

      Returns number

    • Parameters

      • x1: number
      • y1: number
      • z1: number
      • x2: number
      • y2: number
      • z2: number

      Returns number

    • Parameters

      • x1: number
      • y1: number
      • z1: number
      • tx: number
      • ty: number
      • tz: number
      • x2: number
      • y2: number
      • z2: number

      Returns number

    • Parameters

      • id: number
      • linearDeflection: number
      • angularDeflection: number

      Returns EmMeshData

    • Parameters

      • id: number
      • px: number
      • py: number
      • pz: number
      • nx: number
      • ny: number
      • nz: number

      Returns number

    • Parameters

      • id: number
      • px: number
      • py: number
      • pz: number
      • nx: number
      • ny: number
      • nz: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • solidId: number
      • distance: number
      • tolerance: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • shapeId: number
      • ox: number
      • oy: number
      • oz: number
      • dx: number
      • dy: number
      • dz: number
      • xx: number
      • xy: number
      • xz: number
      • hasXAxis: boolean

      Returns EmProjectionData

    • Parameters

      • faceId: number
      • x: number
      • y: number
      • z: number

      Returns EmVectorDouble

    • Parameters

      • shapeId: number
      • px: number
      • py: number
      • pz: number
      • dx: number
      • dy: number
      • dz: number
      • angleRad: number

      Returns number

    • Parameters

      • shapeId: number
      • cx: number
      • cy: number
      • cz: number
      • dx: number
      • dy: number
      • dz: number
      • angle: number

      Returns number

    • Parameters

      • id: number
      • px: number
      • py: number
      • pz: number
      • dx: number
      • dy: number
      • dz: number
      • angleRad: number

      Returns number

    • Parameters

      • id: number
      • px: number
      • py: number
      • pz: number
      • dx: number
      • dy: number
      • dz: number
      • angle: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • id: number
      • px: number
      • py: number
      • pz: number
      • factor: number

      Returns number

    • Parameters

      • id: number
      • cx: number
      • cy: number
      • cz: number
      • factor: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • solidId: number
      • faceIds: EmVectorUint32
      • thickness: number
      • tolerance: number

      Returns number

    • Parameters

      • solidId: number
      • faceIds: EmVectorUint32
      • thickness: number
      • tolerance: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • profileId: number
      • spineId: number
      • freenet: boolean
      • smooth: boolean

      Returns number

    • Parameters

      • id: number
      • linearDeflection: number
      • angularDeflection: number

      Returns EmMeshData

    • Parameters

      • shapeId: number
      • thickness: number
      • tolerance: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • id: number
      • dx: number
      • dy: number
      • dz: number
      • inputFaceHashes: EmVectorInt
      • hashUpperBound: number

      Returns EmEvolutionData

    • Parameters

      • faceId: number
      • x: number
      • y: number
      • z: number

      Returns EmVectorDouble

    • Parameters

      • docId: number
      • labelId: number
      • r: number
      • g: number
      • b: number

      Returns void