helix()

Creates a helix wire along the given axis. Use chained methods (.pitch(), .turns(), .height(), .radius(), .endRadius()) to configure geometry.

Returns: Helix

tip

See the guide for detailed usage examples.

Signatures

helix(axis: AxisLike): Helix

Creates a helix wire along the given axis. Use chained methods (.pitch(), .turns(), .height(), .radius(), .endRadius()) to configure geometry.

Parameter	Type	Description
axis	AxisLike	The axis to build the helix around.

---

helix(source: SceneObject): Helix

Creates a helix wire derived from a scene object's geometry.

• A cylindrical or conical face: axis + radii + height come from the face.
• A line edge: axis = the line, height = line length.
• A circular edge: axis = circle normal at center, radius = circle radius.

Parameter	Type	Description
source	SceneObject	The scene object whose face/edge defines the helix.

Examples

import { sketch, circle, hMove, helix, sweep } from 'fluidcad/core';

const path = helix("z").radius(15).pitch(10).turns(5);

const profile = sketch("left", () => {
    hMove(15);
    circle(2);
});

sweep(path, profile);