Skip to main content

Interface: GenericSketcher<ReturnType>

Type parameters

Name
ReturnType

Implemented by

Arc Segment Methods

hSagittaArc

hSagittaArc(distance, sagitta): GenericSketcher<ReturnType>

Parameters

NameType
distancenumber
sagittanumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:197


sagittaArc

sagittaArc(xDist, yDist, sagitta): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber
sagittanumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:179


sagittaArcTo

sagittaArcTo(end, sagitta): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
sagittanumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:170


tangentArc

tangentArc(xDist, yDist): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:212


tangentArcTo

tangentArcTo(end): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:204


threePointsArc

threePointsArc(xDist, yDist, viaXDist, viaYDist): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber
viaXDistnumber
viaYDistnumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:157


threePointsArcTo

threePointsArcTo(end, innerPoint): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
innerPointPoint2D

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:149


vSagittaArc

vSagittaArc(distance, sagitta): GenericSketcher<ReturnType>

Parameters

NameType
distancenumber
sagittanumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:188


Bezier Curve Methods

bezierCurveTo

bezierCurveTo(end, controlPoints): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
controlPointsPoint2D | Point2D[]

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:286


cubicBezierCurveTo

cubicBezierCurveTo(end, startControlPoint, endControlPoint): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
startControlPointPoint2D
endControlPointPoint2D

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:302


quadraticBezierCurveTo

quadraticBezierCurveTo(end, controlPoint): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
controlPointPoint2D

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:292


smoothSpline

smoothSpline(xDist, yDist, splineConfig): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber
splineConfigSplineConfig

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:344


smoothSplineTo

smoothSplineTo(end, config?): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
config?SplineConfig

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:324


Ellipse Arc Segment Methods

ellipse

ellipse(xDist, yDist, horizontalRadius, verticalRadius, rotation, longAxis, sweep): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber
horizontalRadiusnumber
verticalRadiusnumber
rotationnumber
longAxisboolean
sweepboolean

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:241


ellipseTo

ellipseTo(end, horizontalRadius, verticalRadius, rotation, longAxis, sweep): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
horizontalRadiusnumber
verticalRadiusnumber
rotationnumber
longAxisboolean
sweepboolean

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:223


halfEllipse

halfEllipse(xDist, yDist, radius, sweep): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber
radiusnumber
sweepboolean

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:270


halfEllipseTo

halfEllipseTo(end, radius, sweep): GenericSketcher<ReturnType>

Parameters

NameType
endPoint2D
radiusnumber
sweepboolean

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:259


Line Segment Methods

hLine

hLine(distance): GenericSketcher<ReturnType>

Parameters

NameType
distancenumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:107


hLineTo

hLineTo(xPos): GenericSketcher<ReturnType>

Parameters

NameType
xPosnumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:119


line

line(xDist, yDist): GenericSketcher<ReturnType>

Parameters

NameType
xDistnumber
yDistnumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:95


lineTo

lineTo(point): GenericSketcher<ReturnType>

Parameters

NameType
pointPoint2D

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:88


polarLine

polarLine(r, theta): GenericSketcher<ReturnType>

Parameters

NameType
rnumber
thetanumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:134


polarLineTo

polarLineTo(__namedParameters): GenericSketcher<ReturnType>

Parameters

NameType
__namedParameters[number, number]

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:126


tangentLine

tangentLine(distance): GenericSketcher<ReturnType>

Parameters

NameType
distancenumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:141


vLine

vLine(distance): GenericSketcher<ReturnType>

Parameters

NameType
distancenumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:101


vLineTo

vLineTo(yPos): GenericSketcher<ReturnType>

Parameters

NameType
yPosnumber

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:113


Other Methods

close

close(): ReturnType

Returns

ReturnType

Defined in

sketcherlib.ts:354


closeWithMirror

closeWithMirror(): ReturnType

Returns

ReturnType

Defined in

sketcherlib.ts:359


done

done(): ReturnType

Returns

ReturnType

Defined in

sketcherlib.ts:349


movePointerTo

movePointerTo(point): GenericSketcher<ReturnType>

Parameters

NameType
pointPoint2D

Returns

GenericSketcher<ReturnType>

Defined in

sketcherlib.ts:81