Workplane
Kind: Class
Domain: Core runtime
Canonical import: from cadflow import Workplane
Signature
class Workplane(origin: 'Sequence[float]' = (0, 0, 0), normal: 'Sequence[float]' = (0, 0, 1), x_dir: 'Sequence[float]' = (1, 0, 0), *, parent: 'CoordinateFrame | None' = None, model: 'object | None' = None) -> 'None'
Description
Context manager and factory for local sketches.
Other public imports
from cadflow.frame import Workplane
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
origin | 'Sequence[float]' | no | (0, 0, 0) | Not explicitly described in the source docstring. |
normal | 'Sequence[float]' | no | (0, 0, 1) | Not explicitly described in the source docstring. |
x_dir | 'Sequence[float]' | no | (1, 0, 0) | Not explicitly described in the source docstring. |
parent | 'CoordinateFrame | None' | no | None | Not explicitly described in the source docstring. |
model | 'object | None' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'None'
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.
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
arc | method | (self, start: 'Sequence[float]', middle: 'Sequence[float]', end: 'Sequence[float]') | See the member signature. |
circle_profile | method | (self, radius: 'float', center: 'Sequence[float]' = (0, 0, 0)) | See the member signature. |
extrude | method | (self, profile, vector: 'Sequence[float]') | See the member signature. |
helix | method | (self, pitch: 'float', height: 'float', radius: 'float', **kwargs: 'object') | See the member signature. |
interpolate | method | (self, points: 'Sequence[Sequence[float]]', **kwargs: 'object') | See the member signature. |
point | method | (self, value: 'Sequence[float]') -> 'tuple[float, float, float]' | See the member signature. |
polyline | method | (self, points: 'Sequence[Sequence[float]]', *, closed: 'bool' = False) | See the member signature. |
sketch | method | (self, name: 'str | None' = None) | See the member signature. |
vector | method | (self, value: 'Sequence[float]') -> 'tuple[float, float, float]' | See the member signature. |
Behavior and constraints
- Shape values remain bound to their owning session; do not use them after the session closes.
Import check
from cadflow import Workplane