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
booleans
construction
csg
io
measurement
modifiers
patterns
primitives
query
transforms
BrepBugError
BrepkitAdapter
BrepWrapperError
DisposalScope
OcctWasmAdapter
ApproximateCurveOptions
AssemblyNode
AssemblyNodeOptions
AssemblySolveResult
AutoHealOptions
BatchBisectResult
BatchBisectTelemetry
BatchItemResult
BatchOperation
BatchRequest
Blueprint
Blueprints
BooleanDiagnostics
BooleanIssue
BooleanOptions
BooleanPipelineStep
BossOptions
BoundingBox2d
Bounds3D
BoxOptions
BrepError
BrepkitHandle
BrokenDerivedFaceRef
BrokenEdgeRef
BrokenRef
BrokenVertexRef
BufferGeometryData
BufferGeometryGroup
Camera
CheckBooleanResult
CircleOptions
CleanLoftOptions
ComposedTransform
CompoundBlueprint
ConeOptions
ConstraintSketchCapability
CornerFilter
CornerFinderFn
CurvatureResult
Curve2D
Curve2DHandle
CurveLike
CylinderOptions
CylindricalOptions
Deletable
DerivedFaceHint
DerivedFaceRef
DHOptions
DHRow
DisposalStats
DisposeRequest
DistanceProps
DraftOptions
DrawingInterface
DrawingLike
DrillOptions
DXFExportOptions
DXFImportOptions
EdgeFinderFn
EdgeHint
EdgeMesh
EdgeRef
EllipseArcOptions
EllipseOptions
EllipsoidOptions
Err
ErrorResponse
EvolutionResult
ExternalGearParams
ExtrudeAllEntry
ExtrusionProfile
FaceFinderFn
FontMetricsResult
GearDiagnostic
GearGeometry
GearResult
GeometricHint
GltfExportOptions
GltfFace
GltfMaterial
GroupedBufferGeometryData
GuidedSweepOptions
HealingReport
HealingStepDiagnostic
HelixOptions
HistoryOperationRegistry
HullOptions
IKOptions
IKResult
IKTarget
InitRequest
InstancedMesh
InstancedShape
InstanceGridOptions
InterferencePair
InterferenceResult
InternalGearParams
InterpolateCurveOptions
Joint
JointAxis
JointDOF
JointOptions
JointPose
KernelBooleanOps
KernelBuilderOps
KernelCapabilities
KernelCore
KernelCurveOps
KernelEvolutionOps
KernelHandle
KernelIOOps
KernelMeasureOps
KernelMeshOps
KernelModifierOps
KernelPrimitiveOps
KernelRepairOps
KernelSurfaceOps
KernelSweepOps
KernelTopologyOps
KernelTransformOps
LatticeBounds
LatticeOptions
LinearProps
LineGeometryData
LODGeometryData
LODGeometryLevel
LODMesh
LoftAllEntry
MateEntity
MaterializeOptions
MatrixTransform
MeshCacheContext
MeshLODsOptions
MeshLODsProgressiveOptions
MeshOptions
MinkowskiOptions
MirrorJoinOptions
MirrorOptions
ModelHistory
MultiLODMesh
MultiSweepOptions
NurbsCurveData
NurbsSurfaceData
OcctKernelWasm
OcctWasmHandle
OcctWasmModule
Ok
OperationRegistry
OperationRequest
OperationStep
PendingTask
PhysicalProps
PlanarOptions
Plane
PlanetaryGearAssembly
PlanetaryGearParams
PlanetPlacement
PlanetPlacementParams
PocketOptions
PointProjectionResult
PolyhedronOptions
ProjectionCapability
RectangularPatternOptions
RepairOptions
ResolvedDerivedFaceRef
ResolvedEdgeRef
ResolvedRef
ResolvedVertexRef
ResultPipeline
RevolveOptions
RoofOptions
RotateOptions
ScalarFieldHandle
ScaleOptions
SdfBounds
SdfHandle
SdfSweepOptions
SerializedHistory
ShapeDescription
ShapeEvolution
ShapeFinder
ShapeHandle
ShapeMesh
ShapeOptions
ShapeRef
SkeletonFace
SkeletonNode
SketchData
SketchInterface
SkPoint2D
SphereOptions
SphericalOptions
StepExportOptions
StepExportPart
StraightSkeleton
SuccessResponse
SurfaceFromGridOptions
SurfaceFromImageOptions
SurfaceProps
SVGImportOptions
SweepOptions
SweepSectionConfig
TaskQueue
TextMetricsResult
ThreadOptions
ThreeMFExportOptions
ThreeMFMaterial
TorusOptions
TrajectorySample
UrdfDocument
UrdfExportOptions
UVBounds
VariableFilletRadius
VertexFinderFn
VertexHint
VertexRef
VolumeProps
VoxelEngine
VoxelFieldHandle
VoxelFieldOptions
VoxelMeshInput
VoxelOpOptions
VoxelRepairResult
WireFinderFn
WorkerClient
WorkerClientOptions
WorkerOperation
WorkerPool
WorkerPoolOptions
WorkerRequest
WorkerResponse
WorkerResult
Wrapped
Wrapped3D
WrappedCurve
WrappedFace
WrappedMarker
AnyShape
AssemblyExporter
BooleanOpType
BrepErrorCode
BrepErrorKind
BrokenReason
ChamferDistance
ChamferRadius
ClosedWire
Color
ColorInput
Compound
CompSolid
CubeFace
CurveType
Dimension
DimensionError
DirectionInput
DraftAngle
DXFEntity
Edge
Face
FaceScorer
FilletRadius
FinderFn
GearDiagnosticCode
GearDiagnosticSeverity
GenericTopo
JointType
KernelAdapter
LatticeType
LineageRef
LineageResolution
ManifoldShell
MateConstraint
MaterialFn
Matrix4x4
MatrixInput
MeshLevelFn
OperationFn
OperationHandler
OrientedFace
PerformanceStats
PipelineOp
PlanarFace
PlanarWire
PlaneInput
PlaneName
Point2D
PointInput
ProjectionPlane
QualityLevel
RadiusOptions
RequireDimension
ResolvedEntity
Result
RoleTable
SameDimension
ScaleMode
SdfLatticeKind
Shape1D
Shape2D
Shape3D
Shapeable
ShapeKind
ShapeOrientation
ShapeType
Shell
SingleFace
Solid
SplineOptions
SupportedUnit
SurfaceType
TessellationModel
TopoEntity
TransformOp
Unit
UnknownDimShape
ValidSolid
Vec2
Vec3
Vertex
VoxelBooleanOp
Wire
all
BrepErrorCode
DEFAULT_CAPABILITIES
DEG2RAD
EXACT_BREP_CAPABILITIES
flatMap
HASH_CODE_MAX
OK
RAD2DEG
addChild
addHoles
addJoint
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
createDerivedFaceRef
createDistanceQuery
createEdge
createEdgeRef
createFace
createHandle
createHistory
createKernelHandle
createMeshCache
createNamedPlane
createOperationRegistry
createPlane
createRef
createRegistry
createShell
createSolid
createTaskQueue
createVertex
createVertexRef
createWire
createWorkerClient
createWorkerHandler
createWorkerPool
currentQuality
curve2dBoundingBox
curve2dDistanceFrom
curve2dFirstPoint
curve2dIsOnCurve
curve2dLastPoint
curve2dParameter
curve2dSplitAt
curve2dTangentAt
curveAxis
curveEndPoint
curveIsClosed
curveIsPeriodic
curveLength
curvePeriod
curvePointAt
curveStartPoint
curveTangentAt
cut
cut2D
cutAll
cutAllBisect
cutBlueprints
cutWithEvolution
cylinder
cylindricalJoint
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
exportURDF
extrude
extrudeAll
face
faceAxis
faceCenter
faceFinder
faceGeomType
faceOrientation
facesOfEdge
facesOfVertex
fieldBoolean
fieldContour
fieldOffset
fieldReinit
fieldShell
fill
filledFace
fillet
filletWithEvolution
findFacesByTag
findNode
findStep
fixSelfIntersection
fixShape
flatten
flipFaceOrientation
flipOrientation
fontMetrics
forwardKinematics
fromBREP
fromKernelDir
fromKernelPnt
fromKernelVec
fromNullable
fuse
fuse2D
fuseAll
fuseAllBisect
fuseBlueprints
fuseWithEvolution
gearGeometry
getActiveVoxelId
getBounds
getBounds2D
getCompSolids
getCurveType
getDisposalStats
getEdges
getFaceColor
getFaceOrigins
getFaces
getFaceTags
getFont
getHashCode
getHistoryShape
getKernel
getKernelCapabilities
getKernelTier
getNurbsCurveData
getNurbsSurfaceData
getOrientation
getOrientation2D
getPerformanceStats
getShapeColor
getShapeKind
getShells
getSingleFace
getSolids
getSurfaceType
getTagMetadata
getVertices
getVoxel
getWires
gridPattern
guidedSweep
heal
healFace
healSolid
healWire
helix
hull
importDXF
importGLB
importIGES
importOBJ
importSTEP
importSTL
importSVG
importSVGPathD
importThreeMF
importURDF
init
initFromManifold
initFromOC
initVoxel
innerWires
instance
instanceCount
instancedMesh
instanceGrid
interpolateCurve
intersect
intersect2D
intersectBlueprints
intersectWithEvolution
invalidateShapeCache
inverseKinematics
ioError
is2D
is3D
isBatchRequest
isChamferRadius
isClosedWire
isCompound
isCompSolid
isDerivedFaceRef
isDisposeRequest
isEdge
isEdgeRef
isEmpty
isEqualShape
isErr
isErrorResponse
isFace
isFaceRef
isFilletRadius
isInitRequest
isInside2D
isInstanced
isLineageRef
isLive
isManifoldShell
isNumber
isOk
isOperationRequest
isOrientedFace
isPlanarFace
isPlanarWire
isProjectionPlane
isQueueEmpty
isSameShape
isShape1D
isShape3D
isShell
isSolid
isSuccessResponse
isValid
isValidSolid
isVertex
isVertexRef
isWire
iterCompSolids
iterEdges
iterFaces
iterShells
iterSolids
iterTopo
iterVertices
iterWires
jointsFromDH
jointTrajectory
jointTransform
kernelCall
kernelCallRaw
kernelCallScoped
kernelError
latticeInfill
latticeInfillShape
line
linearPattern
loadFont
locate
loft
loftAll
makeBaseBox
makeExternalGear
makeInternalGear
makePlane
makePlanetaryGear
makeProjectedEdges
manifoldShell
map
mapBoth
mapErr
match
materialize
measureArea
measureCurvatureAt
measureCurvatureAtMid
measureDistance
measureDistanceProps
measureLength
measureLinearProps
measureSurfaceProps
measureVolume
measureVolumeProps
mechanismDOF
mesh
meshEdges
meshLODs
meshLODsProgressive
meshMultiLOD
minkowski
mirror
mirror2D
mirrorDrawing
mirrorJoin
modifyStep
moduleInitError
multiSectionSweep
normalAt
offset
offsetFace
offsetMesh
offsetShape
offsetWire2D
ok
or
orElse
organiseBlueprints
orientedFace
outerWire
pendingCount
pipeline
pivotPlane
planarFace
planarJoint
planarWire
planetPlacements
pocket
pointOnSurface
pointsInside
polygon
polyhedron
polysideInnerRadius
polysidesBlueprint
positionOnCurve
prewarm
prismaticJoint
projectEdges
projectPointOnFace
queryError
rectangularPattern
registerHandler
registerKernel
registerKernelTier
registerOperation
registerShape
registerVoxel
rejectAll
removeChild
removeHolesFromFace
repairMesh
replayFrom
replayHistory
resetDisposalStats
resetPerformanceStats
resize
resolve
resolve3D
resolveDerivedFaceRef
resolveDirection
resolveEdgeRef
resolveLineageRef
resolvePlane
resolveRef
resolveRefIn
resolveRefParams
resolveVertexRef
reverseCurve
revoluteJoint
revolve
roof
rotate
rotate2D
rotateDrawing
roundedRectangleBlueprint
scale
scale2D
scaleDrawing
sdfBox
sdfCapsule
sdfCone
sdfCylinder
sdfFieldAxialRamp
sdfFieldClamp
sdfFieldConst
sdfFieldFromSdf
sdfFieldRadialRamp
sdfLattice
sdfPlane
sdfRoundedBox
sdfSphere
sdfStrutLattice
sdfSweep
sdfTorus
section
sectionToFace
serializeHistory
setJointValue
setJointValues
setShapeOrigin
setTagMetadata
sewShells
shape
shapeToMeshInput
shapeType
sharedEdges
shell
shellMesh
shellShape
shellWithEvolution
simplify
sketcherStateError
sketchExtrude
sketchFace
sketchLoft
sketchOnFace2D
sketchOnPlane2D
sketchRevolve
sketchSweep
sketchText
sketchWires
slice
solid
solidFromShell
solveAssembly
sphere
sphericalJoint
split
stepCount
stepsFrom
stretch2D
subFace
supportExtrude
supportsConstraintSketch
supportsProjection
surfaceFromGrid
surfaceFromImage
sweep
tagFaces
tangentArc
tap
tapErr
textBlueprints
textMetrics
thicken
thread
threePointArc
toBREP
toBufferGeometryData
toGroupedBufferGeometryData
toKernelVec
toLineGeometryData
toLODGeometryData
toLODGeometryLevels
torus
toSVGPathD
toVec2
toVec3
tpmsLattice
transformCopy
translate
translate2D
translateDrawing
translatePlane
tryCatch
tryCatchAsync
twistExtrude
typeCastError
undoLast
unsupportedError
unwrap
unwrapErr
unwrapOr
unwrapOrElse
updateNode
updateRoles
uvBounds
uvCoordinates
validatePlanetary
validationError
validSolid
variableFillet
vecAdd
vecAngle
vecCross
vecDistance
vecDot
vecEquals
vecIsZero
vecLength
vecLengthSq
vecNegate
vecNormalize
vecProjectToPlane
vecRepr
vecRotate
vecScale
vecSub
vertex
vertexFinder
vertexPosition
verticesOfEdge
verticesOfFace
voxelBoolean
voxelBooleanField
voxelBooleanFieldShapes
voxelBooleanShapes
voxelField
voxelFieldFromShape
walkAssembly
windingNumbers
wire
wireFinder
wireLoop
wiresOfFace
withKernel
withKernelDir
withKernelPnt
withKernelVec
withQuality
withScope
withScopeResult
withScopeResultAsync
withTier
zipResults
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
booleans
construction
csg
io
measurement
modifiers
patterns
primitives
query
transforms
Brep
Bug
Error
Brepkit
Adapter
Brep
Wrapper
Error
Disposal
Scope
Occt
Wasm
Adapter
Approximate
Curve
Options
Assembly
Node
Assembly
Node
Options
Assembly
Solve
Result
Auto
Heal
Options
Batch
Bisect
Result
Batch
Bisect
Telemetry
Batch
Item
Result
Batch
Operation
Batch
Request
Blueprint
Blueprints
Boolean
Diagnostics
Boolean
Issue
Boolean
Options
Boolean
Pipeline
Step
Boss
Options
Bounding
Box2d
Bounds3
D
Box
Options
Brep
Error
Brepkit
Handle
Broken
Derived
Face
Ref
Broken
Edge
Ref
Broken
Ref
Broken
Vertex
Ref
Buffer
Geometry
Data
Buffer
Geometry
Group
Camera
Check
Boolean
Result
Circle
Options
Clean
Loft
Options
Composed
Transform
Compound
Blueprint
Cone
Options
Constraint
Sketch
Capability
Corner
Filter
Corner
Finder
Fn
Curvature
Result
Curve2
D
Curve2
D
Handle
Curve
Like
Cylinder
Options
Cylindrical
Options
Deletable
Derived
Face
Hint
Derived
Face
Ref
DH
Options
DH
Row
Disposal
Stats
Dispose
Request
Distance
Props
Draft
Options
Drawing
Interface
Drawing
Like
Drill
Options
DXF
Export
Options
DXF
Import
Options
Edge
Finder
Fn
Edge
Hint
Edge
Mesh
Edge
Ref
Ellipse
Arc
Options
Ellipse
Options
Ellipsoid
Options
Err
Error
Response
Evolution
Result
External
Gear
Params
Extrude
All
Entry
Extrusion
Profile
Face
Finder
Fn
Font
Metrics
Result
Gear
Diagnostic
Gear
Geometry
Gear
Result
Geometric
Hint
Gltf
Export
Options
Gltf
Face
Gltf
Material
Grouped
Buffer
Geometry
Data
Guided
Sweep
Options
Healing
Report
Healing
Step
Diagnostic
Helix
Options
History
Operation
Registry
Hull
Options
IK
Options
IK
Result
IK
Target
Init
Request
Instanced
Mesh
Instanced
Shape
Instance
Grid
Options
Interference
Pair
Interference
Result
Internal
Gear
Params
Interpolate
Curve
Options
Joint
Joint
Axis
Joint
DOF
Joint
Options
Joint
Pose
Kernel
Boolean
Ops
Kernel
Builder
Ops
Kernel
Capabilities
Kernel
Core
Kernel
Curve
Ops
Kernel
Evolution
Ops
Kernel
Handle
Kernel
IO
Ops
Kernel
Measure
Ops
Kernel
Mesh
Ops
Kernel
Modifier
Ops
Kernel
Primitive
Ops
Kernel
Repair
Ops
Kernel
Surface
Ops
Kernel
Sweep
Ops
Kernel
Topology
Ops
Kernel
Transform
Ops
Lattice
Bounds
Lattice
Options
Linear
Props
Line
Geometry
Data
LOD
Geometry
Data
LOD
Geometry
Level
LOD
Mesh
Loft
All
Entry
Mate
Entity
Materialize
Options
Matrix
Transform
Mesh
Cache
Context
Mesh
LO
Ds
Options
Mesh
LO
Ds
Progressive
Options
Mesh
Options
Minkowski
Options
Mirror
Join
Options
Mirror
Options
Model
History
Multi
LOD
Mesh
Multi
Sweep
Options
Nurbs
Curve
Data
Nurbs
Surface
Data
Occt
Kernel
Wasm
Occt
Wasm
Handle
Occt
Wasm
Module
Ok
Operation
Registry
Operation
Request
Operation
Step
Pending
Task
Physical
Props
Planar
Options
Plane
Planetary
Gear
Assembly
Planetary
Gear
Params
Planet
Placement
Planet
Placement
Params
Pocket
Options
Point
Projection
Result
Polyhedron
Options
Projection
Capability
Rectangular
Pattern
Options
Repair
Options
Resolved
Derived
Face
Ref
Resolved
Edge
Ref
Resolved
Ref
Resolved
Vertex
Ref
Result
Pipeline
Revolve
Options
Roof
Options
Rotate
Options
Scalar
Field
Handle
Scale
Options
Sdf
Bounds
Sdf
Handle
Sdf
Sweep
Options
Serialized
History
Shape
Description
Shape
Evolution
Shape
Finder
Shape
Handle
Shape
Mesh
Shape
Options
Shape
Ref
Skeleton
Face
Skeleton
Node
Sketch
Data
Sketch
Interface
Sk
Point2
D
Sphere
Options
Spherical
Options
Step
Export
Options
Step
Export
Part
Straight
Skeleton
Success
Response
Surface
From
Grid
Options
Surface
From
Image
Options
Surface
Props
SVG
Import
Options
Sweep
Options
Sweep
Section
Config
Task
Queue
Text
Metrics
Result
Thread
Options
Three
MF
Export
Options
Three
MF
Material
Torus
Options
Trajectory
Sample
Urdf
Document
Urdf
Export
Options
UV
Bounds
Variable
Fillet
Radius
Vertex
Finder
Fn
Vertex
Hint
Vertex
Ref
Volume
Props
Voxel
Engine
Voxel
Field
Handle
Voxel
Field
Options
Voxel
Mesh
Input
Voxel
Op
Options
Voxel
Repair
Result
Wire
Finder
Fn
Worker
Client
Worker
Client
Options
Worker
Operation
Worker
Pool
Worker
Pool
Options
Worker
Request
Worker
Response
Worker
Result
Wrapped
Wrapped3
D
Wrapped
Curve
Wrapped
Face
Wrapped
Marker
Any
Shape
Assembly
Exporter
Boolean
Op
Type
Brep
Error
Code
Brep
Error
Kind
Broken
Reason
Chamfer
Distance
Chamfer
Radius
Closed
Wire
Color
Color
Input
Compound
Comp
Solid
Cube
Face
Curve
Type
Dimension
Dimension
Error
Direction
Input
Draft
Angle
DXF
Entity
Edge
Face
Face
Scorer
Fillet
Radius
Finder
Fn
Gear
Diagnostic
Code
Gear
Diagnostic
Severity
Generic
Topo
Joint
Type
Kernel
Adapter
Lattice
Type
Lineage
Ref
Lineage
Resolution
Manifold
Shell
Mate
Constraint
Material
Fn
Matrix4x4
Matrix
Input
Mesh
Level
Fn
Operation
Fn
Operation
Handler
Oriented
Face
Performance
Stats
Pipeline
Op
Planar
Face
Planar
Wire
Plane
Input
Plane
Name
Point2
D
Point
Input
Projection
Plane
Quality
Level
Radius
Options
Require
Dimension
Resolved
Entity
Result
Role
Table
Same
Dimension
Scale
Mode
Sdf
Lattice
Kind
Shape1
D
Shape2
D
Shape3
D
Shapeable
Shape
Kind
Shape
Orientation
Shape
Type
Shell
Single
Face
Solid
Spline
Options
Supported
Unit
Surface
Type
Tessellation
Model
Topo
Entity
Transform
Op
Unit
Unknown
Dim
Shape
Valid
Solid
Vec2
Vec3
Vertex
Voxel
Boolean
Op
Wire
all
Brep
Error
Code
DEFAULT_
CAPABILITIES
DEG2
RAD
EXACT_
BREP_
CAPABILITIES
flat
Map
HASH_
CODE_
MAX
OK
RAD2
DEG
add
Child
add
Holes
add
Joint
add
Mate
add
Step
adjacent
Faces
and
Then
apply
Glue
apply
Matrix
approximate
Curve
as2
D
as3
D
assign
Roles
as
Topo
auto
Heal
bezier
blueprint
To
DXF
boolean
Pipeline
boss
box
bspline
Approx
bug
camera
From
Plane
camera
Look
At
capture
Hint
cast
cast
Shape
cast
Shape3
D
chamfer
chamfer
Dist
Angle
Shape
chamfer
With
Evolution
check
All
Interferences
check
Boolean
check
Interference
circle
circular
Pattern
classify
Point
On
Face
clear
Mesh
Cache
clone
closed
Wire
collect
collect
Shapes
color
Faces
color
Shape
complex
Extrude
compose
Transforms
compound
compound
Sketch
Extrude
compound
Sketch
Face
compound
Sketch
Loft
compound
Sketch
Revolve
computation
Error
compute
Straight
Skeleton
cone
convex
Hull
corner
Finder
count
Nodes
create
Assembly
create
Assembly
Node
create
Blueprint
create
Camera
create
Compound
create
Compound
Blueprint
create
Derived
Face
Ref
create
Distance
Query
create
Edge
create
Edge
Ref
create
Face
create
Handle
create
History
create
Kernel
Handle
create
Mesh
Cache
create
Named
Plane
create
Operation
Registry
create
Plane
create
Ref
create
Registry
create
Shell
create
Solid
create
Task
Queue
create
Vertex
create
Vertex
Ref
create
Wire
create
Worker
Client
create
Worker
Handler
create
Worker
Pool
current
Quality
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
Axis
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
All
Bisect
cut
Blueprints
cut
With
Evolution
cylinder
cylindrical
Joint
default
Scorer
dequeue
Task
describe
deserialize
Drawing
deserialize
History
deserialize
Shape
downcast
draft
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
STEP
Configured
export
STL
export
Three
MF
export
URDF
extrude
extrude
All
face
face
Axis
face
Center
face
Finder
face
Geom
Type
face
Orientation
faces
Of
Edge
faces
Of
Vertex
field
Boolean
field
Contour
field
Offset
field
Reinit
field
Shell
fill
filled
Face
fillet
fillet
With
Evolution
find
Faces
By
Tag
find
Node
find
Step
fix
Self
Intersection
fix
Shape
flatten
flip
Face
Orientation
flip
Orientation
font
Metrics
forward
Kinematics
from
BREP
from
Kernel
Dir
from
Kernel
Pnt
from
Kernel
Vec
from
Nullable
fuse
fuse2
D
fuse
All
fuse
All
Bisect
fuse
Blueprints
fuse
With
Evolution
gear
Geometry
get
Active
Voxel
Id
get
Bounds
get
Bounds2
D
get
Comp
Solids
get
Curve
Type
get
Disposal
Stats
get
Edges
get
Face
Color
get
Face
Origins
get
Faces
get
Face
Tags
get
Font
get
Hash
Code
get
History
Shape
get
Kernel
get
Kernel
Capabilities
get
Kernel
Tier
get
Nurbs
Curve
Data
get
Nurbs
Surface
Data
get
Orientation
get
Orientation2
D
get
Performance
Stats
get
Shape
Color
get
Shape
Kind
get
Shells
get
Single
Face
get
Solids
get
Surface
Type
get
Tag
Metadata
get
Vertices
get
Voxel
get
Wires
grid
Pattern
guided
Sweep
heal
heal
Face
heal
Solid
heal
Wire
helix
hull
import
DXF
import
GLB
import
IGES
import
OBJ
import
STEP
import
STL
import
SVG
import
SVG
Path
D
import
Three
MF
import
URDF
init
init
From
Manifold
init
From
OC
init
Voxel
inner
Wires
instance
instance
Count
instanced
Mesh
instance
Grid
interpolate
Curve
intersect
intersect2
D
intersect
Blueprints
intersect
With
Evolution
invalidate
Shape
Cache
inverse
Kinematics
io
Error
is2
D
is3
D
is
Batch
Request
is
Chamfer
Radius
is
Closed
Wire
is
Compound
is
Comp
Solid
is
Derived
Face
Ref
is
Dispose
Request
is
Edge
is
Edge
Ref
is
Empty
is
Equal
Shape
is
Err
is
Error
Response
is
Face
is
Face
Ref
is
Fillet
Radius
is
Init
Request
is
Inside2
D
is
Instanced
is
Lineage
Ref
is
Live
is
Manifold
Shell
is
Number
is
Ok
is
Operation
Request
is
Oriented
Face
is
Planar
Face
is
Planar
Wire
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
Valid
Solid
is
Vertex
is
Vertex
Ref
is
Wire
iter
Comp
Solids
iter
Edges
iter
Faces
iter
Shells
iter
Solids
iter
Topo
iter
Vertices
iter
Wires
joints
From
DH
joint
Trajectory
joint
Transform
kernel
Call
kernel
Call
Raw
kernel
Call
Scoped
kernel
Error
lattice
Infill
lattice
Infill
Shape
line
linear
Pattern
load
Font
locate
loft
loft
All
make
Base
Box
make
External
Gear
make
Internal
Gear
make
Plane
make
Planetary
Gear
make
Projected
Edges
manifold
Shell
map
map
Both
map
Err
match
materialize
measure
Area
measure
Curvature
At
measure
Curvature
At
Mid
measure
Distance
measure
Distance
Props
measure
Length
measure
Linear
Props
measure
Surface
Props
measure
Volume
measure
Volume
Props
mechanism
DOF
mesh
mesh
Edges
mesh
LO
Ds
mesh
LO
Ds
Progressive
mesh
Multi
LOD
minkowski
mirror
mirror2
D
mirror
Drawing
mirror
Join
modify
Step
module
Init
Error
multi
Section
Sweep
normal
At
offset
offset
Face
offset
Mesh
offset
Shape
offset
Wire2
D
ok
or
or
Else
organise
Blueprints
oriented
Face
outer
Wire
pending
Count
pipeline
pivot
Plane
planar
Face
planar
Joint
planar
Wire
planet
Placements
pocket
point
On
Surface
points
Inside
polygon
polyhedron
polyside
Inner
Radius
polysides
Blueprint
position
On
Curve
prewarm
prismatic
Joint
project
Edges
project
Point
On
Face
query
Error
rectangular
Pattern
register
Handler
register
Kernel
register
Kernel
Tier
register
Operation
register
Shape
register
Voxel
reject
All
remove
Child
remove
Holes
From
Face
repair
Mesh
replay
From
replay
History
reset
Disposal
Stats
reset
Performance
Stats
resize
resolve
resolve3
D
resolve
Derived
Face
Ref
resolve
Direction
resolve
Edge
Ref
resolve
Lineage
Ref
resolve
Plane
resolve
Ref
resolve
Ref
In
resolve
Ref
Params
resolve
Vertex
Ref
reverse
Curve
revolute
Joint
revolve
roof
rotate
rotate2
D
rotate
Drawing
rounded
Rectangle
Blueprint
scale
scale2
D
scale
Drawing
sdf
Box
sdf
Capsule
sdf
Cone
sdf
Cylinder
sdf
Field
Axial
Ramp
sdf
Field
Clamp
sdf
Field
Const
sdf
Field
From
Sdf
sdf
Field
Radial
Ramp
sdf
Lattice
sdf
Plane
sdf
Rounded
Box
sdf
Sphere
sdf
Strut
Lattice
sdf
Sweep
sdf
Torus
section
section
To
Face
serialize
History
set
Joint
Value
set
Joint
Values
set
Shape
Origin
set
Tag
Metadata
sew
Shells
shape
shape
To
Mesh
Input
shape
Type
shared
Edges
shell
shell
Mesh
shell
Shape
shell
With
Evolution
simplify
sketcher
State
Error
sketch
Extrude
sketch
Face
sketch
Loft
sketch
On
Face2
D
sketch
On
Plane2
D
sketch
Revolve
sketch
Sweep
sketch
Text
sketch
Wires
slice
solid
solid
From
Shell
solve
Assembly
sphere
spherical
Joint
split
step
Count
steps
From
stretch2
D
sub
Face
support
Extrude
supports
Constraint
Sketch
supports
Projection
surface
From
Grid
surface
From
Image
sweep
tag
Faces
tangent
Arc
tap
tap
Err
text
Blueprints
text
Metrics
thicken
thread
three
Point
Arc
to
BREP
to
Buffer
Geometry
Data
to
Grouped
Buffer
Geometry
Data
to
Kernel
Vec
to
Line
Geometry
Data
to
LOD
Geometry
Data
to
LOD
Geometry
Levels
torus
to
SVG
Path
D
to
Vec2
to
Vec3
tpms
Lattice
transform
Copy
translate
translate2
D
translate
Drawing
translate
Plane
try
Catch
try
Catch
Async
twist
Extrude
type
Cast
Error
undo
Last
unsupported
Error
unwrap
unwrap
Err
unwrap
Or
unwrap
Or
Else
update
Node
update
Roles
uv
Bounds
uv
Coordinates
validate
Planetary
validation
Error
valid
Solid
variable
Fillet
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
vertices
Of
Face
voxel
Boolean
voxel
Boolean
Field
voxel
Boolean
Field
Shapes
voxel
Boolean
Shapes
voxel
Field
voxel
Field
From
Shape
walk
Assembly
winding
Numbers
wire
wire
Finder
wire
Loop
wires
Of
Face
with
Kernel
with
Kernel
Dir
with
Kernel
Pnt
with
Kernel
Vec
with
Quality
with
Scope
with
Scope
Result
with
Scope
Result
Async
with
Tier
zip
Results
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...