constrain_distance_rsketch
Kind: Function
Domain: Sketch
Canonical import: from cadflow import constrain_distance_rsketch
Signature
def constrain_distance_rsketch(sketch: 'Sketch', a: 'Union[SketchRef, str]', b: 'Union[SketchRef, str]', value: 'ScalarLike', *, constraint_id: 'Optional[str]' = None, driving: 'bool' = True) -> 'Sketch'
Description
Add a driving point-to-point distance constraint.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
sketch | 'Sketch' | yes | - | Not explicitly described in the source docstring. |
a | 'Union[SketchRef, str]' | yes | - | Not explicitly described in the source docstring. |
b | 'Union[SketchRef, str]' | yes | - | Not explicitly described in the source docstring. |
value | 'ScalarLike' | yes | - | Not explicitly described in the source docstring. |
constraint_id | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
driving | 'bool' | no | True | Not explicitly described in the source docstring. |
Returns
Type: 'Sketch'
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 constrain_distance_rsketch