VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Updated Point.shift() docs

Browse source
This commit is contained in:
Joost De Cock 2022-09-29 16:12:51 +02:00
parent 313f4afd82
commit 3b9afb6369
1 changed files with 24 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

46
markdown/dev/reference/api/point/shift/en.md
View file

@ -2,34 +2,36 @@
title: Point.shift()
---
Returns a new `Point` that is `distance` (mm) away in the direction of `angle` (degrees).
An angle of 0° points to the right, and the angle increases counterclockwise.
The `Point.shift()` method returns a new `Point` that is `distance` (mm) away
in the direction of `angle` (degrees). An angle of 0° points to the right, and
the angle increases counterclockwise.
## Point.shift() signature
## Signature
```js
Point point.shift(float angle, float distance)
```
## Point.shift() example
## Example
<Example part="point_shift">
An example of the Point.shift() method
<Example caption="An example of the Point.shift() method">
```js
({ Point, points, macro, part }) => {
points.A = new Point(90, 40)
.setText("Point A", "right text-sm")
points.B = points.A.shift(155, 70)
.setText("Point B is point A shifted 7cm\nat a 155 degree angle", "text-sm")
.attr("data-text-lineheight", 6)
macro("ld", {
from: points.B,
to: points.A,
d: -10
})
return part
}
```
</Example>
```js
let { Point, points, macro } = part.shorthand();
points.A = new Point(90, 40)
.attr("data-text", "Point A")
.attr("data-text-class", "right");
points.B = points.A.shift(155, 70)
.attr("data-text", "Point B is point A shifted 7cm\nat a 155 degree angle")
.attr("data-text-lineheight", 6);
macro("ld", {
from: points.B,
to: points.A,
d: -10
});
```