Placement
Kind: Class
Domain: Assembly
Canonical import: from cadflow import Placement
Signature
class Placement(origin: 'Vec3', x_axis: 'Vec3' = (1.0, 0.0, 0.0), y_axis: 'Vec3' = (0.0, 1.0, 0.0), z_axis: 'Vec3' = (0.0, 0.0, 1.0), _metadata: 'Dict[str, Any]' = <factory>, _runtime: 'Dict[str, Any]' = <factory>) -> None
Description
Right-handed placement mapping child-local coordinates to parent coordinates.
Other public imports
from cadflow.assembly import Placement
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
origin | 'Vec3' | yes | - | Not explicitly described in the source docstring. |
x_axis | 'Vec3' | no | (1.0, 0.0, 0.0) | Not explicitly described in the source docstring. |
y_axis | 'Vec3' | no | (0.0, 1.0, 0.0) | Not explicitly described in the source docstring. |
z_axis | 'Vec3' | no | (0.0, 0.0, 1.0) | Not explicitly described in the source docstring. |
_metadata | 'Dict[str, Any]' | no | <factory> | Not explicitly described in the source docstring. |
_runtime | 'Dict[str, Any]' | no | <factory> | 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 | 'Vec3' | required |
x_axis | 'Vec3' | (1.0, 0.0, 0.0) |
y_axis | 'Vec3' | (0.0, 1.0, 0.0) |
z_axis | 'Vec3' | (0.0, 0.0, 1.0) |
_metadata | 'Dict[str, Any]' | factory |
_runtime | 'Dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
compose | method | (self, child: "'Placement'") -> "'Placement'" | See the member signature. |
to_dict | method | (self) -> 'Dict[str, Any]' | See the member signature. |
transform_point | method | (self, point: 'Vec3') -> 'Vec3' | See the member signature. |
transform_vector | method | (self, vector: 'Vec3') -> 'Vec3' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import Placement