Skip to main content

constrain_tangent_rsketch

Kind: Function
Domain: Sketch
Canonical import: from cadflow import constrain_tangent_rsketch

Signature

def constrain_tangent_rsketch(sketch: 'Sketch', a: 'Union[SketchRef, str]', b: 'Union[SketchRef, str]', *, at_a: 'Optional[str]' = None, at_b: 'Optional[str]' = None, mode: 'str' = 'external', constraint_id: 'Optional[str]' = None) -> 'Sketch'

Description

Constrain supported curves to be tangent on an explicit branch.

Constrain supported curves to be tangent on an explicit branch.

at_a/at_b select "start" or "end" for arc and B-spline endpoint tangency. Circle-circle tangency accepts mode="external" or mode="internal".

Parameters

NameTypeRequiredDefaultSource 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.
at_a'Optional[str]'noNoneNot explicitly described in the source docstring.
at_b'Optional[str]'noNoneNot explicitly described in the source docstring.
mode'str'no'external'Not explicitly described in the source docstring.
constraint_id'Optional[str]'noNoneNot 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_tangent_rsketch

See also