Class Sketcher

Build 2D wire profiles on a 3D plane using a builder-pen API.

The Sketcher converts relative/absolute 2D drawing commands into 3D edges projected onto the chosen plane, then assembles them into a Sketch.

Example

const sketch = new Sketcher("XZ", 5)
  .hLine(20)
  .vLine(10)
  .hLine(-20)
  .close();
const solid = sketch.extrude(8);

See

FaceSketcher for sketching on non-planar surfaces.
DrawingPen for the pure-2D equivalent.

Implements

GenericSketcher<Sketch>

Constructors

constructor

new Sketcher(plane: Plane): Sketcher
The sketcher can be defined by a plane, or a simple plane definition, with either a point of origin, or the position on the normal axis from the coordinates origin
Parameters
- plane: Plane
Returns Sketcher
- Defined in src/sketching/Sketcher.ts:78
new Sketcher(plane?: PlaneName, origin?: number | PointInput): Sketcher
Parameters
- Optionalplane: PlaneName
- Optionalorigin: number | PointInput
Returns Sketcher
- Defined in src/sketching/Sketcher.ts:79

Properties

`Protected`_mirrorWire

_mirrorWire: boolean

`Protected`firstPoint

firstPoint: Vec3

`Protected`pendingEdges

pendingEdges: Edge[]

`Protected`plane

plane: Plane

`Protected`pointer

pointer: Vec3

Methods

`Protected`_closeSketch

_closeSketch(): void
Returns void
- Defined in src/sketching/Sketcher.ts:504

`Protected`_mirrorWireOnStartEnd

_mirrorWireOnStartEnd(wire: Wire): Wire
Parameters
- wire: Wire
Returns Wire
- Defined in src/sketching/Sketcher.ts:477

`Protected`_updatePointer

_updatePointer(newPointer: Vec3): void
Parameters
- newPointer: Vec3
Returns void
- Defined in src/sketching/Sketcher.ts:100

bezierCurveTo

bezierCurveTo(end: Point2D, controlPoints: Point2D | Point2D[]): this
Draw a Bezier curve to an absolute end point through one or more control points.
Parameters
- end: Point2D
- controlPoints: Point2D | Point2D[]
Returns this
Implementation of GenericSketcher.bezierCurveTo
- Defined in src/sketching/Sketcher.ts:381

`Protected`buildWire

buildWire(): Wire
Returns Wire
- Defined in src/sketching/Sketcher.ts:492

bulgeArc

bulgeArc(xDist: number, yDist: number, bulge: number): this
Draw an arc to a relative end point using a bulge factor.
Parameters
- xDist: number
- yDist: number
- bulge: number
Returns this
Implementation of GenericSketcher.bulgeArc
- Defined in src/sketching/Sketcher.ts:271

bulgeArcTo

bulgeArcTo(end: Point2D, bulge: number): this
Draw an arc to an absolute end point using a bulge factor (sagitta as fraction of half-chord).
Parameters
- end: Point2D
- bulge: number
Returns this
Implementation of GenericSketcher.bulgeArcTo
- Defined in src/sketching/Sketcher.ts:261

close

close(): Sketch
Close the path with a straight line to the start point and return the Sketch.

Returns Sketch
Implementation of GenericSketcher.close
- Defined in src/sketching/Sketcher.ts:521

closeWithMirror

closeWithMirror(): Sketch
Close the path by mirroring all edges about the line from first to last point.

Returns Sketch
Implementation of GenericSketcher.closeWithMirror
- Defined in src/sketching/Sketcher.ts:527

cubicBezierCurveTo

cubicBezierCurveTo(
    end: Point2D,
    startControlPoint: Point2D,
    endControlPoint: Point2D,
): this
Draw a cubic Bezier curve to an absolute end point with start and end control points.
Parameters
- end: Point2D
- startControlPoint: Point2D
- endControlPoint: Point2D
Returns this
Implementation of GenericSketcher.cubicBezierCurveTo
- Defined in src/sketching/Sketcher.ts:404

delete

delete(): void
Release all OCCT edges held by this sketcher.

Returns void
- Defined in src/sketching/Sketcher.ts:92

done

done(): Sketch
Finish drawing and return the open-wire Sketch (does not close the path).

Returns Sketch
Implementation of GenericSketcher.done
- Defined in src/sketching/Sketcher.ts:512

ellipse

ellipse(
    xDist: number,
    yDist: number,
    horizontalRadius: number,
    verticalRadius: number,
    rotation?: number,
    longAxis?: boolean,
    sweep?: boolean,
): this
Draw an elliptical arc to a relative end point (SVG-style parameters).
Parameters
- xDist: number
- yDist: number
- horizontalRadius: number
- verticalRadius: number
- rotation: number = 0
- longAxis: boolean = false
- sweep: boolean = false
Returns this
Implementation of GenericSketcher.ellipse
- Defined in src/sketching/Sketcher.ts:343

ellipseTo

ellipseTo(
    end: Point2D,
    horizontalRadius: number,
    verticalRadius: number,
    rotation?: number,
    longAxis?: boolean,
    sweep?: boolean,
): this
Draw an elliptical arc to an absolute end point (SVG-style parameters).
Parameters
- end: Point2D
- horizontalRadius: number
- verticalRadius: number
- rotation: number = 0
- longAxis: boolean = false
- sweep: boolean = false
Returns this
Implementation of GenericSketcher.ellipseTo
- Defined in src/sketching/Sketcher.ts:287

halfEllipse

halfEllipse(
    xDist: number,
    yDist: number,
    verticalRadius: number,
    sweep?: boolean,
): this
Draw a half-ellipse arc to a relative end point with a given minor radius.
Parameters
- xDist: number
- yDist: number
- verticalRadius: number
- sweep: boolean = false
Returns this
Implementation of GenericSketcher.halfEllipse
- Defined in src/sketching/Sketcher.ts:375

halfEllipseTo

halfEllipseTo(end: Point2D, verticalRadius: number, sweep?: boolean): this
Draw a half-ellipse arc to an absolute end point with a given minor radius.
Parameters
- end: Point2D
- verticalRadius: number
- sweep: boolean = false
Returns this
Implementation of GenericSketcher.halfEllipseTo
- Defined in src/sketching/Sketcher.ts:364

hBulgeArc

hBulgeArc(distance: number, bulge: number): this
Draw a horizontal bulge arc of the given distance and bulge factor.
Parameters
- distance: number
- bulge: number
Returns this
Implementation of GenericSketcher.hBulgeArc
- Defined in src/sketching/Sketcher.ts:282

hLine

hLine(distance: number): this
Draw a horizontal line of the given signed distance.
Parameters
- distance: number
Returns this
Implementation of GenericSketcher.hLine
- Defined in src/sketching/Sketcher.ts:133

hLineTo

hLineTo(xPos: number): this
Draw a horizontal line to an absolute X coordinate.
Parameters
- xPos: number
Returns this
Implementation of GenericSketcher.hLineTo
- Defined in src/sketching/Sketcher.ts:144

hSagittaArc

hSagittaArc(distance: number, sagitta: number): this
Draw a horizontal sagitta arc of the given distance and bulge.
Parameters
- distance: number
- sagitta: number
Returns this
Implementation of GenericSketcher.hSagittaArc
- Defined in src/sketching/Sketcher.ts:256

line

line(xDist: number, yDist: number): this
Draw a straight line by relative horizontal and vertical distances.
Parameters
- xDist: number
- yDist: number
Returns this
Implementation of GenericSketcher.line
- Defined in src/sketching/Sketcher.ts:122

lineTo

lineTo(__namedParameters: Point2D): this
Draw a straight line to an absolute 2D point on the sketch plane.
Parameters
- __namedParameters: Point2D
Returns this
Implementation of GenericSketcher.lineTo
- Defined in src/sketching/Sketcher.ts:114

movePointerTo

movePointerTo(__namedParameters: Point2D): this
Move the pen to an absolute 2D position before drawing any edges.
Parameters
- __namedParameters: Point2D
Returns this
Implementation of GenericSketcher.movePointerTo
- Defined in src/sketching/Sketcher.ts:105

polarLine

polarLine(distance: number, angle: number): this
Draw a line in polar coordinates (distance and angle in degrees) from the current point.
Parameters
- distance: number
- angle: number
Returns this
Implementation of GenericSketcher.polarLine
- Defined in src/sketching/Sketcher.ts:150

polarLineTo

polarLineTo(__namedParameters: [number, number]): this
Draw a line to a point given in polar coordinates [r, theta] from the origin.
Parameters
- __namedParameters: [number, number]
Returns this
Implementation of GenericSketcher.polarLineTo
- Defined in src/sketching/Sketcher.ts:157

quadraticBezierCurveTo

quadraticBezierCurveTo(end: Point2D, controlPoint: Point2D): this
Draw a quadratic Bezier curve to an absolute end point with a single control point.
Parameters
- end: Point2D
- controlPoint: Point2D
Returns this
Implementation of GenericSketcher.quadraticBezierCurveTo
- Defined in src/sketching/Sketcher.ts:399

sagittaArc

sagittaArc(xDist: number, yDist: number, sagitta: number): this
Draw a circular arc to a relative end point, bulging by the given sagitta.
Parameters
- xDist: number
- yDist: number
- sagitta: number
Returns this
Implementation of GenericSketcher.sagittaArc
- Defined in src/sketching/Sketcher.ts:245

sagittaArcTo

sagittaArcTo(end: Point2D, sagitta: number): this
Draw a circular arc to an absolute end point, bulging by the given sagitta.
Parameters
- end: Point2D
- sagitta: number
Returns this
Implementation of GenericSketcher.sagittaArcTo
- Defined in src/sketching/Sketcher.ts:223

smoothSpline

smoothSpline(xDist: number, yDist: number, splineConfig?: SplineOptions): this
Draw a smooth cubic Bezier spline to a relative end point, blending tangent with the previous edge.
Parameters
- xDist: number
- yDist: number
- splineConfig: SplineOptions = {}
Returns this
Implementation of GenericSketcher.smoothSpline
- Defined in src/sketching/Sketcher.ts:472

smoothSplineTo

smoothSplineTo(end: Point2D, config?: SplineOptions): this
Draw a smooth cubic Bezier spline to an absolute end point, blending tangent with the previous edge.
Parameters
- end: Point2D
- Optionalconfig: SplineOptions
Returns this
Implementation of GenericSketcher.smoothSplineTo
- Defined in src/sketching/Sketcher.ts:409

tangentArc

tangentArc(xDist: number, yDist: number): this
Draw a circular arc tangent to the previous edge, ending at a relative offset.
Parameters
- xDist: number
- yDist: number
Returns this
Implementation of GenericSketcher.tangentArc
- Defined in src/sketching/Sketcher.ts:217

tangentArcTo

tangentArcTo(end: Point2D): this
Draw a circular arc tangent to the previous edge, ending at an absolute point.
Parameters
- end: Point2D
Returns this
Implementation of GenericSketcher.tangentArcTo
- Defined in src/sketching/Sketcher.ts:199

tangentLine

tangentLine(distance: number): this
Draw a line tangent to the previous edge, extending by the given distance.
Parameters
- distance: number
Returns this
Implementation of GenericSketcher.tangentLine
- Defined in src/sketching/Sketcher.ts:164

threePointsArc

threePointsArc(
    xDist: number,
    yDist: number,
    viaXDist: number,
    viaYDist: number,
): this
Draw a circular arc through a via-point to an end point, both given as relative distances.
Parameters
- xDist: number
- yDist: number
- viaXDist: number
- viaYDist: number
Returns this
Implementation of GenericSketcher.threePointsArc
- Defined in src/sketching/Sketcher.ts:193

threePointsArcTo

threePointsArcTo(end: Point2D, innerPoint: Point2D): this
Draw a circular arc passing through an inner point to an absolute end point.
Parameters
- end: Point2D
- innerPoint: Point2D
Returns this
Implementation of GenericSketcher.threePointsArcTo
- Defined in src/sketching/Sketcher.ts:182

vBulgeArc

vBulgeArc(distance: number, bulge: number): this
Draw a vertical bulge arc of the given distance and bulge factor.
Parameters
- distance: number
- bulge: number
Returns this
Implementation of GenericSketcher.vBulgeArc
- Defined in src/sketching/Sketcher.ts:277

vLine

vLine(distance: number): this
Draw a vertical line of the given signed distance.
Parameters
- distance: number
Returns this
Implementation of GenericSketcher.vLine
- Defined in src/sketching/Sketcher.ts:128

vLineTo

vLineTo(yPos: number): this
Draw a vertical line to an absolute Y coordinate.
Parameters
- yPos: number
Returns this
Implementation of GenericSketcher.vLineTo
- Defined in src/sketching/Sketcher.ts:138

vSagittaArc

vSagittaArc(distance: number, sagitta: number): this
Draw a vertical sagitta arc of the given distance and bulge.
Parameters
- distance: number
- sagitta: number
Returns this
Implementation of GenericSketcher.vSagittaArc
- Defined in src/sketching/Sketcher.ts:251

Class Sketcher

Example

See

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Sketcher

Parameters

Returns Sketcher

Properties

Protected_mirrorWire

ProtectedfirstPoint

ProtectedpendingEdges

Protectedplane

Protectedpointer

Methods

Protected_closeSketch

Returns void

Protected_mirrorWireOnStartEnd

Parameters

Returns Wire

Protected_updatePointer

Parameters

Returns void

bezierCurveTo

Parameters

Returns this

ProtectedbuildWire

Returns Wire

bulgeArc

Parameters

Returns this

bulgeArcTo

Parameters

Returns this

close

Returns Sketch

closeWithMirror

Returns Sketch

cubicBezierCurveTo

Parameters

Returns this

delete

Returns void

done

Returns Sketch

ellipse

Parameters

Returns this

ellipseTo

Parameters

Returns this

halfEllipse

Parameters

Returns this

halfEllipseTo

Parameters

Returns this

hBulgeArc

Parameters

Returns this

hLine

Parameters

Returns this

hLineTo

Parameters

Returns this

hSagittaArc

Parameters

Returns this

line

Parameters

Returns this

lineTo

Parameters

`Protected`_mirrorWire

`Protected`firstPoint

`Protected`pendingEdges

`Protected`plane

`Protected`pointer

`Protected`_closeSketch

`Protected`_mirrorWireOnStartEnd

`Protected`_updatePointer

`Protected`buildWire