Files
modeling-app/docs/kcl-std/tangentialArc.md
Nick Cameron 1841e63021 Misc docs polishing (#6712)
* Fake modules for Rust std lib functions

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Include the missing @ in Rust std lib fns

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Move revolve and mirror2d to better modules

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Use docs from KCL mods for type summaries

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Use type docs to describe types from KCL std lib

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 16:09:59 +12:00

253 KiB

title, excerpt, layout
title excerpt layout
std::sketch::tangentialArc Starting at the current sketch's origin, draw a curved line segment along some part of an imaginary circle until it reaches the desired (x, y) coordinates. manual

Starting at the current sketch's origin, draw a curved line segment along some part of an imaginary circle until it reaches the desired (x, y) coordinates.

When using radius and angle, draw a curved line segment along part of an imaginary circle. 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 'angle' degrees along the imaginary circle.

tangentialArc(
  @sketch: Sketch,
  endAbsolute?: Point2d,
  end?: Point2d,
  radius?: number,
  angle?: number,
  tag?: TagDeclarator,
): Sketch

Arguments

Name Type Description Required
sketch Sketch Which sketch should this path be added to? Yes
endAbsolute Point2d Which absolute point should this arc go to? Incompatible with end, radius, and offset. No
end Point2d How far away (along the X and Y axes) should this arc go? Incompatible with endAbsolute, radius, and offset. No
radius number Radius of the imaginary circle. angle must be given. Incompatible with end and endAbsolute. No
angle number Offset of the arc in degrees. radius must be given. Incompatible with end and endAbsolute. No
tag TagDeclarator Create a new tag which refers to this arc No

Returns

Sketch - A sketch is a collection of paths.

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> angledLine(angle = 45, length = 10)
  |> tangentialArc(end = [0, -10])
  |> line(end = [-10, 0])
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of std::sketch::tangentialArc 0

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> angledLine(angle = 60, length = 10)
  |> tangentialArc(endAbsolute = [15, 15])
  |> line(end = [10, -15])
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of std::sketch::tangentialArc 1

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> angledLine(angle = 60, length = 10)
  |> tangentialArc(radius = 10, angle = -120)
  |> angledLine(angle = -60, length = 10)
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of std::sketch::tangentialArc 2