ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Adam Chalmers
2024-08-08 14:13:29 -05:00
parent 2e4ad0af09
commit 8e1dd4a84e
4 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/kcl/std.json
View File

@ -211843,8 +211843,8 @@
},
{
"name": "tangentialArc",
"summary": "Starting at the current sketch's origin, draw a curved line segment along",
"description": "some part of an imaginary circle of the specified radius.\nThe arc is constructed such that the last line segment is placed tangent to the imaginary circle of the specified radius. The resulting arc is the segment of the imaginary circle from that tangent point for 'offset' degrees along the imaginary circle.",
"summary": "Draw a curved line segment along some part of an imaginary circle of the specified radius.",
"description": "If `relative` is true, the curve starts at the end of the previous path segment (i.e. the location of the \"pen\" which draws these lines). If `relative` is false, starts from the current sketch's origin.\nThe arc is constructed such that the last line segment is placed tangent to the imaginary circle of the specified radius. The resulting arc is the segment of the imaginary circle from that tangent point for 'offset' degrees along the imaginary circle.",
"tags": [],
"args": [
{
@ -225267,7 +225267,7 @@
"unpublished": false,
"deprecated": false,
"examples": [
"const exampleSketch = startSketchOn('XZ')\n |> startProfileAt([0, 0], %)\n |> angledLine({ angle: 60, length: 10 }, %)\n |> tangentialArcTo([15, 15], %)\n |> line([10, -15], %)\n |> close(%)\n\nconst example = extrude(10, exampleSketch)"
"const exampleSketch = startSketchOn('XZ')\n |> startProfileAt([0, 0], %)\n |> angledLine({ angle: 60, length: 10 }, %)\n |> tangentialArcTo([15, 15], false, %)\n |> line([10, -15], %)\n |> close(%)\n\nconst example = extrude(10, exampleSketch)"
]
},
{

6
docs/kcl/tangentialArc.md
View File

@ -1,12 +1,12 @@
---
title: "tangentialArc"
excerpt: "Starting at the current sketch's origin, draw a curved line segment along"
excerpt: "Draw a curved line segment along some part of an imaginary circle of the specified radius."
layout: manual
---
Starting at the current sketch's origin, draw a curved line segment along
Draw a curved line segment along some part of an imaginary circle of the specified radius.
some part of an imaginary circle of the specified radius.
If `relative` is true, the curve starts at the end of the previous path segment (i.e. the location of the "pen" which draws these lines). If `relative` is false, starts from the current sketch's origin.
The arc is constructed such that the last line segment is placed tangent to the imaginary circle of the specified radius. The resulting arc is the segment of the imaginary circle from that tangent point for 'offset' degrees along the imaginary circle.
```js

2
docs/kcl/tangentialArcTo.md
View File

@ -18,7 +18,7 @@ tangentialArcTo(to: [number], relative: bool, sketch_group: SketchGroup, tag?: T
const exampleSketch = startSketchOn('XZ')
|> startProfileAt([0, 0], %)
|> angledLine({ angle: 60, length: 10 }, %)
|> tangentialArcTo([15, 15], %)
|> tangentialArcTo([15, 15], false, %)
|> line([10, -15], %)
|> close(%)

7
src/wasm-lib/kcl/src/std/sketch.rs
View File

@ -1645,8 +1645,11 @@ pub async fn tangential_arc(args: Args) -> Result<MemoryItem, KclError> {
Ok(MemoryItem::SketchGroup(new_sketch_group))
}
/// Starting at the current sketch's origin, draw a curved line segment along
/// some part of an imaginary circle of the specified radius.
/// Draw a curved line segment along some part of an imaginary circle of the specified radius.
///
/// If `relative` is true, the curve starts at the end of the previous path segment
/// (i.e. the location of the "pen" which draws these lines). If `relative` is false,
/// starts from the current sketch's origin.
///
/// The arc is constructed such that the last line segment is placed tangent
/// to the imaginary circle of the specified radius. The resulting arc is the