Files
modeling-app/docs/kcl/std-math-atan2.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

80 KiB

title, excerpt, layout
title excerpt layout
std::math::atan2 Compute the four quadrant arctangent of Y and X. manual

Compute the four quadrant arctangent of Y and X.

atan2(
  y: [number](/docs/kcl/types/number)(Length),
  x: [number](/docs/kcl/types/number)(Length),
): [number](/docs/kcl/types/number)(rad)

Arguments

Name Type Description Required
y number(Length) Yes
x number(Length) Yes

Returns

number(rad)

Examples

sketch001 = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> angledLine(
    angle = atan2(y = 1.25, x = 2),
    length = 20,
  )
  |> yLine(endAbsolute = 0)
  |> close()

extrude001 = extrude(sketch001, length = 5)

Rendered example of std::math::atan2 0