Skip to main content

make_sketch_rsketch

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

Signature

def make_sketch_rsketch(name: 'Optional[str]' = None, *, plane: 'Any' = 'XY', sketch_id: 'Optional[str]' = None) -> 'Sketch'

Description

Create an empty declarative sketch document.

Create an empty declarative sketch document.

Use this API, not concrete edge/wire constructors, when the intent is to build a sketch profile with constraints.

Parameters

NameTypeRequiredDefaultSource description
name'Optional[str]'noNoneNot explicitly described in the source docstring.
plane'Any'no'XY'Not explicitly described in the source docstring.
sketch_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 make_sketch_rsketch

See also