This index includes generated docs for the public SimpleCAD API surface, including geometry operations, graph/model JSON workflows, expressions, QL, and export helpers.

Import Surfaces

Entries marked top-level are exported from simplecadapi and can be imported with from simplecadapi import <name>.
Entries marked submodule are public through the listed submodule, such as simplecadapi.ql.
Entries marked translator backend are public only through simplecadapi.translator.<backend>.

Basic Creation

make_2d_cut_rface (from operations.py) top-level
make_2d_intersect_rface (from operations.py) top-level
make_2d_union_rface (from operations.py) top-level
make_angle_arc_redge (from operations.py) top-level
make_angle_arc_rwire (from operations.py) top-level
make_assembly_rassembly (from operations.py) top-level
make_box_rsolid (from operations.py) top-level
make_circle_redge (from operations.py) top-level
make_circle_rface (from operations.py) top-level
make_circle_rwire (from operations.py) top-level
make_compound_from_assembly_rcompound (from operations.py) top-level
make_cone_rsolid (from operations.py) top-level
make_connector_ref_rconnectorref (from operations.py) top-level
make_cylinder_rsolid (from operations.py) top-level
make_edge_connector_rconnector (from operations.py) top-level
make_face_connector_rconnector (from operations.py) top-level
make_face_from_sketch_rface (from operations.py) top-level
make_face_from_wire_rface (from operations.py) top-level
make_face_from_wires_rface (from operations.py) top-level
make_helix_redge (from operations.py) top-level
make_helix_rwire (from operations.py) top-level
make_line_redge (from operations.py) top-level
make_material_rmaterial (from operations.py) top-level
make_part_rpart (from operations.py) top-level
make_placement_connector_rconnector (from operations.py) top-level
make_placement_rplacement (from operations.py) top-level
make_point_rvertex (from operations.py) top-level
make_polyline_rwire (from operations.py) top-level
make_rectangle_rface (from operations.py) top-level
make_rectangle_rwire (from operations.py) top-level
make_scalar_limit_rscalarlimit (from operations.py) top-level
make_segment_redge (from operations.py) top-level
make_segment_rwire (from operations.py) top-level
make_sketch_rsketch (from operations.py) top-level
make_sphere_rsolid (from operations.py) top-level
make_spline_redge (from operations.py) top-level
make_spline_rwire (from operations.py) top-level
make_three_point_arc_redge (from operations.py) top-level
make_three_point_arc_rwire (from operations.py) top-level
make_vertex_connector_rconnector (from operations.py) top-level
make_wire_from_edges_rwire (from operations.py) top-level
make_wire_from_sketch_rwire (from operations.py) top-level

Transforms

mirror_shape (from operations.py) top-level
rotate_shape (from operations.py) top-level
translate_shape (from operations.py) top-level

3D Operations

extrude_rsolid (from operations.py) top-level
loft_rsolid (from operations.py) top-level
revolve_rsolid (from operations.py) top-level
sweep_rsolid (from operations.py) top-level

Tagging and Selection

apply_tag (from operations.py) top-level
list_tags (from operations.py) top-level
select_edges_by_tag (from operations.py) top-level
select_faces_by_tag (from operations.py) top-level

Boolean Operations

cut_rsolid (from operations.py) top-level
intersect_rsolid (from operations.py) top-level
union_rsolid (from operations.py) top-level

Export

export_step (from operations.py) top-level
export_stl (from operations.py) top-level

FreeCAD Translation

FreeCADScriptTranslator (from translator/freecad_translator/script_translator.py) translator backend
translate_model_json_to_fcstd (from translator/freecad_translator/api.py) translator backend
translate_model_json_to_freecad_script (from translator/freecad_translator/api.py) translator backend

Math Helpers

BSplineFitResult (from math.py) top-level
fit_cubic_bspline_control_points (from math.py) top-level

Modeling Graph and Replay

GraphSession (from graph.py) top-level
export_graph_json (from serializer.py) top-level
export_model_json (from serializer.py) top-level
export_session_json (from serializer.py) top-level
import_graph_json (from serializer.py) top-level
import_model_json (from serializer.py) top-level
import_session_json (from serializer.py) top-level
replay_graph (from serializer.py) top-level
replay_model_json (from serializer.py) top-level
suspend_graph_recording (from graph.py) top-level

Expressions and Parameters

Const (from expr.py) top-level
Expr (from expr.py) top-level
ExpressionGraph (from expr.py) top-level
Var (from expr.py) top-level
const (from expr.py) top-level
var (from expr.py) top-level

Types and Errors

SimpleCADError (from errors.py) top-level
Sketch (from sketch.py) top-level
SketchConstraint (from sketch.py) top-level
SketchConstraintDiagnostic (from sketch.py) top-level
SketchRef (from sketch.py) top-level
SketchSolveResult (from sketch.py) top-level

Advanced Features

chamfer_rsolid (from operations.py) top-level
fillet_rsolid (from operations.py) top-level
helical_sweep_rsolid (from operations.py) top-level
shell_rsolid (from operations.py) top-level

Evolve

make_n_hole_flange_rsolid (from evolve.py) top-level
make_naca_propeller_blade_rsolid (from evolve.py) top-level
make_threaded_rod_rsolid (from evolve.py) top-level

Other

Assembly (from product.py) top-level
Component (from product.py) top-level
Connector (from product.py) top-level
ConnectorAnchor (from product.py) top-level
ConnectorRef (from product.py) top-level
Constraint (from product.py) top-level
ConstraintReport (from product.py) top-level
ConstraintResidual (from product.py) top-level
GeometryRef (from product.py) top-level
Material (from product.py) top-level
Part (from product.py) top-level
Placement (from product.py) top-level
ScalarLimit (from product.py) top-level
SemanticDelta (from topology.py) top-level
SemanticRef (from topology.py) top-level
add_arc_rsketch (from operations.py) top-level
add_belt_constraint_rassembly (from operations.py) top-level
add_bspline_rsketch (from operations.py) top-level
add_circle_rsketch (from operations.py) top-level
add_component_rassembly (from operations.py) top-level
add_connector_rassembly (from operations.py) top-level
add_connector_rpart (from operations.py) top-level
add_fixed_constraint_rassembly (from operations.py) top-level
add_gear_constraint_rassembly (from operations.py) top-level
add_line_rsketch (from operations.py) top-level
add_point_rsketch (from operations.py) top-level
add_prismatic_constraint_rassembly (from operations.py) top-level
add_rack_pinion_constraint_rassembly (from operations.py) top-level
add_revolute_constraint_rassembly (from operations.py) top-level
and_ (from ql.py) submodule:ql
assign_material_rpart (from operations.py) top-level
constrain_angle_rsketch (from operations.py) top-level
constrain_coincident_rsketch (from operations.py) top-level
constrain_collinear_rsketch (from operations.py) top-level
constrain_concentric_rsketch (from operations.py) top-level
constrain_connect_rsketch (from operations.py) top-level
constrain_diameter_rsketch (from operations.py) top-level
constrain_distance_rsketch (from operations.py) top-level
constrain_distance_x_rsketch (from operations.py) top-level
constrain_distance_y_rsketch (from operations.py) top-level
constrain_equal_length_rsketch (from operations.py) top-level
constrain_equal_radius_rsketch (from operations.py) top-level
constrain_fix_rsketch (from operations.py) top-level
constrain_horizontal_rsketch (from operations.py) top-level
constrain_length_rsketch (from operations.py) top-level
constrain_midpoint_rsketch (from operations.py) top-level
constrain_parallel_rsketch (from operations.py) top-level
constrain_perpendicular_rsketch (from operations.py) top-level
constrain_point_on_rsketch (from operations.py) top-level
constrain_radius_rsketch (from operations.py) top-level
constrain_symmetric_rsketch (from operations.py) top-level
constrain_tangent_rsketch (from operations.py) top-level
constrain_vertical_rsketch (from operations.py) top-level
forward_connector_rassembly (from operations.py) top-level
geo (from ql.py) submodule:ql
get_sketch_entity_rsketchref (from operations.py) top-level
get_sketch_point_rsketchref (from operations.py) top-level
ground_component_rassembly (from operations.py) top-level
identity_placement_rplacement (from operations.py) top-level
inspect_assembly_constraints_rconstraintreport (from operations.py) top-level
inspect_sketch_rsketchresult (from operations.py) top-level
linear_pattern_rsolidlist (from operations.py) top-level
measure_constraint_residual_rconstraintresidual (from operations.py) top-level
meta (from ql.py) submodule:ql
not_ (from ql.py) submodule:ql
or_ (from ql.py) submodule:ql
place_component_rassembly (from operations.py) top-level
radial_pattern_rsolidlist (from operations.py) top-level
render_screenshot_rpath (from operations.py) top-level
select (from ql.py) submodule:ql
solve_assembly_constraints_rassembly (from operations.py) top-level
tag (from ql.py) submodule:ql
unground_component_rassembly (from operations.py) top-level
value (from ql.py) submodule:ql