VSinerva/freesewing
1
0
Fork 0
Code Activity

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

Browse source
This commit is contained in:
Joost De Cock 2022-09-29 16:27:52 +02:00
parent a28420f6f4
commit f83b9f14ea
1 changed files with 33 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

45
markdown/dev/reference/api/point/shifttowards/en.md
View file

@ -2,43 +2,48 @@
title: Point.shiftTowards()
---
Returns a new `Point` that is shifted `distance` (mm) in the direction of the `target`.
The `Point.shiftTowards()` method returns a new `Point` that is shifted
`distance` (mm) in the direction of the `target`.
If you need to move a point a percentage instead of a specific distance, use [`Point.shiftFractionTowards()`](/reference/api/point/shiftfractiontowards/) instead.
## Point.shiftTowards() signature
## Signature
```js
Point point.shiftTowards(Point target, float distance)
```
## Point.shiftTowards() example
<Example part="point_shifttowards">
An example of the Point.shiftTowards() method
</Example>
## Example
<Example caption="An example of the Point.shiftTowards() method">
```js
let { Point, points, Path, paths, macro } = part.shorthand();
({ Point, points, Path, paths, macro, part }) => {
points.A = new Point(90, 70).attr("data-text", "Point A");
points.B = new Point(10, 10).attr("data-text", "Point B");
points.A = new Point(90, 70).setText("Point A", "right text-sm")
points.B = new Point(10, 10).setText("Point B", "text-sm")
points.C = points.A.shiftTowards(points.B, 35)
.attr(
"data-text",
"Point C is point A shifted 3.5cm\nin the direction of point B"
)
.attr("data-text-class", "center")
.attr("data-text-lineheight", 6);
.setText("Point C is point A shifted 3.5cm\nin the direction of point B", "center, text-sm")
.attr("data-text-lineheight", 6)
paths.direction = new Path()
.move(points.A)
.line(points.B)
.attr("class", "note dashed");
.addClass("note dashed")
macro("ld", {
from: points.C,
to: points.A,
d: -10
});
})
return part
}
```
</Example>
## Notes
If you need to move a point a percentage instead of a specific distance, use
[`Point.shiftFractionTowards()`](/reference/api/point/shiftfractiontowards/)
instead.