brepjs API Reference
GitHub
npm
Getting Started
Preparing search index...
index
Module index
Drawing
Drawing
DrawingPen
drawRectangle
draw
drawCircle
drawEllipse
drawFaceOutline
drawParametricFunction
drawPointsInterpolation
drawPolysides
drawProjection
drawRoundedRectangle
drawSingleCircle
drawSingleEllipse
drawText
Other
Blueprint
Blueprints
BoundingBox2d
BrepBugError
BrepWrapperError
CompoundBlueprint
Curve2D
DisposalScope
ApproximateCurveOptions
AssemblyNode
AssemblyNodeOptions
AutoHealOptions
BooleanOptions
BossOptions
Bounds3D
BoxOptions
BrepError
BufferGeometryData
BufferGeometryGroup
Camera
CircleOptions
CleanLoftOptions
ConeOptions
CornerFilter
CornerFinderFn
CurvatureResult
CurveLike
CylinderOptions
Deletable
DisposeRequest
DrawingInterface
DrawingLike
DrillOptions
DXFExportOptions
EdgeFinderFn
EdgeMesh
EllipseArcOptions
EllipseOptions
EllipsoidOptions
Err
ErrorResponse
ExtrusionProfile
FaceFinderFn
GenericSweepOptions
GltfExportOptions
GltfMaterial
GroupedBufferGeometryData
HealingReport
HealingStepDiagnostic
HelixOptions
HistoryOperationRegistry
InitRequest
InterferencePair
InterferenceResult
InterpolateCurveOptions
LinearProps
LineGeometryData
MeshCacheContext
MeshOptions
MirrorJoinOptions
MirrorOptions
ModelHistory
OcHandle
Ok
OperationRegistry
OperationRequest
OperationStep
PendingTask
PhysicalProps
Plane
PocketOptions
PointProjectionResult
RectangularPatternOptions
ResultPipeline
RevolveOptions
RotateOptions
ScaleOptions
ShapeDescription
ShapeFinder
ShapeHandle
ShapeMesh
ShapeOptions
SketchData
SketchInterface
SphereOptions
SuccessResponse
SurfaceProps
SVGImportOptions
SweepOptions
TaskQueue
ThreeMFExportOptions
TorusOptions
UVBounds
VertexFinderFn
VolumeProps
WireFinderFn
WorkerClient
WorkerClientOptions
WorkerRequest
WorkerResponse
WorkerResult
Wrapped
Wrapped3D
WrappedCurve
WrappedFace
WrappedMarker
AnyShape
AssemblyExporter
BrepErrorCode
BrepErrorKind
ChamferDistance
ChamferRadius
CleanLoftConfig
Compound
CompSolid
CubeFace
CurveType
DirectionInput
DXFEntity
Edge
Face
FilletRadius
FinderFn
GenericSweepConfig
GenericTopo
OperationFn
OperationHandler
PlaneInput
PlaneName
Point
Point2D
PointInput
ProjectionPlane
RadiusConfig
RadiusOptions
Result
ScaleMode
Shape1D
Shape2D
Shape3D
Shapeable
ShapeConfig
ShapeKind
Shell
SingleFace
Solid
SplineConfig
SplineOptions
SupportedUnit
SweepConfig
TopoEntity
Unit
Vec2
Vec3
Vertex
Wire
BrepErrorCode
DEG2RAD
flatMap
HASH_CODE_MAX
OK
RAD2DEG
addChild
addHoles
addStep
adjacentFaces
andThen
applyGlue
approximateCurve
asTopo
autoHeal
axis2d
basicFaceExtrusion
bezier
blueprintBoundingBox
blueprintIsInside
blueprintOrientation
blueprintToDXF
blueprintToSVGPathD
boss
box
bsplineApprox
bug
cameraFromPlane
cameraLookAt
cast
castShape
chamfer
chamferDistAngleShape
checkAllInterferences
checkInterference
circle
circularPattern
classifyPointOnFace
clearMeshCache
clone
collect
collectShapes
complexExtrude
compound
compoundSketchExtrude
compoundSketchFace
compoundSketchLoft
compoundSketchRevolve
computationError
cone
cornerFinder
countNodes
createAssembly
createAssemblyNode
createBlueprint
createCamera
createCompound
createDistanceQuery
createEdge
createFace
createHandle
createHistory
createMeshCache
createNamedPlane
createOcHandle
createOperationRegistry
createPlane
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
cutBlueprint2D
cutBlueprints
cylinder
dequeueTask
describe
deserializeDrawing
deserializeShape
downcast
drawingChamfer
drawingCut
drawingFillet
drawingFuse
drawingIntersect
drawingToSketchOnPlane
drill
edgeFinder
edgesOfFace
ellipse
ellipseArc
ellipsoid
enqueueTask
err
exportAssemblySTEP
exportDXF
exportGlb
exportGltf
exportIGES
exportOBJ
exportSTEP
exportSTL
exportThreeMF
extrude
face
faceCenter
faceFinder
faceGeomType
faceOrientation
facesOfEdge
filledFace
fillet
findCurveType
findNode
findStep
flipFaceOrientation
flipOrientation
fromBREP
fromOcDir
fromOcPnt
fromOcVec
fuse
fuse2D
fuseAll
fuseBlueprint2D
fuseBlueprints
gcWithObject
gcWithScope
genericSweep
getBounds
getBounds2D
getCurveType
getEdges
getFaces
getFont
getHashCode
getHistoryShape
getKernel
getOrientation
getOrientation2D
getShapeKind
getSingleFace
getSurfaceType
getVertices
getWires
heal
healFace
healSolid
healWire
helix
importIGES
importSTEP
importSTL
importSVG
importSVGPathD
initFromOC
innerWires
interpolateCurve
intersect
intersect2D
intersectBlueprint2D
intersectBlueprints
ioError
isChamferRadius
isCompound
isCompSolid
isDisposeRequest
isEdge
isEmpty
isEqualShape
isErr
isErrorResponse
isFace
isFilletRadius
isInitRequest
isInside2D
isNumber
isOk
isOperationRequest
isPoint
isProjectionPlane
isQueueEmpty
isSameShape
isShape1D
isShape3D
isShell
isSolid
isSuccessResponse
isValid
isVertex
isWire
iterEdges
iterFaces
iterTopo
iterVertices
iterWires
kernelCall
kernelCallRaw
line
linearPattern
loadFont
localGC
loft
makeBaseBox
makePlane
makeProjectedEdges
map
mapErr
match
measureArea
measureCurvatureAt
measureCurvatureAtMid
measureDistance
measureLength
measureLinearProps
measureSurfaceProps
measureVolume
measureVolumeProps
mesh
meshEdges
mirror
mirror2D
mirrorBlueprint
mirrorDrawing
mirrorJoin
modifyStep
moduleInitError
normalAt
occtError
offset
offsetFace
offsetWire2D
ok
organiseBlueprints
outerWire
pendingCount
pipeline
pivotPlane
pocket
pointOnSurface
polygon
polysideInnerRadius
polysidesBlueprint
projectEdges
projectPointOnFace
queryError
rectangularPattern
registerHandler
registerOperation
registerShape
rejectAll
removeChild
replayFrom
replayHistory
resolve
resolve3D
resolveDirection
resolvePlane
reverseCurve
revolution
revolve
rotate
rotate2D
rotateBlueprint
rotateDrawing
roundedRectangleBlueprint
scale
scale2D
scaleBlueprint
scaleDrawing
section
sewShells
shape
shapeType
sharedEdges
shell
simplify
sketch2DOnFace
sketch2DOnPlane
sketchBlueprintOnFace
sketchBlueprintOnPlane
sketcherStateError
sketchExtrude
sketchFace
sketchLoft
sketchRevolve
sketchSweep
sketchText
sketchWires
slice
solid
sphere
split
stepCount
stepsFrom
stretch2D
stretchBlueprint
subFace
supportExtrude
sweep
tangentArc
textBlueprints
thicken
threePointArc
toBREP
toBufferGeometryData
toGroupedBufferGeometryData
toLineGeometryData
toOcVec
torus
toSVGPathD
toVec2
toVec3
translate
translate2D
translateBlueprint
translateDrawing
translatePlane
tryCatch
tryCatchAsync
twistExtrude
typeCastError
undoLast
unwrap
unwrapErr
unwrapOr
unwrapOrElse
updateNode
uvBounds
uvCoordinates
validationError
vecAdd
vecAngle
vecCross
vecDistance
vecDot
vecEquals
vecIsZero
vecLength
vecLengthSq
vecNegate
vecNormalize
vecProjectToPlane
vecRepr
vecRotate
vecScale
vecSub
vertex
vertexFinder
vertexPosition
verticesOfEdge
walkAssembly
wire
wireFinder
wiresOfFace
withOcDir
withOcPnt
withOcVec
withScope
CleanSweepConfig
 →Â
SweepConfig
CleanSweepOptions
 →Â
SweepOptions
Sketching
BaseSketcher2d
BlueprintSketcher
CompoundSketch
FaceSketcher
Sketch
Sketcher
Sketches
GenericSketcher
sketchCircle
sketchEllipse
sketchFaceOffset
sketchHelix
sketchParametricFunction
sketchPolysides
sketchRectangle
sketchRoundedRectangle
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Drawing
Drawing
Drawing
Pen
draw
Rectangle
draw
draw
Circle
draw
Ellipse
draw
Face
Outline
draw
Parametric
Function
draw
Points
Interpolation
draw
Polysides
draw
Projection
draw
Rounded
Rectangle
draw
Single
Circle
draw
Single
Ellipse
draw
Text
Other
Blueprint
Blueprints
Bounding
Box2d
Brep
Bug
Error
Brep
Wrapper
Error
Compound
Blueprint
Curve2
D
Disposal
Scope
Approximate
Curve
Options
Assembly
Node
Assembly
Node
Options
Auto
Heal
Options
Boolean
Options
Boss
Options
Bounds3
D
Box
Options
Brep
Error
Buffer
Geometry
Data
Buffer
Geometry
Group
Camera
Circle
Options
Clean
Loft
Options
Cone
Options
Corner
Filter
Corner
Finder
Fn
Curvature
Result
Curve
Like
Cylinder
Options
Deletable
Dispose
Request
Drawing
Interface
Drawing
Like
Drill
Options
DXF
Export
Options
Edge
Finder
Fn
Edge
Mesh
Ellipse
Arc
Options
Ellipse
Options
Ellipsoid
Options
Err
Error
Response
Extrusion
Profile
Face
Finder
Fn
Generic
Sweep
Options
Gltf
Export
Options
Gltf
Material
Grouped
Buffer
Geometry
Data
Healing
Report
Healing
Step
Diagnostic
Helix
Options
History
Operation
Registry
Init
Request
Interference
Pair
Interference
Result
Interpolate
Curve
Options
Linear
Props
Line
Geometry
Data
Mesh
Cache
Context
Mesh
Options
Mirror
Join
Options
Mirror
Options
Model
History
Oc
Handle
Ok
Operation
Registry
Operation
Request
Operation
Step
Pending
Task
Physical
Props
Plane
Pocket
Options
Point
Projection
Result
Rectangular
Pattern
Options
Result
Pipeline
Revolve
Options
Rotate
Options
Scale
Options
Shape
Description
Shape
Finder
Shape
Handle
Shape
Mesh
Shape
Options
Sketch
Data
Sketch
Interface
Sphere
Options
Success
Response
Surface
Props
SVG
Import
Options
Sweep
Options
Task
Queue
Three
MF
Export
Options
Torus
Options
UV
Bounds
Vertex
Finder
Fn
Volume
Props
Wire
Finder
Fn
Worker
Client
Worker
Client
Options
Worker
Request
Worker
Response
Worker
Result
Wrapped
Wrapped3
D
Wrapped
Curve
Wrapped
Face
Wrapped
Marker
Any
Shape
Assembly
Exporter
Brep
Error
Code
Brep
Error
Kind
Chamfer
Distance
Chamfer
Radius
Clean
Loft
Config
Compound
Comp
Solid
Cube
Face
Curve
Type
Direction
Input
DXF
Entity
Edge
Face
Fillet
Radius
Finder
Fn
Generic
Sweep
Config
Generic
Topo
Operation
Fn
Operation
Handler
Plane
Input
Plane
Name
Point
Point2
D
Point
Input
Projection
Plane
Radius
Config
Radius
Options
Result
Scale
Mode
Shape1
D
Shape2
D
Shape3
D
Shapeable
Shape
Config
Shape
Kind
Shell
Single
Face
Solid
Spline
Config
Spline
Options
Supported
Unit
Sweep
Config
Topo
Entity
Unit
Vec2
Vec3
Vertex
Wire
Brep
Error
Code
DEG2
RAD
flat
Map
HASH_
CODE_
MAX
OK
RAD2
DEG
add
Child
add
Holes
add
Step
adjacent
Faces
and
Then
apply
Glue
approximate
Curve
as
Topo
auto
Heal
axis2d
basic
Face
Extrusion
bezier
blueprint
Bounding
Box
blueprint
Is
Inside
blueprint
Orientation
blueprint
To
DXF
blueprint
To
SVG
Path
D
boss
box
bspline
Approx
bug
camera
From
Plane
camera
Look
At
cast
cast
Shape
chamfer
chamfer
Dist
Angle
Shape
check
All
Interferences
check
Interference
circle
circular
Pattern
classify
Point
On
Face
clear
Mesh
Cache
clone
collect
collect
Shapes
complex
Extrude
compound
compound
Sketch
Extrude
compound
Sketch
Face
compound
Sketch
Loft
compound
Sketch
Revolve
computation
Error
cone
corner
Finder
count
Nodes
create
Assembly
create
Assembly
Node
create
Blueprint
create
Camera
create
Compound
create
Distance
Query
create
Edge
create
Face
create
Handle
create
History
create
Mesh
Cache
create
Named
Plane
create
Oc
Handle
create
Operation
Registry
create
Plane
create
Registry
create
Shell
create
Solid
create
Task
Queue
create
Vertex
create
Wire
create
Worker
Client
create
Worker
Handler
curve2d
Bounding
Box
curve2d
Distance
From
curve2d
First
Point
curve2d
Is
On
Curve
curve2d
Last
Point
curve2d
Parameter
curve2d
Split
At
curve2d
Tangent
At
curve
End
Point
curve
Is
Closed
curve
Is
Periodic
curve
Length
curve
Period
curve
Point
At
curve
Start
Point
curve
Tangent
At
cut
cut2
D
cut
All
cut
Blueprint2
D
cut
Blueprints
cylinder
dequeue
Task
describe
deserialize
Drawing
deserialize
Shape
downcast
drawing
Chamfer
drawing
Cut
drawing
Fillet
drawing
Fuse
drawing
Intersect
drawing
To
Sketch
On
Plane
drill
edge
Finder
edges
Of
Face
ellipse
ellipse
Arc
ellipsoid
enqueue
Task
err
export
Assembly
STEP
export
DXF
export
Glb
export
Gltf
export
IGES
export
OBJ
export
STEP
export
STL
export
Three
MF
extrude
face
face
Center
face
Finder
face
Geom
Type
face
Orientation
faces
Of
Edge
filled
Face
fillet
find
Curve
Type
find
Node
find
Step
flip
Face
Orientation
flip
Orientation
from
BREP
from
Oc
Dir
from
Oc
Pnt
from
Oc
Vec
fuse
fuse2
D
fuse
All
fuse
Blueprint2
D
fuse
Blueprints
gc
With
Object
gc
With
Scope
generic
Sweep
get
Bounds
get
Bounds2
D
get
Curve
Type
get
Edges
get
Faces
get
Font
get
Hash
Code
get
History
Shape
get
Kernel
get
Orientation
get
Orientation2
D
get
Shape
Kind
get
Single
Face
get
Surface
Type
get
Vertices
get
Wires
heal
heal
Face
heal
Solid
heal
Wire
helix
import
IGES
import
STEP
import
STL
import
SVG
import
SVG
Path
D
init
From
OC
inner
Wires
interpolate
Curve
intersect
intersect2
D
intersect
Blueprint2
D
intersect
Blueprints
io
Error
is
Chamfer
Radius
is
Compound
is
Comp
Solid
is
Dispose
Request
is
Edge
is
Empty
is
Equal
Shape
is
Err
is
Error
Response
is
Face
is
Fillet
Radius
is
Init
Request
is
Inside2
D
is
Number
is
Ok
is
Operation
Request
is
Point
is
Projection
Plane
is
Queue
Empty
is
Same
Shape
is
Shape1
D
is
Shape3
D
is
Shell
is
Solid
is
Success
Response
is
Valid
is
Vertex
is
Wire
iter
Edges
iter
Faces
iter
Topo
iter
Vertices
iter
Wires
kernel
Call
kernel
Call
Raw
line
linear
Pattern
load
Font
local
GC
loft
make
Base
Box
make
Plane
make
Projected
Edges
map
map
Err
match
measure
Area
measure
Curvature
At
measure
Curvature
At
Mid
measure
Distance
measure
Length
measure
Linear
Props
measure
Surface
Props
measure
Volume
measure
Volume
Props
mesh
mesh
Edges
mirror
mirror2
D
mirror
Blueprint
mirror
Drawing
mirror
Join
modify
Step
module
Init
Error
normal
At
occt
Error
offset
offset
Face
offset
Wire2
D
ok
organise
Blueprints
outer
Wire
pending
Count
pipeline
pivot
Plane
pocket
point
On
Surface
polygon
polyside
Inner
Radius
polysides
Blueprint
project
Edges
project
Point
On
Face
query
Error
rectangular
Pattern
register
Handler
register
Operation
register
Shape
reject
All
remove
Child
replay
From
replay
History
resolve
resolve3
D
resolve
Direction
resolve
Plane
reverse
Curve
revolution
revolve
rotate
rotate2
D
rotate
Blueprint
rotate
Drawing
rounded
Rectangle
Blueprint
scale
scale2
D
scale
Blueprint
scale
Drawing
section
sew
Shells
shape
shape
Type
shared
Edges
shell
simplify
sketch2
D
On
Face
sketch2
D
On
Plane
sketch
Blueprint
On
Face
sketch
Blueprint
On
Plane
sketcher
State
Error
sketch
Extrude
sketch
Face
sketch
Loft
sketch
Revolve
sketch
Sweep
sketch
Text
sketch
Wires
slice
solid
sphere
split
step
Count
steps
From
stretch2
D
stretch
Blueprint
sub
Face
support
Extrude
sweep
tangent
Arc
text
Blueprints
thicken
three
Point
Arc
to
BREP
to
Buffer
Geometry
Data
to
Grouped
Buffer
Geometry
Data
to
Line
Geometry
Data
to
Oc
Vec
torus
to
SVG
Path
D
to
Vec2
to
Vec3
translate
translate2
D
translate
Blueprint
translate
Drawing
translate
Plane
try
Catch
try
Catch
Async
twist
Extrude
type
Cast
Error
undo
Last
unwrap
unwrap
Err
unwrap
Or
unwrap
Or
Else
update
Node
uv
Bounds
uv
Coordinates
validation
Error
vec
Add
vec
Angle
vec
Cross
vec
Distance
vec
Dot
vec
Equals
vec
Is
Zero
vec
Length
vec
Length
Sq
vec
Negate
vec
Normalize
vec
Project
To
Plane
vec
Repr
vec
Rotate
vec
Scale
vec
Sub
vertex
vertex
Finder
vertex
Position
vertices
Of
Edge
walk
Assembly
wire
wire
Finder
wires
Of
Face
with
Oc
Dir
with
Oc
Pnt
with
Oc
Vec
with
Scope
Clean
Sweep
Config
Clean
Sweep
Options
Sketching
Base
Sketcher2d
Blueprint
Sketcher
Compound
Sketch
Face
Sketcher
Sketch
Sketcher
Sketches
Generic
Sketcher
sketch
Circle
sketch
Ellipse
sketch
Face
Offset
sketch
Helix
sketch
Parametric
Function
sketch
Polysides
sketch
Rectangle
sketch
Rounded
Rectangle
GitHub
npm
Getting Started
brepjs API Reference
Loading...