Sketch

Sketch entities, references, geometric and dimensional constraints, solving, and profile lowering.

This catalog contains 47 public symbols. Select a symbol for its exact signature, parameters, return contract, errors, members, aliases, and behavior notes.

Modules

Symbol	Import	Summary
sketch	from cadflow import sketch	Sketch domain facade.

Classes

Symbol	Import	Summary
Sketch	from cadflow import Sketch	Declarative constrained sketch container.
SketchConstraint	from cadflow import SketchConstraint	Serializable constraint inside a declarative sketch.
SketchConstraintDiagnostic	from cadflow import SketchConstraintDiagnostic	Diagnostic emitted by the sketch solver.
SketchDocument	from cadflow import SketchDocument	Design-intent sketch with stable entity references and constraints.
SketchRef	from cadflow import SketchRef	Stable reference to a sketch entity or subentity.
SketchSolverBackend	from cadflow import SketchSolverBackend	Boundary implemented by a sketch constraint solver backend.
SketchSolveResult	from cadflow import SketchSolveResult	Backend-neutral result of solving a declarative sketch.
SketchSolverOptions	from cadflow import SketchSolverOptions	Backend-neutral options for one solve request.

Functions

Symbol	Import	Summary
add_arc_rsketch	from cadflow import add_arc_rsketch	Add an arc entity to a sketch.
add_bspline_rsketch	from cadflow import add_bspline_rsketch	Add a B-spline curve entity to a sketch.
add_circle_rsketch	from cadflow import add_circle_rsketch	Add a named circle entity and return an updated sketch document.
add_line_rsketch	from cadflow import add_line_rsketch	Add a named line entity and return an updated sketch document.
add_point_rsketch	from cadflow import add_point_rsketch	Add a named point entity and return an updated sketch document.
constrain_angle_rsketch	from cadflow import constrain_angle_rsketch	Add a driving angle constraint between two sketch lines.
constrain_coincident_rsketch	from cadflow import constrain_coincident_rsketch	Constrain two sketch points to be coincident.
constrain_collinear_rsketch	from cadflow import constrain_collinear_rsketch	Constrain two sketch lines to lie on the same infinite line.
constrain_concentric_rsketch	from cadflow import constrain_concentric_rsketch	Constrain two sketch circles to share a center.
constrain_connect_rsketch	from cadflow import constrain_connect_rsketch	Alias for constrain_coincident_rsketch using connection wording.
constrain_diameter_rsketch	from cadflow import constrain_diameter_rsketch	Add a driving circle or arc diameter constraint.
constrain_distance_rsketch	from cadflow import constrain_distance_rsketch	Add a driving point-to-point distance constraint.
constrain_distance_x_rsketch	from cadflow import constrain_distance_x_rsketch	Add a driving horizontal distance constraint.
constrain_distance_y_rsketch	from cadflow import constrain_distance_y_rsketch	Add a driving vertical distance constraint.
constrain_equal_length_rsketch	from cadflow import constrain_equal_length_rsketch	Constrain two sketch lines to have equal length.
constrain_equal_radius_rsketch	from cadflow import constrain_equal_radius_rsketch	Constrain two circles/arcs to have equal radius.
constrain_fix_rsketch	from cadflow import constrain_fix_rsketch	Fix a sketch point or entity to its initial coordinates.
constrain_horizontal_rsketch	from cadflow import constrain_horizontal_rsketch	Constrain a sketch line to be horizontal.
constrain_length_rsketch	from cadflow import constrain_length_rsketch	Add a driving length constraint to a line, arc, or B-spline.
constrain_midpoint_rsketch	from cadflow import constrain_midpoint_rsketch	Constrain a sketch point to the midpoint of a line.
constrain_parallel_rsketch	from cadflow import constrain_parallel_rsketch	Constrain two sketch lines to be parallel.
constrain_perpendicular_rsketch	from cadflow import constrain_perpendicular_rsketch	Constrain two sketch lines to be perpendicular.
constrain_point_on_rsketch	from cadflow import constrain_point_on_rsketch	Constrain a sketch point to lie on a line, circle, or circular arc.
constrain_radius_rsketch	from cadflow import constrain_radius_rsketch	Add a driving circle or arc radius constraint.
constrain_symmetric_rsketch	from cadflow import constrain_symmetric_rsketch	Constrain two sketch points to be symmetric about a line axis.
constrain_tangent_rsketch	from cadflow import constrain_tangent_rsketch	Constrain supported curves to be tangent on an explicit branch.
constrain_vertical_rsketch	from cadflow import constrain_vertical_rsketch	Constrain a sketch line to be vertical.
get_default_sketch_solver_backend	from cadflow import get_default_sketch_solver_backend	Return the process-wide default sketch solver backend.
get_sketch_entity_rsketchref	from cadflow import get_sketch_entity_rsketchref	Return a stable ref for a named sketch entity.
get_sketch_point_rsketchref	from cadflow import get_sketch_point_rsketchref	Return a stable ref for a sketch point or endpoint path.
get_sketch_solver_backend	from cadflow import get_sketch_solver_backend	Resolve a registered backend; omitted name selects the default.
inspect_sketch_rsketchresult	from cadflow import inspect_sketch_rsketchresult	Inspect sketch constraints by running the solver without recording graph nodes.
make_face_from_sketch_rface	from cadflow import make_face_from_sketch_rface	Promote one outer and optional inner sketch profiles to a face.
make_sketch_rsketch	from cadflow import make_sketch_rsketch	Create an empty declarative sketch document.
make_wire_from_sketch_rwire	from cadflow import make_wire_from_sketch_rwire	Promote a sketch profile to a concrete wire, solving internally.
register_sketch_solver_backend	from cadflow import register_sketch_solver_backend	Register a backend instance under its stable name.
set_default_sketch_solver_backend	from cadflow import set_default_sketch_solver_backend	Set the process-wide default by registered name or backend instance.
sketch_solver_backend	from cadflow import sketch_solver_backend	Temporarily select a default backend and restore it afterwards.