create_helix_wire
Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import create_helix_wire
Signature
def create_helix_wire(pitch: 'float', height: 'float', radius: 'float', center: 'Tuple[float, float, float]' = (0, 0, 0), dir: 'Tuple[float, float, float]' = (0, 0, 1)) -> 'Wire'
Description
Create a helix wire.
Other public imports
from cadflow import make_helix_rwire
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
pitch | 'float' | yes | - | Not explicitly described in the source docstring. |
height | 'float' | yes | - | Not explicitly described in the source docstring. |
radius | 'float' | yes | - | Not explicitly described in the source docstring. |
center | 'Tuple[float, float, float]' | no | (0, 0, 0) | Not explicitly described in the source docstring. |
dir | 'Tuple[float, float, float]' | no | (0, 0, 1) | Not explicitly described in the source docstring. |
Returns
Type: 'Wire'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import create_helix_wire