create_rectangle_wire
Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import create_rectangle_wire
Signature
def create_rectangle_wire(width: 'ScalarLike', height: 'ScalarLike', center: 'Tuple[ScalarLike, ScalarLike, ScalarLike]' = (0, 0, 0), normal: 'Tuple[ScalarLike, ScalarLike, ScalarLike]' = (0, 0, 1), *, tag_prefix: 'Optional[str]' = None, edge_tags: 'Optional[Sequence[str]]' = None) -> 'Wire'
Description
Create a rectangular wire.
Other public imports
from cadflow import make_rectangle_rwire
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
width | 'ScalarLike' | yes | - | Not explicitly described in the source docstring. |
height | 'ScalarLike' | yes | - | Not explicitly described in the source docstring. |
center | 'Tuple[ScalarLike, ScalarLike, ScalarLike]' | no | (0, 0, 0) | Not explicitly described in the source docstring. |
normal | 'Tuple[ScalarLike, ScalarLike, ScalarLike]' | no | (0, 0, 1) | Not explicitly described in the source docstring. |
tag_prefix | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
edge_tags | 'Optional[Sequence[str]]' | no | None | 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_rectangle_wire