Skip to main content

Class: DrawingPen

Hierarchy

Implements

Constructors

constructor

new DrawingPen(origin?)

Parameters

NameType
originPoint2D

Overrides

BaseSketcher2d.constructor

Defined in

draw.ts:110

Methods

bezierCurveTo

bezierCurveTo(end, controlPoints): DrawingPen

Parameters

NameType
endPoint2D
controlPointsPoint2D | Point2D[]

Returns

DrawingPen

Implementation of

GenericSketcher.bezierCurveTo

Inherited from

BaseSketcher2d.bezierCurveTo

Defined in

Sketcher2d.ts:335


close

close(): Drawing

Returns

Drawing

Implementation of

GenericSketcher.close

Defined in

draw.ts:122


closeWithMirror

closeWithMirror(): Drawing

Returns

Drawing

Implementation of

GenericSketcher.closeWithMirror

Defined in

draw.ts:127


cubicBezierCurveTo

cubicBezierCurveTo(end, startControlPoint, endControlPoint): DrawingPen

Parameters

NameType
endPoint2D
startControlPointPoint2D
endControlPointPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.cubicBezierCurveTo

Inherited from

BaseSketcher2d.cubicBezierCurveTo

Defined in

Sketcher2d.ts:359


done

done(): Drawing

Returns

Drawing

Implementation of

GenericSketcher.done

Defined in

draw.ts:118


ellipse

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

Parameters

NameTypeDefault value
xDistnumberundefined
yDistnumberundefined
horizontalRadiusnumberundefined
verticalRadiusnumberundefined
rotationnumber0
longAxisbooleanfalse
sweepbooleanfalse

Returns

DrawingPen

Implementation of

GenericSketcher.ellipse

Inherited from

BaseSketcher2d.ellipse

Defined in

Sketcher2d.ts:291


ellipseTo

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

Parameters

NameTypeDefault value
endPoint2Dundefined
horizontalRadiusnumberundefined
verticalRadiusnumberundefined
rotationnumber0
longAxisbooleanfalse
sweepbooleanfalse

Returns

DrawingPen

Implementation of

GenericSketcher.ellipseTo

Inherited from

BaseSketcher2d.ellipseTo

Defined in

Sketcher2d.ts:223


hLine

hLine(distance): DrawingPen

Parameters

NameType
distancenumber

Returns

DrawingPen

Implementation of

GenericSketcher.hLine

Inherited from

BaseSketcher2d.hLine

Defined in

Sketcher2d.ts:93


hLineTo

hLineTo(xPos): DrawingPen

Parameters

NameType
xPosnumber

Returns

DrawingPen

Implementation of

GenericSketcher.hLineTo

Inherited from

BaseSketcher2d.hLineTo

Defined in

Sketcher2d.ts:101


hSagittaArc

hSagittaArc(distance, sagitta): DrawingPen

Parameters

NameType
distancenumber
sagittanumber

Returns

DrawingPen

Implementation of

GenericSketcher.hSagittaArc

Inherited from

BaseSketcher2d.hSagittaArc

Defined in

Sketcher2d.ts:194


halfEllipse

halfEllipse(xDist, yDist, minorRadius, sweep?): DrawingPen

Parameters

NameTypeDefault value
xDistnumberundefined
yDistnumberundefined
minorRadiusnumberundefined
sweepbooleanfalse

Returns

DrawingPen

Implementation of

GenericSketcher.halfEllipse

Inherited from

BaseSketcher2d.halfEllipse

Defined in

Sketcher2d.ts:325


halfEllipseTo

halfEllipseTo(end, minorRadius, sweep?): DrawingPen

Parameters

NameTypeDefault value
endPoint2Dundefined
minorRadiusnumberundefined
sweepbooleanfalse

Returns

DrawingPen

Implementation of

GenericSketcher.halfEllipseTo

Inherited from

BaseSketcher2d.halfEllipseTo

Defined in

Sketcher2d.ts:311


line

line(xDist, yDist): DrawingPen

Parameters

NameType
xDistnumber
yDistnumber

Returns

DrawingPen

Implementation of

GenericSketcher.line

Inherited from

BaseSketcher2d.line

Defined in

Sketcher2d.ts:85


lineTo

lineTo(point): DrawingPen

Parameters

NameType
pointPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.lineTo

Inherited from

BaseSketcher2d.lineTo

Defined in

Sketcher2d.ts:75


movePointerTo

movePointerTo(point): DrawingPen

Parameters

NameType
pointPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.movePointerTo

Inherited from

BaseSketcher2d.movePointerTo

Defined in

Sketcher2d.ts:64


polarLine

polarLine(distance, angle): DrawingPen

Parameters

NameType
distancenumber
anglenumber

Returns

DrawingPen

Implementation of

GenericSketcher.polarLine

Inherited from

BaseSketcher2d.polarLine

Defined in

Sketcher2d.ts:111


polarLineTo

polarLineTo(__namedParameters): DrawingPen

Parameters

NameType
__namedParametersPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.polarLineTo

Inherited from

BaseSketcher2d.polarLineTo

Defined in

Sketcher2d.ts:105


quadraticBezierCurveTo

quadraticBezierCurveTo(end, controlPoint): DrawingPen

Parameters

NameType
endPoint2D
controlPointPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.quadraticBezierCurveTo

Inherited from

BaseSketcher2d.quadraticBezierCurveTo

Defined in

Sketcher2d.ts:355


sagittaArc

sagittaArc(xDist, yDist, sagitta): DrawingPen

Parameters

NameType
xDistnumber
yDistnumber
sagittanumber

Returns

DrawingPen

Implementation of

GenericSketcher.sagittaArc

Inherited from

BaseSketcher2d.sagittaArc

Defined in

Sketcher2d.ts:183


sagittaArcTo

sagittaArcTo(end, sagitta): DrawingPen

Parameters

NameType
endPoint2D
sagittanumber

Returns

DrawingPen

Implementation of

GenericSketcher.sagittaArcTo

Inherited from

BaseSketcher2d.sagittaArcTo

Defined in

Sketcher2d.ts:156


smoothSpline

smoothSpline(xDist, yDist, splineConfig?): DrawingPen

Parameters

NameType
xDistnumber
yDistnumber
splineConfig?SplineConfig

Returns

DrawingPen

Implementation of

GenericSketcher.smoothSpline

Inherited from

BaseSketcher2d.smoothSpline

Defined in

Sketcher2d.ts:408


smoothSplineTo

smoothSplineTo(end, config?): DrawingPen

Parameters

NameType
endPoint2D
config?SplineConfig

Returns

DrawingPen

Implementation of

GenericSketcher.smoothSplineTo

Inherited from

BaseSketcher2d.smoothSplineTo

Defined in

Sketcher2d.ts:367


tangentArc

tangentArc(xDist, yDist): DrawingPen

Parameters

NameType
xDistnumber
yDistnumber

Returns

DrawingPen

Implementation of

GenericSketcher.tangentArc

Inherited from

BaseSketcher2d.tangentArc

Defined in

Sketcher2d.ts:218


tangentArcTo

tangentArcTo(end): DrawingPen

Parameters

NameType
endPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.tangentArcTo

Inherited from

BaseSketcher2d.tangentArcTo

Defined in

Sketcher2d.ts:198


tangentLine

tangentLine(distance): DrawingPen

Parameters

NameType
distancenumber

Returns

DrawingPen

Implementation of

GenericSketcher.tangentLine

Inherited from

BaseSketcher2d.tangentLine

Defined in

Sketcher2d.ts:117


threePointsArc

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

Parameters

NameType
xDistnumber
yDistnumber
viaXDistnumber
viaYDistnumber

Returns

DrawingPen

Implementation of

GenericSketcher.threePointsArc

Inherited from

BaseSketcher2d.threePointsArc

Defined in

Sketcher2d.ts:143


threePointsArcTo

threePointsArcTo(end, midPoint): DrawingPen

Parameters

NameType
endPoint2D
midPointPoint2D

Returns

DrawingPen

Implementation of

GenericSketcher.threePointsArcTo

Inherited from

BaseSketcher2d.threePointsArcTo

Defined in

Sketcher2d.ts:131


vLine

vLine(distance): DrawingPen

Parameters

NameType
distancenumber

Returns

DrawingPen

Implementation of

GenericSketcher.vLine

Inherited from

BaseSketcher2d.vLine

Defined in

Sketcher2d.ts:89


vLineTo

vLineTo(yPos): DrawingPen

Parameters

NameType
yPosnumber

Returns

DrawingPen

Implementation of

GenericSketcher.vLineTo

Inherited from

BaseSketcher2d.vLineTo

Defined in

Sketcher2d.ts:97


vSagittaArc

vSagittaArc(distance, sagitta): DrawingPen

Parameters

NameType
distancenumber
sagittanumber

Returns

DrawingPen

Implementation of

GenericSketcher.vSagittaArc

Inherited from

BaseSketcher2d.vSagittaArc

Defined in

Sketcher2d.ts:190