Skip to main content

Class: Sketcher

Implements

Constructors

constructor

new Sketcher(plane)

Parameters

NameType
planePlane

Defined in

Sketcher.ts:42

new Sketcher(plane?, origin?)

Parameters

NameType
plane?PlaneName
origin?number | Point

Defined in

Sketcher.ts:43

Methods

bezierCurveTo

bezierCurveTo(end, controlPoints): Sketcher

Parameters

NameType
endPoint2D
controlPointsPoint2D | Point2D[]

Returns

Sketcher

Implementation of

GenericSketcher.bezierCurveTo

Defined in

Sketcher.ts:321


close

close(): Sketch

Returns

Sketch

Implementation of

GenericSketcher.close

Defined in

Sketcher.ts:461


closeWithMirror

closeWithMirror(): Sketch

Returns

Sketch

Implementation of

GenericSketcher.closeWithMirror

Defined in

Sketcher.ts:466


cubicBezierCurveTo

cubicBezierCurveTo(end, startControlPoint, endControlPoint): Sketcher

Parameters

NameType
endPoint2D
startControlPointPoint2D
endControlPointPoint2D

Returns

Sketcher

Implementation of

GenericSketcher.cubicBezierCurveTo

Defined in

Sketcher.ts:344


delete

delete(): void

Returns

void

Defined in

Sketcher.ts:55


done

done(): Sketch

Returns

Sketch

Implementation of

GenericSketcher.done

Defined in

Sketcher.ts:453


ellipse

ellipse(xDist, yDist, horizontalRadius, verticalRadius, rotation?, longAxis?, sweep?): Sketcher

Parameters

NameTypeDefault value
xDistnumberundefined
yDistnumberundefined
horizontalRadiusnumberundefined
verticalRadiusnumberundefined
rotationnumber0
longAxisbooleanfalse
sweepbooleanfalse

Returns

Sketcher

Implementation of

GenericSketcher.ellipse

Defined in

Sketcher.ts:270


ellipseTo

ellipseTo(end, horizontalRadius, verticalRadius, rotation?, longAxis?, sweep?): Sketcher

Parameters

NameTypeDefault value
endPoint2Dundefined
horizontalRadiusnumberundefined
verticalRadiusnumberundefined
rotationnumber0
longAxisbooleanfalse
sweepbooleanfalse

Returns

Sketcher

Implementation of

GenericSketcher.ellipseTo

Defined in

Sketcher.ts:208


hLine

hLine(distance): Sketcher

Parameters

NameType
distancenumber

Returns

Sketcher

Implementation of

GenericSketcher.hLine

Defined in

Sketcher.ts:89


hLineTo

hLineTo(xPos): Sketcher

Parameters

NameType
xPosnumber

Returns

Sketcher

Implementation of

GenericSketcher.hLineTo

Defined in

Sketcher.ts:98


hSagittaArc

hSagittaArc(distance, sagitta): Sketcher

Parameters

NameType
distancenumber
sagittanumber

Returns

Sketcher

Implementation of

GenericSketcher.hSagittaArc

Defined in

Sketcher.ts:204


halfEllipse

halfEllipse(xDist, yDist, verticalRadius, sweep?): Sketcher

Parameters

NameTypeDefault value
xDistnumberundefined
yDistnumberundefined
verticalRadiusnumberundefined
sweepbooleanfalse

Returns

Sketcher

Implementation of

GenericSketcher.halfEllipse

Defined in

Sketcher.ts:307


halfEllipseTo

halfEllipseTo(end, verticalRadius, sweep?): Sketcher

Parameters

NameTypeDefault value
endPoint2Dundefined
verticalRadiusnumberundefined
sweepbooleanfalse

Returns

Sketcher

Implementation of

GenericSketcher.halfEllipseTo

Defined in

Sketcher.ts:290


line

line(xDist, yDist): Sketcher

Parameters

NameType
xDistnumber
yDistnumber

Returns

Sketcher

Implementation of

GenericSketcher.line

Defined in

Sketcher.ts:80


lineTo

lineTo(__namedParameters): Sketcher

Parameters

NameType
__namedParametersPoint2D

Returns

Sketcher

Implementation of

GenericSketcher.lineTo

Defined in

Sketcher.ts:73


movePointerTo

movePointerTo(__namedParameters): Sketcher

Parameters

NameType
__namedParametersPoint2D

Returns

Sketcher

Implementation of

GenericSketcher.movePointerTo

Defined in

Sketcher.ts:63


polarLine

polarLine(distance, angle): Sketcher

Parameters

NameType
distancenumber
anglenumber

Returns

Sketcher

Implementation of

GenericSketcher.polarLine

Defined in

Sketcher.ts:103


polarLineTo

polarLineTo(__namedParameters): Sketcher

Parameters

NameType
__namedParameters[number, number]

Returns

Sketcher

Implementation of

GenericSketcher.polarLineTo

Defined in

Sketcher.ts:109


quadraticBezierCurveTo

quadraticBezierCurveTo(end, controlPoint): Sketcher

Parameters

NameType
endPoint2D
controlPointPoint2D

Returns

Sketcher

Implementation of

GenericSketcher.quadraticBezierCurveTo

Defined in

Sketcher.ts:340


sagittaArc

sagittaArc(xDist, yDist, sagitta): Sketcher

Parameters

NameType
xDistnumber
yDistnumber
sagittanumber

Returns

Sketcher

Implementation of

GenericSketcher.sagittaArc

Defined in

Sketcher.ts:195


sagittaArcTo

sagittaArcTo(end, sagitta): Sketcher

Parameters

NameType
endPoint2D
sagittanumber

Returns

Sketcher

Implementation of

GenericSketcher.sagittaArcTo

Defined in

Sketcher.ts:175


smoothSpline

smoothSpline(xDist, yDist, splineConfig?): Sketcher

Parameters

NameType
xDistnumber
yDistnumber
splineConfigSplineConfig

Returns

Sketcher

Implementation of

GenericSketcher.smoothSpline

Defined in

Sketcher.ts:410


smoothSplineTo

smoothSplineTo(end, config?): Sketcher

Parameters

NameType
endPoint2D
config?SplineConfig

Returns

Sketcher

Implementation of

GenericSketcher.smoothSplineTo

Defined in

Sketcher.ts:352


tangentArc

tangentArc(xDist, yDist): Sketcher

Parameters

NameType
xDistnumber
yDistnumber

Returns

Sketcher

Implementation of

GenericSketcher.tangentArc

Defined in

Sketcher.ts:170


tangentArcTo

tangentArcTo(end): Sketcher

Parameters

NameType
endPoint2D

Returns

Sketcher

Implementation of

GenericSketcher.tangentArcTo

Defined in

Sketcher.ts:158


tangentLine

tangentLine(distance): Sketcher

Parameters

NameType
distancenumber

Returns

Sketcher

Implementation of

GenericSketcher.tangentLine

Defined in

Sketcher.ts:115


threePointsArc

threePointsArc(xDist, yDist, viaXDist, viaYDist): Sketcher

Parameters

NameType
xDistnumber
yDistnumber
viaXDistnumber
viaYDistnumber

Returns

Sketcher

Implementation of

GenericSketcher.threePointsArc

Defined in

Sketcher.ts:145


threePointsArcTo

threePointsArcTo(end, innerPoint): Sketcher

Parameters

NameType
endPoint2D
innerPointPoint2D

Returns

Sketcher

Implementation of

GenericSketcher.threePointsArcTo

Defined in

Sketcher.ts:135


vLine

vLine(distance): Sketcher

Parameters

NameType
distancenumber

Returns

Sketcher

Implementation of

GenericSketcher.vLine

Defined in

Sketcher.ts:85


vLineTo

vLineTo(yPos): Sketcher

Parameters

NameType
yPosnumber

Returns

Sketcher

Implementation of

GenericSketcher.vLineTo

Defined in

Sketcher.ts:93


vSagittaArc

vSagittaArc(distance, sagitta): Sketcher

Parameters

NameType
distancenumber
sagittanumber

Returns

Sketcher

Implementation of

GenericSketcher.vSagittaArc

Defined in

Sketcher.ts:200