Class: Sketcher
The FaceSketcher allows you to sketch on a plane.
Implements
Constructors
constructor
• new Sketcher(plane)
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
| Name | Type |
|---|---|
plane | Plane |
Defined in
• new Sketcher(plane?, origin?)
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
| Name | Type |
|---|---|
plane? | PlaneName |
origin? | number | Point |
Defined in
Methods
bezierCurveTo
▸ bezierCurveTo(end, controlPoints): Sketcher
Draws a generic bezier curve to the end point, going using a set of control points.
This is the generic definition of a bézier curve, you might want to use either the quadratic or cubic (most common) version, unless you know exactly what you are aiming at.
Parameters
| Name | Type |
|---|---|
end | Point2D |
controlPoints | Point2D | Point2D[] |
Returns
Implementation of
Defined in
close
▸ close(): Sketch
Stop drawing, make sure the sketch is closed (by adding a straight line to from the last point to the first) and returns the sketch.
Returns
Implementation of
Defined in
closeWithMirror
▸ closeWithMirror(): Sketch
Stop drawing, make sure the sketch is closed (by mirroring the lines between the first and last points drawn) and returns the sketch.
Returns
Implementation of
GenericSketcher.closeWithMirror
Defined in
cubicBezierCurveTo
▸ cubicBezierCurveTo(end, startControlPoint, endControlPoint): Sketcher
Draws a cubic bezier curve to the end point, using the start and end control point to define its shape. This corresponds to the most commonly used bezier curve.
If you are struggling setting your control points, the smoothSpline might be better for your needs.
Parameters
| Name | Type |
|---|---|
end | Point2D |
startControlPoint | Point2D |
endControlPoint | Point2D |
Returns
Implementation of
GenericSketcher.cubicBezierCurveTo
Defined in
delete
▸ delete(): void
Returns
void
Defined in
done
▸ done(): Sketch
Stop drawing and returns the sketch.
Returns
Implementation of
Defined in
ellipse
▸ ellipse(xDist, yDist, horizontalRadius, verticalRadius, rotation?, longAxis?, sweep?): Sketcher
Draws an arc of ellipse by defining its end point and an ellipse. The end point is defined by distances from he start point.
The shape of the ellipse is defined by both its radiuses, its angle relative to the current coordinat system, as well as the long and sweep flags (as defined for SVG paths)
Parameters
| Name | Type | Default value |
|---|---|---|
xDist | number | undefined |
yDist | number | undefined |
horizontalRadius | number | undefined |
verticalRadius | number | undefined |
rotation | number | 0 |
longAxis | boolean | false |
sweep | boolean | false |
Returns
Implementation of
Defined in
ellipseTo
▸ ellipseTo(end, horizontalRadius, verticalRadius, rotation?, longAxis?, sweep?): Sketcher
Draws an arc of ellipse by defining its end point and an ellipse.
The shape of the ellipse is defined by both its radiuses, its angle relative to the current coordinat system, as well as the long and sweep flags (as defined for SVG paths)
Parameters
| Name | Type | Default value |
|---|---|---|
end | Point2D | undefined |
horizontalRadius | number | undefined |
verticalRadius | number | undefined |
rotation | number | 0 |
longAxis | boolean | false |
sweep | boolean | false |
Returns
Implementation of
Defined in
hLine
▸ hLine(distance): Sketcher
Draws an horizontal line of length distance from the current point
Parameters
| Name | Type |
|---|---|
distance | number |
Returns
Implementation of
Defined in
hLineTo
▸ hLineTo(xPos): Sketcher
Draws an horizontal line to the x coordinate
Parameters
| Name | Type |
|---|---|
xPos | number |
Returns
Implementation of
Defined in
hSagittaArc
▸ hSagittaArc(distance, sagitta): Sketcher
Draws an horizontal arc of circle by defining its end point and the sagitta - the maximum distance between the arc and the straight line going from start to end point.The end point is defined by its horizontal distance from the start point.
Parameters
| Name | Type |
|---|---|
distance | number |
sagitta | number |
Returns
Implementation of
Defined in
halfEllipse
▸ halfEllipse(xDist, yDist, verticalRadius, sweep?): Sketcher
Draws an arc as half an ellipse, defined by the sagitta of the ellipse (which corresponds to the radius in the axe orthogonal to the straight line).The end point is defined by distances from he start point.
The sweep flag is to be understood as defined for SVG paths.
Parameters
| Name | Type | Default value |
|---|---|---|
xDist | number | undefined |
yDist | number | undefined |
verticalRadius | number | undefined |
sweep | boolean | false |
Returns
Implementation of
Defined in
halfEllipseTo
▸ halfEllipseTo(end, verticalRadius, sweep?): Sketcher
Draws an arc as half an ellipse, defined by the sagitta of the ellipse (which corresponds to the radius in the axe orthogonal to the straight line).
The sweep flag is to be understood as defined for SVG paths.
Parameters
| Name | Type | Default value |
|---|---|---|
end | Point2D | undefined |
verticalRadius | number | undefined |
sweep | boolean | false |
Returns
Implementation of
Defined in
line
▸ line(xDist, yDist): Sketcher
Draws a line at the horizontal distance xDist and the vertical distance yDist of the current point
Parameters
| Name | Type |
|---|---|
xDist | number |
yDist | number |
Returns
Implementation of
Defined in
lineTo
▸ lineTo(__namedParameters): Sketcher
Draws a line from the current point to the point given in argument
Parameters
| Name | Type |
|---|---|
__namedParameters | Point2D |
Returns
Implementation of
Defined in
movePointerTo
▸ movePointerTo(__namedParameters): Sketcher
Changes the point to start your drawing from
Parameters
| Name | Type |
|---|---|
__namedParameters | Point2D |
Returns
Implementation of
Defined in
polarLine
▸ polarLine(distance, angle): Sketcher
Draws a line from the current point to the point defined in polar coordiates, of radius r and angle theta (in degrees) from the current point
Parameters
| Name | Type |
|---|---|
distance | number |
angle | number |
Returns
Implementation of
Defined in
polarLineTo
▸ polarLineTo(__namedParameters): Sketcher
Draws a line from the current point to the point defined in polar coordiates, of radius r and angle theta (in degrees) from the origin
Parameters
| Name | Type |
|---|---|
__namedParameters | [number, number] |
Returns
Implementation of
Defined in
quadraticBezierCurveTo
▸ quadraticBezierCurveTo(end, controlPoint): Sketcher
Draws a quadratic bezier curve to the end point, using the single control point.
Parameters
| Name | Type |
|---|---|
end | Point2D |
controlPoint | Point2D |
Returns
Implementation of
GenericSketcher.quadraticBezierCurveTo
Defined in
sagittaArc
▸ sagittaArc(xDist, yDist, sagitta): Sketcher
Draws an arc of circle by defining its end point and the sagitta - the maximum distance between the arc and the straight line going from start to end point.The end point is defined by its horizontal and vertical distances from the start point.
Parameters
| Name | Type |
|---|---|
xDist | number |
yDist | number |
sagitta | number |
Returns
Implementation of
Defined in
sagittaArcTo
▸ sagittaArcTo(end, sagitta): Sketcher
Draws an arc of circle by defining its end point and the sagitta - the maximum distance between the arc and the straight line going from start to end point.
Parameters
| Name | Type |
|---|---|
end | Point2D |
sagitta | number |
Returns
Implementation of
Defined in
smoothSpline
▸ smoothSpline(xDist, yDist, splineConfig?): Sketcher
Draws a cubic bezier curve to the end point, attempting to make the line smooth with the previous segment. The end point is defined by its distance to the first point.
It will base its first control point so that its tangent is the same than
the previous segment. You can force another tangent by defining
startTangent.
You can configure the tangent of the end point by configuring the
endTangent, either as "symmetric" to reproduce the start angle, as an
angle from the X axis (in the coordinate system) or a 2d direction (still
in the coordinate system.
The start- and end- factors decide on how far the control point is from the start and end point. At a factor of 1, the distance corresponds to a quarter of the straight line distance.
Parameters
| Name | Type |
|---|---|
xDist | number |
yDist | number |
splineConfig | SplineConfig |
Returns
Implementation of
Defined in
smoothSplineTo
▸ smoothSplineTo(end, config?): Sketcher
Draws a cubic bezier curve to the end point, attempting to make the line smooth with the previous segment.
It will base its first control point so that its tangent is the same than the previous segment.
The control point relative to the end is by default set to be in the
direction of the straight line between start and end. You can specifiy the
endSkew either as an angle (in degrees) to this direction, or as an
absolute direction in the coordinate system (a Point).
The start- and end- factors decide on how far the control point is from the start and end point. At a factor of 1, the distance corresponds to a quarter of the straight line distance.
Parameters
| Name | Type |
|---|---|
end | Point2D |
config? | SplineConfig |
Returns
Implementation of
GenericSketcher.smoothSplineTo
Defined in
tangentArc
▸ tangentArc(xDist, yDist): Sketcher
Draws an arc of circle from the current point as a tangent to the previous part of curve drawn.The end point is defined by its horizontal and vertical distances from the start point.
Parameters
| Name | Type |
|---|---|
xDist | number |
yDist | number |
Returns
Implementation of
Defined in
tangentArcTo
▸ tangentArcTo(end): Sketcher
Draws an arc of circle from the current point as a tangent to the previous part of curve drawn.
Parameters
| Name | Type |
|---|---|
end | Point2D |
Returns
Implementation of
Defined in
tangentLine
▸ tangentLine(distance): Sketcher
Draws a line from the current point as a tangent to the previous part of curve drawn. The distance defines how long the line will be.
Parameters
| Name | Type |
|---|---|
distance | number |
Returns
Implementation of
Defined in
threePointsArc
▸ threePointsArc(xDist, yDist, viaXDist, viaYDist): Sketcher
Draws an arc of circle by defining its end point and a third point through which the arc will pass. Both poinats are defined in horizontal (x) and vertical (y) distances from the start point.
Parameters
| Name | Type |
|---|---|
xDist | number |
yDist | number |
viaXDist | number |
viaYDist | number |
Returns
Implementation of
GenericSketcher.threePointsArc
Defined in
threePointsArcTo
▸ threePointsArcTo(end, innerPoint): Sketcher
Draws an arc of circle by defining its end point and a third point through which the arc will pass.
Parameters
| Name | Type |
|---|---|
end | Point2D |
innerPoint | Point2D |
Returns
Implementation of
GenericSketcher.threePointsArcTo
Defined in
vLine
▸ vLine(distance): Sketcher
Draws a vertical line of length distance from the current point
Parameters
| Name | Type |
|---|---|
distance | number |
Returns
Implementation of
Defined in
vLineTo
▸ vLineTo(yPos): Sketcher
Draws a vertical line to the y coordinate
Parameters
| Name | Type |
|---|---|
yPos | number |
Returns
Implementation of
Defined in
vSagittaArc
▸ vSagittaArc(distance, sagitta): Sketcher
Draws a vertical arc of circle by defining its end point and the sagitta
- the maximum distance between the arc and the straight line going from start to end point.The end point is defined by its vertical distance from the start point.
Parameters
| Name | Type |
|---|---|
distance | number |
sagitta | number |