Skip to main content

Class: BaseSketcher2d

Defined in: Sketcher2d.ts:63

Extended by​

Constructors​

Constructor​

new BaseSketcher2d(origin): BaseSketcher2d;

Defined in: Sketcher2d.ts:69

Parameters​

origin​

Point2D = ...

Returns​

BaseSketcher2d

Drawing State​

penPosition​

Get Signature​

get penPosition(): Point2D;

Defined in: Sketcher2d.ts:92

Returns the current pen position as [x, y] coordinates

Added By Ben Harper 5/12/2025

Returns​

Point2D

Drawing State​

Added By Ben Harper 5/12/2025 to solve issue with being unable to draw a line perpendicular to the tangent extension at the end of a .tangentArc() that did not finish at a known angle.

penAngle​

Get Signature​

get penAngle(): number;

Defined in: Sketcher2d.ts:108

Returns the current pen angle in degrees

The angle represents the tangent direction at the current pen position, based on the last drawing operation (line, arc, bezier, etc.). Returns 0 if nothing has been drawn yet.

Returns​

number

Other​

bezierCurveTo()​

bezierCurveTo(end, controlPoints): this;

Defined in: Sketcher2d.ts:425

Parameters​

end​

Point2D

controlPoints​

Point2D | Point2D[]

Returns​

this

bulgeArc()​

bulgeArc(
   xDist, 
   yDist, 
   bulge): this;

Defined in: Sketcher2d.ts:273

Parameters​

xDist​

number

yDist​

number

bulge​

number

Returns​

this

bulgeArcTo()​

bulgeArcTo(end, bulge): this;

Defined in: Sketcher2d.ts:265

Parameters​

end​

Point2D

bulge​

number

Returns​

this

cubicBezierCurveTo()​

cubicBezierCurveTo(
   end, 
   startControlPoint, 
   endControlPoint): this;

Defined in: Sketcher2d.ts:449

Parameters​

end​

Point2D

startControlPoint​

Point2D

endControlPoint​

Point2D

Returns​

this

customCorner()​

customCorner(radius, mode): BaseSketcher2d;

Defined in: Sketcher2d.ts:512

Changes the corner between the previous and next segments.

Parameters​

radius​

number | (first, second) => Curve2D[]

mode​

"chamfer" | "fillet"

Returns​

BaseSketcher2d

ellipse()​

ellipse(
   xDist, 
   yDist, 
   horizontalRadius, 
   verticalRadius, 
   rotation, 
   longAxis, 
   sweep): this;

Defined in: Sketcher2d.ts:381

Parameters​

xDist​

number

yDist​

number

horizontalRadius​

number

verticalRadius​

number

rotation​

number = 0

longAxis​

boolean = false

sweep​

boolean = false

Returns​

this

ellipseTo()​

ellipseTo(
   end, 
   horizontalRadius, 
   verticalRadius, 
   rotation, 
   longAxis, 
   sweep): this;

Defined in: Sketcher2d.ts:313

Parameters​

end​

Point2D

horizontalRadius​

number

verticalRadius​

number

rotation​

number = 0

longAxis​

boolean = false

sweep​

boolean = false

Returns​

this

halfEllipse()​

halfEllipse(
   xDist, 
   yDist, 
   minorRadius, 
   sweep): this;

Defined in: Sketcher2d.ts:415

Parameters​

xDist​

number

yDist​

number

minorRadius​

number

sweep​

boolean = false

Returns​

this

halfEllipseTo()​

halfEllipseTo(
   end, 
   minorRadius, 
   sweep): this;

Defined in: Sketcher2d.ts:401

Parameters​

end​

Point2D

minorRadius​

number

sweep​

boolean = false

Returns​

this

hBulgeArc()​

hBulgeArc(distance, bulge): this;

Defined in: Sketcher2d.ts:284

Parameters​

distance​

number

bulge​

number

Returns​

this

hLine()​

hLine(distance): this;

Defined in: Sketcher2d.ts:160

Parameters​

distance​

number

Returns​

this

hLineTo()​

hLineTo(xPos): this;

Defined in: Sketcher2d.ts:168

Parameters​

xPos​

number

Returns​

this

hSagittaArc()​

hSagittaArc(distance, sagitta): this;

Defined in: Sketcher2d.ts:261

Parameters​

distance​

number

sagitta​

number

Returns​

this

line()​

line(xDist, yDist): this;

Defined in: Sketcher2d.ts:152

Parameters​

xDist​

number

yDist​

number

Returns​

this

lineTo()​

lineTo(point): this;

Defined in: Sketcher2d.ts:142

Parameters​

point​

Point2D

Returns​

this

movePointerTo()​

movePointerTo(point): this;

Defined in: Sketcher2d.ts:118

Parameters​

point​

Point2D

Returns​

this

polarLine()​

polarLine(distance, angle): this;

Defined in: Sketcher2d.ts:178

Parameters​

distance​

number

angle​

number

Returns​

this

polarLineTo()​

polarLineTo(__namedParameters): this;

Defined in: Sketcher2d.ts:172

Parameters​

__namedParameters​

Point2D

Returns​

this

quadraticBezierCurveTo()​

quadraticBezierCurveTo(end, controlPoint): this;

Defined in: Sketcher2d.ts:445

Parameters​

end​

Point2D

controlPoint​

Point2D

Returns​

this

sagittaArc()​

sagittaArc(
   xDist, 
   yDist, 
   sagitta): this;

Defined in: Sketcher2d.ts:250

Parameters​

xDist​

number

yDist​

number

sagitta​

number

Returns​

this

sagittaArcTo()​

sagittaArcTo(end, sagitta): this;

Defined in: Sketcher2d.ts:223

Parameters​

end​

Point2D

sagitta​

number

Returns​

this

smoothSpline()​

smoothSpline(
   xDist, 
   yDist, 
   splineConfig?): this;

Defined in: Sketcher2d.ts:498

Parameters​

xDist​

number

yDist​

number

splineConfig?​

SplineConfig

Returns​

this

smoothSplineTo()​

smoothSplineTo(end, config?): this;

Defined in: Sketcher2d.ts:457

Parameters​

end​

Point2D

config?​

SplineConfig

Returns​

this

tangentArc()​

tangentArc(xDist, yDist): this;

Defined in: Sketcher2d.ts:308

Parameters​

xDist​

number

yDist​

number

Returns​

this

tangentArcTo()​

tangentArcTo(end): this;

Defined in: Sketcher2d.ts:288

Parameters​

end​

Point2D

Returns​

this

tangentLine()​

tangentLine(distance): this;

Defined in: Sketcher2d.ts:184

Parameters​

distance​

number

Returns​

this

threePointsArc()​

threePointsArc(
   xDist, 
   yDist, 
   viaXDist, 
   viaYDist): this;

Defined in: Sketcher2d.ts:210

Parameters​

xDist​

number

yDist​

number

viaXDist​

number

viaYDist​

number

Returns​

this

threePointsArcTo()​

threePointsArcTo(end, midPoint): this;

Defined in: Sketcher2d.ts:198

Parameters​

end​

Point2D

midPoint​

Point2D

Returns​

this

vBulgeArc()​

vBulgeArc(distance, bulge): this;

Defined in: Sketcher2d.ts:280

Parameters​

distance​

number

bulge​

number

Returns​

this

vLine()​

vLine(distance): this;

Defined in: Sketcher2d.ts:156

Parameters​

distance​

number

Returns​

this

vLineTo()​

vLineTo(yPos): this;

Defined in: Sketcher2d.ts:164

Parameters​

yPos​

number

Returns​

this

vSagittaArc()​

vSagittaArc(distance, sagitta): this;

Defined in: Sketcher2d.ts:257

Parameters​

distance​

number

sagitta​

number

Returns​

this