twisted_sweep_rsolid
Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import twisted_sweep_rsolid
Signature
def twisted_sweep_rsolid(profile: 'Face', distance: 'ScalarLike', twist_angle: 'ScalarLike', axis: 'Tuple[float, float, float]' = (0.0, 0.0, 1.0), origin: 'Tuple[float, float, float]' = (0.0, 0.0, 0.0), *, guide_radius: 'ScalarLike' = 1.0, tag_prefix: 'Optional[str]' = None, result_tag: 'Optional[str]' = None, start_face_tag: 'Optional[str]' = None, end_face_tag: 'Optional[str]' = None, side_faces_tag: 'Optional[str]' = None) -> 'Solid'
Description
Sweep a planar profile along a straight axis with linear rotation.
Sweep a planar profile along a straight axis with linear rotation.
twist_angle is the signed total rotation in degrees. The operation uses a cylindrical auxiliary spine to define a continuous rotation law, yielding one continuous side face per profile edge instead of a segmented ruled loft.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
profile | 'Face' | yes | - | Not explicitly described in the source docstring. |
distance | 'ScalarLike' | yes | - | Not explicitly described in the source docstring. |
twist_angle | 'ScalarLike' | yes | - | Not explicitly described in the source docstring. |
axis | 'Tuple[float, float, float]' | no | (0.0, 0.0, 1.0) | Not explicitly described in the source docstring. |
origin | 'Tuple[float, float, float]' | no | (0.0, 0.0, 0.0) | Not explicitly described in the source docstring. |
guide_radius | 'ScalarLike' | no | 1.0 | Not explicitly described in the source docstring. |
tag_prefix | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
result_tag | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
start_face_tag | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
end_face_tag | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
side_faces_tag | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'Solid'
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 twisted_sweep_rsolid