Files
modeling-app/docs/kcl/tangentialArc.md
Nick Cameron c050739f41 Some improvements to the boxed signatures in the docs (#6593)
* Show a more reasonable name in function docs

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

* Fix buggy docs for union types

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

* Make types in the docs signatures into links

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-04-30 16:03:22 +00:00

254 KiB

title, excerpt, layout
title excerpt layout
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](/docs/kcl/types/Sketch),
  endAbsolute?: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
  end?: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
  radius?: [number](/docs/kcl/types/number),
  angle?: [number](/docs/kcl/types/number),
  tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
): [Sketch](/docs/kcl/types/Sketch)

Arguments

Name Type Description Required
sketch Sketch Which sketch should this path be added to? Yes
endAbsolute [number] Which absolute point should this arc go to? Incompatible with end, radius, and offset. No
end [number] 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

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 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 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 tangentialArc 2