CoordinateFrame
Kind: Class
Domain: Core runtime
Canonical import: from cadflow import CoordinateFrame
Signature
class CoordinateFrame(origin: 'tuple[float, float, float]' = (0.0, 0.0, 0.0), x_axis: 'tuple[float, float, float]' = (1.0, 0.0, 0.0), y_axis: 'tuple[float, float, float]' = (0.0, 1.0, 0.0), z_axis: 'tuple[float, float, float]' = (0.0, 0.0, 1.0)) -> None
Description
CoordinateFrame(origin: 'tuple[float, float, float]' = (0.0, 0.0, 0.0), x_axis: 'tuple[float, float, float]' = (1.0, 0.0, 0.0), y_axis: 'tuple[float, float, float]' = (0.0, 1.0, 0.0), z_axis: 'tuple[float, float, float]' = (0.0, 0.0, 1.0))
Other public imports
from cadflow.frame import CoordinateFrame
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
origin | 'tuple[float, float, float]' | no | (0.0, 0.0, 0.0) | Not explicitly described in the source docstring. |
x_axis | 'tuple[float, float, float]' | no | (1.0, 0.0, 0.0) | Not explicitly described in the source docstring. |
y_axis | 'tuple[float, float, float]' | no | (0.0, 1.0, 0.0) | Not explicitly described in the source docstring. |
z_axis | 'tuple[float, float, float]' | no | (0.0, 0.0, 1.0) | 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.
Data fields
| Name | Type | Default |
|---|---|---|
origin | 'tuple[float, float, float]' | (0.0, 0.0, 0.0) |
x_axis | 'tuple[float, float, float]' | (1.0, 0.0, 0.0) |
y_axis | 'tuple[float, float, float]' | (0.0, 1.0, 0.0) |
z_axis | 'tuple[float, float, float]' | (0.0, 0.0, 1.0) |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, data: 'dict[str, Sequence[float]]') -> "'CoordinateFrame'" | See the member signature. |
point | method | (self, value: 'Sequence[float]') -> 'tuple[float, float, float]' | See the member signature. |
to_dict | method | (self) -> 'dict[str, list[float]]' | See the member signature. |
vector | method | (self, value: 'Sequence[float]') -> 'tuple[float, float, float]' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import CoordinateFrame