kcl-std → functions → hyperbolicPoint

hyperbolicPointFunction in std::sketch

Calculate the point (x, y) on a hyperbola given x or y and the semi major/minor values of the hyperbolic.

hyperbolicPoint(
  semiMajor: number,
  semiMinor: number,
  x?: number(Length),
  y?: number(Length),
): Point2d

Arguments

NameTypeDescriptionRequired
semiMajornumberThe semi major value, a, of the hyperbolic equation x^2 / a ^ 2 - y^2 / b^2 = 1.Yes
semiMinornumberThe semi minor value, b, of the hyperbolic equation x^2 / a ^ 2 - y^2 / b^2 = 1.Yes
xnumber(Length)The x value. Calculates y and returns (x, y). Incompatible with y.No
ynumber(Length)The y value. Calculates x and returns (x, y). Incompatible with x.No

Returns

Point2d - A point in two dimensional space.

Examples

point = hyperbolicPoint(x = 5, semiMajor = 2, semiMinor = 1)

Rendered example of hyperbolicPoint 0

Found a typo?