hyperbolicFunction in std::sketch

WARNING: This function is experimental and may change or be removed.

Add a hyperbolic section to an existing sketch.

hyperbolic(
  @sketch: Sketch,
  semiMajor: number(Length),
  semiMinor: number(Length),
  interiorAbsolute?: Point2d,
  endAbsolute?: Point2d,
  interior?: Point2d,
  end?: Point2d,
  tag?: TagDecl,
): Sketch

Arguments

Name	Type	Description	Required
`sketch`	`Sketch`	Which sketch should this path be added to?	Yes
`semiMajor`	`number(Length)`	The semi major value, a, of the hyperbolic equation x^2 / a ^ 2 - y^2 / b^2 = 1.	Yes
`semiMinor`	`number(Length)`	The semi minor value, b, of the hyperbolic equation x^2 / a ^ 2 - y^2 / b^2 = 1.	Yes
`interiorAbsolute`	`Point2d`	Any point between the segment's start and end. Requires `endAbsolute`. Incompatible with `interior` or `end`.	No
`endAbsolute`	`Point2d`	Where should this segment end? Requires `interiorAbsolute`. Incompatible with `interior` or `end`.	No
`interior`	`Point2d`	Any point between the segment's start and end. This point is relative to the start point. Requires `end`. Incompatible with `interiorAbsolute` or `endAbsolute`.	No
`end`	`Point2d`	Where should this segment end? This point is relative to the start point. Requires `interior`. Incompatible with `interiorAbsolute` or `endAbsolute`.	No
`tag`	`TagDecl`	Create a new tag which refers to this arc.	No

Returns

Sketch - A sketch is a collection of paths.

Examples

@settings(experimentalFeatures = allow)

exampleSketch = startSketchOn(XY)
  |> startProfile(at = [0, 0])
  |> hyperbolic(
       end = [10, 0],
       semiMajor = 2,
       semiMinor = 1,
       interior = [0, 0],
     )
  |> close()

Found a typo?