replicad

Finders Classes

• EdgeFinder
• FaceFinder

Other Classes

• BaseSketcher2d
• Blueprint
• BlueprintSketcher
• Blueprints
• BoundingBox
• BoundingBox2d
• CompSolid
• Compound
• CompoundBlueprint
• CompoundSketch
• Curve
• Curve2D
• Drawing
• DrawingPen
• Edge
• Face
• Plane
• Shape
• Shell
• Sketches
• Solid
• Surface
• Transformation
• Vector
• Vertex
• Wire
• WrappingObj
• _1DShape
• _3DShape

Sketching Classes

• FaceSketcher
• Sketch
• Sketcher

Other Interfaces

• BSplineApproximationConfig
• CurveLike
• DrawingInterface
• ExtrusionProfile
• FaceTriangulation
• GenericSweepConfig
• LoftConfig
• ShapeMesh
• SketchInterface

Sketching Interfaces

• GenericSketcher

Blueprints Functions

• textBlueprints

Drawing Functions

• draw
• drawCircle
• drawEllipse
• drawParametricFunction
• drawPointsInterpolation
• drawPolysides
• drawRoundedRectangle
• drawSingleCircle
• drawSingleEllipse
• drawText

Import Functions

• importSTEP
• importSTL

Other Functions

• GCWithObject
• GCWithScope
• addHolesInFace
• asDir
• asPnt
• assembleWire
• axis2d
• basicFaceExtrusion
• cast
• combineFinderFilters
• complexExtrude
• compoundShapes
• createNamedPlane
• cut2D
• cutBlueprints
• downcast
• drawRectangle
• fuse2D
• fuseBlueprints
• genericSweep
• getFont
• getOC
• intersectBlueprints
• isShape3D
• isWire
• iterTopo
• loadFont
• localGC
• loft
• makeAx1
• makeAx2
• makeAx3
• makeBSplineApproximation
• makeBaseBox
• makeBezierCurve
• makeCircle
• makeCompound
• makeCylinder
• makeDirection
• makeEllipse
• makeEllipseArc
• makeFace
• makeHelix
• makeLine
• makeNewFaceWithinFace
• makeNonPlanarFace
• makeOffset
• makePlane
• makePlaneFromFace
• makePolygon
• makeSolid
• makeSphere
• makeTangentArc
• makeThreePointArc
• makeVertex
• mirror
• organiseBlueprints
• polysideInnerRadius
• polysidesBlueprint
• revolution
• rotate
• roundedRectangleBlueprint
• scale
• setOC
• shapeType
• supportExtrude
• translate
• twistExtrude

Sketching Functions

• sketchCircle
• sketchEllipse
• sketchFaceOffset
• sketchParametricFunction
• sketchPolysides
• sketchRectangle
• sketchRoundedRectangle
• sketchText

Type aliases

AnyShape

Ƭ AnyShape: Vertex | Edge | Wire | Face | Shell | Solid | CompSolid | Compound

Defined in

shapes.ts:31

---

CurveType

Ƭ CurveType: "LINE" | "CIRCLE" | "ELLIPSE" | "HYPERBOLA" | "PARABOLA" | "BEZIER_CURVE" | "BSPLINE_CURVE" | "OFFSET_CURVE" | "OTHER_CURVE"

Defined in

definitionMaps.ts:3

---

PlaneName

Ƭ PlaneName: "XY" | "YZ" | "ZX" | "XZ" | "YX" | "ZY" | "front" | "back" | "left" | "right" | "top" | "bottom"

Defined in

geom.ts:466

---

Point

Ƭ Point: SimplePoint | Vector | [number, number] | { XYZ: () => gp_XYZ ; delete: () => void }

Defined in

geom.ts:22

---

Point2D

Ƭ Point2D: [number, number]

Defined in

lib2d.ts:88

---

RadiusConfig

Ƭ RadiusConfig: (e: Edge) => number | null | number | { filter: EdgeFinder ; keep?: boolean ; radius: number }

Defined in

shapes.ts:88

---

ScaleMode

Ƭ ScaleMode: "original" | "bounds" | "native"

Defined in

curves.ts:169

---

Shape2D

Ƭ Shape2D: Blueprint | Blueprints | CompoundBlueprint | null

Defined in

blueprints/boolean2D.ts:11

---

Shape3D

Ƭ Shape3D: Shell | Solid | CompSolid | Compound

Defined in

shapes.ts:1236

---

SimplePoint

Ƭ SimplePoint: [number, number, number]

Defined in

geom.ts:21

---

SplineConfig

Ƭ SplineConfig: SplineTangent | { endFactor?: number ; endTangent?: SplineTangent ; startFactor?: number ; startTangent?: StartSplineTangent }

Defined in

sketcherlib.ts:7

---

SurfaceType

Ƭ SurfaceType: "PLANE" | "CYLINDRE" | "CONE" | "SPHERE" | "TORUS" | "BEZIER_SURFACE" | "BSPLINE_SURFACE" | "REVOLUTION_SURFACE" | "EXTRUSION_SURFACE" | "OFFSET_SURFACE" | "OTHER_SURFACE"

Defined in

shapes.ts:711

Variables

DEG2RAD

• DEG2RAD: number

Defined in

constants.ts:2

---

HASH_CODE_MAX

• HASH_CODE_MAX: 2147483647

Defined in

constants.ts:1

---

RAD2DEG

• RAD2DEG: number

Defined in

constants.ts:3

Blueprints Functions

textBlueprints

▸ textBlueprints(text, __namedParameters?): Blueprints

Parameters

Name	Type
text	string
__namedParameters	Object
__namedParameters.fontFamily	undefined | string
__namedParameters.fontSize	undefined | number
__namedParameters.startX	undefined | number
__namedParameters.startY	undefined | number

Returns

Blueprints

Defined in

text.ts:87

---

Drawing Functions

draw

▸ draw(): DrawingPen

Returns

DrawingPen

Defined in

draw.ts:135

---

drawCircle

▸ drawCircle(radius): Drawing

Parameters

Name	Type
radius	number

Returns

Drawing

Defined in

draw.ts:190

---

drawEllipse

▸ drawEllipse(majorRadius, minorRadius): Drawing

Parameters

Name	Type
majorRadius	number
minorRadius	number

Returns

Drawing

Defined in

draw.ts:205

---

drawParametricFunction

▸ Const drawParametricFunction(func, __namedParameters?, approximationConfig?): Drawing

Parameters

Name	Type
func	(t: number) => Point2D
__namedParameters	Object
__namedParameters.pointsCount	undefined | number
__namedParameters.start	undefined | number
__namedParameters.stop	undefined | number
approximationConfig	BSplineApproximationConfig

Returns

Drawing

Defined in

draw.ts:269

---

drawPointsInterpolation

▸ Const drawPointsInterpolation(points, approximationConfig?): Drawing

Parameters

Name	Type
points	Point2D[]
approximationConfig	BSplineApproximationConfig

Returns

Drawing

Defined in

draw.ts:252

---

drawPolysides

▸ drawPolysides(radius, sidesCount, sagitta?): Drawing

Parameters

Name	Type	Default value
radius	number	undefined
sidesCount	number	undefined
sagitta	number	0

Returns

Drawing

Defined in

draw.ts:221

---

drawRoundedRectangle

▸ drawRoundedRectangle(width, height, r?): Drawing

Parameters

Name	Type	Default value
width	number	undefined
height	number	undefined
r	number | { rx?: number ; ry?: number }	0

Returns

Drawing

Defined in

draw.ts:146

---

drawSingleCircle

▸ drawSingleCircle(radius): Drawing

Parameters

Name	Type
radius	number

Returns

Drawing

Defined in

draw.ts:162

---

drawSingleEllipse

▸ drawSingleEllipse(majorRadius, minorRadius): Drawing

Parameters

Name	Type
majorRadius	number
minorRadius	number

Returns

Drawing

Defined in

draw.ts:173

---

drawText

▸ drawText(text, __namedParameters?): Drawing

Parameters

Name	Type
text	string
__namedParameters	Object
__namedParameters.fontFamily	undefined | string
__namedParameters.fontSize	undefined | number
__namedParameters.startX	undefined | number
__namedParameters.startY	undefined | number

Returns

Drawing

Defined in

draw.ts:235

---

Import Functions

importSTEP

▸ importSTEP(STLBlob): Promise<AnyShape>

Parameters

Name	Type
STLBlob	Blob

Returns

Promise<AnyShape>

Defined in

importers.ts:13

---

importSTL

▸ importSTL(STLBlob): Promise<AnyShape>

Parameters

Name	Type
STLBlob	Blob

Returns

Promise<AnyShape>

Defined in

importers.ts:47

---

Other Functions

GCWithObject

▸ Const GCWithObject(obj): <Type>(value: Type) => Type

Parameters

Name	Type
obj	any

Returns

fn

▸ <Type>(value): Type

Type parameters

Name	Type
Type	extends Deletable

Parameters

Name	Type
value	Type

Returns

Type

Defined in

register.ts:70

---

GCWithScope

▸ Const GCWithScope(): <Type>(value: Type) => Type

Returns

fn

▸ <Type>(value): Type

Type parameters

Name	Type
Type	extends Deletable

Parameters

Name	Type
value	Type

Returns

Type

Defined in

register.ts:61

---

addHolesInFace

▸ Const addHolesInFace(face, holes): Face

Parameters

Name	Type
face	Face
holes	Wire[]

Returns

Face

Defined in

shapeHelpers.ts:463

---

asDir

▸ asDir(coords): gp_Dir

Parameters

Name	Type
coords	Point

Returns

gp_Dir

Defined in

geom.ts:212

---

asPnt

▸ asPnt(coords): gp_Pnt

Parameters

Name	Type
coords	Point

Returns

gp_Pnt

Defined in

geom.ts:205

---

assembleWire

▸ Const assembleWire(listOfEdges): Wire

Parameters

Name	Type
listOfEdges	(Edge | Wire)[]

Returns

Wire

Defined in

shapeHelpers.ts:264

---

axis2d

▸ Const axis2d(point, direction): gp_Ax2d

Parameters

Name	Type
point	Point2D
direction	Point2D

Returns

gp_Ax2d

Defined in

lib2d.ts:105

---

basicFaceExtrusion

▸ Const basicFaceExtrusion(face, extrusionVec): Solid

Parameters

Name	Type
face	Face
extrusionVec	Vector

Returns

Solid

Defined in

addThickness.ts:24

---

cast

▸ cast(shape): AnyShape

Parameters

Name	Type
shape	TopoDS_Shape

Returns

AnyShape

Defined in

shapes.ts:1270

---

combineFinderFilters

▸ Const combineFinderFilters<Type>(filters): [(v: Type) => number, () => void]

Type parameters

Name	Type
Type	extends FaceOrEdge

Parameters

Name	Type
filters	{ filter: Finder<Type> ; radius: number }[]

Returns

[(v: Type) => number, () => void]

Defined in

finders.ts:465

---

complexExtrude

▸ complexExtrude(wire, center, normal, profileShape, shellMode): [Shape3D, Wire, Wire]

Parameters

Name	Type
wire	Wire
center	Point
normal	Point
profileShape	undefined | ExtrusionProfile
shellMode	true

Returns

[Shape3D, Wire, Wire]

Defined in

addThickness.ts:192

▸ complexExtrude(wire, center, normal, profileShape?, shellMode?): Shape3D

Parameters

Name	Type
wire	Wire
center	Point
normal	Point
profileShape?	ExtrusionProfile
shellMode?	false

Returns

Shape3D

Defined in

addThickness.ts:199

---

compoundShapes

▸ Const compoundShapes(shapeArray): AnyShape

Parameters

Name	Type
shapeArray	AnyShape[]

Returns

AnyShape

Defined in

shapeHelpers.ts:423

---

createNamedPlane

▸ Const createNamedPlane(plane, sourceOrigin?): Plane

Parameters

Name	Type
plane	PlaneName
sourceOrigin	number | Point

Returns

Plane

Defined in

geom.ts:537

---

cut2D

▸ Const cut2D(first, second): null | Blueprint | CompoundBlueprint | Blueprints

Parameters

Name	Type
first	Shape2D
second	Shape2D

Returns

null | Blueprint | CompoundBlueprint | Blueprints

Defined in

blueprints/boolean2D.ts:225

---

cutBlueprints

▸ Const cutBlueprints(first, second): null | Blueprint | Blueprints

Parameters

Name	Type
first	Blueprint
second	Blueprint

Returns

null | Blueprint | Blueprints

Defined in

blueprints/booleanOperations.ts:381

---

downcast

▸ downcast(shape): GenericTopo

Parameters

Name	Type
shape	TopoDS_Shape

Returns

GenericTopo

Defined in

shapes.ts:1250

---

drawRectangle

▸ Const drawRectangle(width, height, r?): Drawing

Parameters

Name	Type	Default value
width	number	undefined
height	number	undefined
r	number | { rx?: number ; ry?: number }	0

Returns

Drawing

Defined in

draw.ts:153

---

fuse2D

▸ Const fuse2D(first, second): null | Blueprint | CompoundBlueprint | Blueprints

Parameters

Name	Type
first	Shape2D
second	Shape2D

Returns

null | Blueprint | CompoundBlueprint | Blueprints

Defined in

blueprints/boolean2D.ts:158

---

fuseBlueprints

▸ Const fuseBlueprints(first, second): null | Blueprint | Blueprints

Parameters

Name	Type
first	Blueprint
second	Blueprint

Returns

null | Blueprint | Blueprints

Defined in

blueprints/booleanOperations.ts:350

---

genericSweep

▸ genericSweep(wire, spine, sweepConfig, shellMode): [Shape3D, Wire, Wire]

Parameters

Name	Type
wire	Wire
spine	Wire
sweepConfig	GenericSweepConfig
shellMode	true

Returns

[Shape3D, Wire, Wire]

Defined in

addThickness.ts:71

▸ genericSweep(wire, spine, sweepConfig, shellMode?): Shape3D

Parameters

Name	Type
wire	Wire
spine	Wire
sweepConfig	GenericSweepConfig
shellMode?	false

Returns

Shape3D

Defined in

addThickness.ts:77

---

getFont

▸ Const getFont(fontFamily?): Font

Parameters

Name	Type	Default value
fontFamily	string	"default"

Returns

Font

Defined in

text.ts:26

---

getOC

▸ Const getOC(): OpenCascadeInstance

Returns

OpenCascadeInstance

Defined in

oclib.ts:11

---

intersectBlueprints

▸ Const intersectBlueprints(first, second): null | Blueprint | Blueprints

Parameters

Name	Type
first	Blueprint
second	Blueprint

Returns

null | Blueprint | Blueprints

Defined in

blueprints/booleanOperations.ts:412

---

isShape3D

▸ isShape3D(shape): shape is Shape3D

Parameters

Name	Type
shape	AnyShape

Returns

shape is Shape3D

Defined in

shapes.ts:1237

---

isWire

▸ isWire(shape): shape is Wire

Parameters

Name	Type
shape	AnyShape

Returns

shape is Wire

Defined in

shapes.ts:1246

---

iterTopo

▸ Const iterTopo(shape, topo): IterableIterator<TopoDS_Shape>

Parameters

Name	Type
shape	TopoDS_Shape
topo	TopoEntity

Returns

IterableIterator<TopoDS_Shape>

Defined in

shapes.ts:109

---

loadFont

▸ Const loadFont(fontPath, fontFamily?): Promise<Font>

Parameters

Name	Type	Default value
fontPath	string	undefined
fontFamily	string	"default"

Returns

Promise<Font>

Defined in

text.ts:17

---

localGC

▸ Const localGC(debug?): [<T>(v: T) => T, () => void, undefined | Set<Deletable>]

Parameters

Name	Type
debug?	boolean

Returns

[<T>(v: T) => T, () => void, undefined | Set<Deletable>]

Defined in

register.ts:79

---

loft

▸ Const loft(wires, __namedParameters?, returnShell?): Shape3D

Parameters

Name	Type	Default value
wires	Wire[]	undefined
__namedParameters	LoftConfig	{}
returnShell	boolean	false

Returns

Shape3D

Defined in

addThickness.ts:293

---

makeAx1

▸ Const makeAx1(center, dir): gp_Ax1

Parameters

Name	Type
center	Point
dir	Point

Returns

gp_Ax1

Defined in

geom.ts:64

---

makeAx2

▸ Const makeAx2(center, dir, xDir?): gp_Ax2

Parameters

Name	Type
center	Point
dir	Point
xDir?	Point

Returns

gp_Ax2

Defined in

geom.ts:46

---

makeAx3

▸ Const makeAx3(center, dir, xDir?): gp_Ax3

Parameters

Name	Type
center	Point
dir	Point
xDir?	Point

Returns

gp_Ax3

Defined in

geom.ts:28

---

makeBSplineApproximation

▸ Const makeBSplineApproximation(points, __namedParameters?): Edge

Parameters

Name	Type
points	Point[]
__namedParameters	BSplineApproximationConfig

Returns

Edge

Defined in

shapeHelpers.ts:166

---

makeBaseBox

▸ Const makeBaseBox(xLength, yLength, zLength): Shape3D

Parameters

Name	Type
xLength	number
yLength	number
zLength	number

Returns

Shape3D

Defined in

shortcuts.ts:4

---

makeBezierCurve

▸ Const makeBezierCurve(points): Edge

Parameters

Name	Type
points	Point[]

Returns

Edge

Defined in

shapeHelpers.ts:223

---

makeCircle

▸ Const makeCircle(radius, center?, normal?): Edge

Parameters

Name	Type
radius	number
center	Point
normal	Point

Returns

Edge

Defined in

shapeHelpers.ts:27

---

makeCompound

▸ Const makeCompound(shapeArray): AnyShape

Parameters

Name	Type
shapeArray	AnyShape[]

Returns

AnyShape

Defined in

shapeHelpers.ts:438

---

makeCylinder

▸ Const makeCylinder(radius, height, location?, direction?): Solid

Parameters

Name	Type
radius	number
height	number
location	Point
direction	Point

Returns

Solid

Defined in

shapeHelpers.ts:363

---

makeDirection

▸ makeDirection(p): Point

Parameters

Name	Type
p	Direction

Returns

Point

Defined in

geom.ts:198

---

makeEllipse

▸ Const makeEllipse(majorRadius, minorRadius, center?, normal?, xDir?): Edge

Parameters

Name	Type
majorRadius	number
minorRadius	number
center	Point
normal	Point
xDir?	Point

Returns

Edge

Defined in

shapeHelpers.ts:45

---

makeEllipseArc

▸ Const makeEllipseArc(majorRadius, minorRadius, startAngle, endAngle, center?, normal?, xDir?): Edge

Parameters

Name	Type
majorRadius	number
minorRadius	number
startAngle	number
endAngle	number
center	Point
normal	Point
xDir?	Point

Returns

Edge

Defined in

shapeHelpers.ts:132

---

makeFace

▸ Const makeFace(wire): Face

Parameters

Name	Type
wire	Wire

Returns

Face

Defined in

shapeHelpers.ts:300

---

makeHelix

▸ Const makeHelix(pitch, height, radius, center?, dir?, lefthand?): Edge

Parameters

Name	Type	Default value
pitch	number	undefined
height	number	undefined
radius	number	undefined
center	Point	undefined
dir	Point	undefined
lefthand	boolean	false

Returns

Edge

Defined in

shapeHelpers.ts:68

---

makeLine

▸ Const makeLine(v1, v2): Edge

Parameters

Name	Type
v1	Point
v2	Point

Returns

Edge

Defined in

shapeHelpers.ts:20

---

makeNewFaceWithinFace

▸ Const makeNewFaceWithinFace(originFace, wire): Face

Parameters

Name	Type
originFace	Face
wire	Wire

Returns

Face

Defined in

shapeHelpers.ts:313

---

makeNonPlanarFace

▸ Const makeNonPlanarFace(wire): Face

Parameters

Name	Type
wire	Wire

Returns

Face

Defined in

shapeHelpers.ts:326

---

makeOffset

▸ Const makeOffset(face, offset, tolerance?): Shape3D

Parameters

Name	Type	Default value
face	Face	undefined
offset	number	undefined
tolerance	number	1e-6

Returns

Shape3D

Defined in

shapeHelpers.ts:399

---

makePlane

▸ makePlane(plane): Plane

Parameters

Name	Type
plane	Plane

Returns

Plane

Defined in

geomHelpers.ts:30

▸ makePlane(plane?, origin?): Plane

Parameters

Name	Type
plane?	PlaneName
origin?	number | Point

Returns

Plane

Defined in

geomHelpers.ts:31

---

makePlaneFromFace

▸ Const makePlaneFromFace(face, originOnSurface?): Plane

Parameters

Name	Type
face	Face
originOnSurface	Point2D

Returns

Plane

Defined in

geomHelpers.ts:13

---

makePolygon

▸ Const makePolygon(points): Face

Parameters

Name	Type
points	Point[]

Returns

Face

Defined in

shapeHelpers.ts:482

---

makeSolid

▸ makeSolid(facesOrShells): Solid

Parameters

Name	Type
facesOrShells	(Face | Shell)[]

Returns

Solid

Defined in

shapeHelpers.ts:440

---

makeSphere

▸ Const makeSphere(radius): Solid

Parameters

Name	Type
radius	number

Returns

Solid

Defined in

shapeHelpers.ts:379

---

makeTangentArc

▸ Const makeTangentArc(startPoint, startTgt, endPoint): Edge

Parameters

Name	Type
startPoint	Point
startTgt	Point
endPoint	Point

Returns

Edge

Defined in

shapeHelpers.ts:235

---

makeThreePointArc

▸ Const makeThreePointArc(v1, v2, v3): Edge

Parameters

Name	Type
v1	Point
v2	Point
v3	Point

Returns

Edge

Defined in

shapeHelpers.ts:120

---

makeVertex

▸ Const makeVertex(point): Vertex

Parameters

Name	Type
point	Point

Returns

Vertex

Defined in

shapeHelpers.ts:388

---

mirror

▸ mirror(shape, inputPlane, origin): TopoDS_Shape

Parameters

Name	Type
shape	TopoDS_Shape
inputPlane	Plane | PlaneName | Point
origin	Point

Returns

TopoDS_Shape

Defined in

geomHelpers.ts:66

---

organiseBlueprints

▸ Const organiseBlueprints(blueprints): Blueprints

Parameters

Name	Type
blueprints	Blueprint[]

Returns

Blueprints

Defined in

blueprints/lib.ts:121

---

polysideInnerRadius

▸ Const polysideInnerRadius(outerRadius, sidesCount, sagitta?): number

Parameters

Name	Type	Default value
outerRadius	number	undefined
sidesCount	number	undefined
sagitta	number	0

Returns

number

Defined in

sketches/cannedSketches.ts:163

---

polysidesBlueprint

▸ Const polysidesBlueprint(radius, sidesCount, sagitta?): Blueprint

Parameters

Name	Type	Default value
radius	number	undefined
sidesCount	number	undefined
sagitta	number	0

Returns

Blueprint

Defined in

blueprints/cannedBlueprints.ts:4

---

revolution

▸ Const revolution(face, center?, direction?, angle?): Shape3D

Parameters

Name	Type	Default value
face	Face	undefined
center	Point	undefined
direction	Point	undefined
angle	number	360

Returns

Shape3D

Defined in

addThickness.ts:37

---

rotate

▸ rotate(shape, angle, position?, direction?): TopoDS_Shape

Parameters

Name	Type
shape	TopoDS_Shape
angle	number
position	Point
direction	Point

Returns

TopoDS_Shape

Defined in

geomHelpers.ts:45

---

roundedRectangleBlueprint

▸ Const roundedRectangleBlueprint(width, height, r?): Blueprint

Parameters

Name	Type	Default value
width	number	undefined
height	number	undefined
r	number | { rx?: number ; ry?: number }	0

Returns

Blueprint

Defined in

blueprints/cannedBlueprints.ts:29

---

scale

▸ scale(shape, center, scale): TopoDS_Shape

Parameters

Name	Type
shape	TopoDS_Shape
center	Point
scale	number

Returns

TopoDS_Shape

Defined in

geomHelpers.ts:78

---

setOC

▸ Const setOC(oc): void

Parameters

Name	Type
oc	OpenCascadeInstance

Returns

void

Defined in

oclib.ts:7

---

shapeType

▸ Const shapeType(shape): TopAbs_ShapeEnum

Parameters

Name	Type
shape	TopoDS_Shape

Returns

TopAbs_ShapeEnum

Defined in

shapes.ts:145

---

supportExtrude

▸ Const supportExtrude(wire, center, normal, support): Shape3D

Parameters

Name	Type
wire	Wire
center	Point
normal	Point
support	TopoDS_Shape

Returns

Shape3D

Defined in

addThickness.ts:177

---

translate

▸ translate(shape, vector): TopoDS_Shape

Parameters

Name	Type
shape	TopoDS_Shape
vector	Point

Returns

TopoDS_Shape

Defined in

geomHelpers.ts:58

---

twistExtrude

▸ twistExtrude(wire, angleDegrees, center, normal, profileShape?, shellMode?): Shape3D

Parameters

Name	Type
wire	Wire
angleDegrees	number
center	Point
normal	Point
profileShape?	ExtrusionProfile
shellMode?	false

Returns

Shape3D

Defined in

addThickness.ts:233

▸ twistExtrude(wire, angleDegrees, center, normal, profileShape, shellMode): [Shape3D, Wire, Wire]

Parameters

Name	Type
wire	Wire
angleDegrees	number
center	Point
normal	Point
profileShape	undefined | ExtrusionProfile
shellMode	true

Returns

[Shape3D, Wire, Wire]

Defined in

addThickness.ts:241

---

Sketching Functions

sketchCircle

▸ Const sketchCircle(radius, planeConfig?): Sketch

Parameters

Name	Type
radius	number
planeConfig	PlaneConfig

Returns

Sketch

Defined in

sketches/cannedSketches.ts:27

---

sketchEllipse

▸ Const sketchEllipse(xRadius?, yRadius?, planeConfig?): Sketch

Parameters

Name	Type	Default value
xRadius	number	1
yRadius	number	2
planeConfig	PlaneConfig	{}

Returns

Sketch

Defined in

sketches/cannedSketches.ts:50

---

sketchFaceOffset

▸ Const sketchFaceOffset(face, offset): Sketch

Parameters

Name	Type
face	Face
offset	number

Returns

Sketch

Defined in

sketches/cannedSketches.ts:182

---

sketchParametricFunction

▸ Const sketchParametricFunction(func, planeConfig?, __namedParameters?, approximationConfig?): Sketch

Parameters

Name	Type
func	(t: number) => Point2D
planeConfig	PlaneConfig
__namedParameters	Object
__namedParameters.pointsCount	undefined | number
__namedParameters.start	undefined | number
__namedParameters.stop	undefined | number
approximationConfig	BSplineApproximationConfig

Returns

Sketch

Defined in

sketches/cannedSketches.ts:201

---

sketchPolysides

▸ Const sketchPolysides(radius, sidesCount, sagitta?, planeConfig?): Sketch

Parameters

Name	Type	Default value
radius	number	undefined
sidesCount	number	undefined
sagitta	number	0
planeConfig	PlaneConfig	{}

Returns

Sketch

Defined in

sketches/cannedSketches.ts:129

---

sketchRectangle

▸ Const sketchRectangle(xLength, yLength, planeConfig?): Sketch

Parameters

Name	Type
xLength	number
yLength	number
planeConfig	PlaneConfig

Returns

Sketch

Defined in

sketches/cannedSketches.ts:88

---

sketchRoundedRectangle

▸ Const sketchRoundedRectangle(width, height, r?, planeConfig?): Sketch

Parameters

Name	Type	Default value
width	number	undefined
height	number	undefined
r	number | { rx?: number ; ry?: number }	0
planeConfig	PlaneConfig	{}

Returns

Sketch

Defined in

sketches/cannedSketches.ts:111

---

sketchText

▸ sketchText(text, textConfig?, planeConfig?): Sketches

Parameters

Name	Type
text	string
textConfig?	Object
textConfig.fontFamily?	"string"
textConfig.fontSize?	number
textConfig.startX?	number
textConfig.startY?	number
planeConfig	Object
planeConfig.origin?	number | Point
planeConfig.plane?	Plane | PlaneName

Returns

Sketches

Defined in

text.ts:103