This index includes generated docs for the public SimpleCAD API surface, including geometry operations, graph/model JSON workflows, inspection tools, expressions, QL, and export helpers.
- Entries marked
top-levelare exported fromsimplecadapiand can be imported withfrom simplecadapi import <name>. - Entries marked
submoduleare public through the listed submodule, such assimplecadapi.ql. - Entries marked
inspection namespaceare available throughsimplecadapi.inspect.brepand cannot run insideGraphSessionor@model. - Entries marked
translator backendare public only throughsimplecadapi.translator.<backend>.
- 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_bezier_surface_rface (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_gordon_surface_rface (from operations.py)
top-level - make_helix_redge (from operations.py)
top-level - make_helix_rwire (from operations.py)
top-level - make_interpolated_spline_redge (from operations.py)
top-level - make_interpolated_spline_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_periodic_spline_rwire (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_ruled_surface_rface (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_surface_patch_rface (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
- mirror_shape (from operations.py)
top-level - rotate_shape (from operations.py)
top-level - translate_shape (from operations.py)
top-level
- extrude_rsolid (from operations.py)
top-level - loft_rshell (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
- apply_tag (from operations.py)
top-level - apply_tag_rselection (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
- cut_rsolid (from operations.py)
top-level - intersect_rsolid (from operations.py)
top-level - union_rsolid (from operations.py)
top-level
- export_step (from operations.py)
top-level - export_stl (from operations.py)
top-level
- FreeCADScriptTranslator (from translator/freecad_translator/translator.py)
translator backend - FreeCADTranslator (from translator/freecad_translator/translator.py)
translator backend - Fusion360Translator (from translator/fusion360_translator/translator.py)
translator backend - SolidWorksTranslator (from translator/solidworks_translator/translator.py)
translator backend - export_model_json_to_fcstd (from translator/freecad_translator/api.py)
translator backend - export_model_json_to_solidworks_step (from translator/solidworks_translator/api.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 - translate_model_json_to_fusion360_script (from translator/fusion360_translator/api.py)
translator backend - translate_model_json_to_solidworks_script (from translator/solidworks_translator/api.py)
translator backend
- BSplineFitResult (from math.py)
top-level - fit_cubic_bspline_control_points (from math.py)
top-level
- GraphSession (from graph.py)
top-level - ModelResult (from graph.py)
top-level - capture_result (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 - get_active_session (from graph.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 - model (from graph.py)
top-level - replay_graph (from serializer.py)
top-level - replay_model_json (from serializer.py)
top-level - requires_session (from graph.py)
top-level - suspend_graph_recording (from graph.py)
top-level
- Const (from expr.py)
top-level - DimensionTolerance (from expr.py)
top-level - Expr (from expr.py)
top-level - ExpressionGraph (from expr.py)
top-level - ToleranceAnalysis (from tolerance.py)
top-level - ToleranceAnalysisError (from tolerance.py)
top-level - ToleranceCheck (from tolerance.py)
top-level - ToleranceContribution (from tolerance.py)
top-level - ToleranceGraph (from tolerance.py)
top-level - ToleranceReport (from tolerance.py)
top-level - ToleranceRequirement (from tolerance.py)
top-level - ToleranceValidationError (from tolerance.py)
top-level - Var (from expr.py)
top-level - analyze_tolerance (from tolerance.py)
top-level - check_tolerance (from tolerance.py)
top-level - const (from expr.py)
top-level - var (from expr.py)
top-level
- Dimension (from units.py)
top-level - Unit (from units.py)
top-level - UnitValidationError (from units.py)
top-level - canonical_unit_for_dimension (from units.py)
top-level - convert_value (from units.py)
top-level - expression_uses_units (from units.py)
top-level - get_unit (from units.py)
top-level - infer_dimension (from units.py)
top-level
- 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
- 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
- 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
- BRepComparison (from inspect/brep/compare.py)
inspection namespace - BRepEntityError (from inspect/brep/model.py)
inspection namespace - BRepInspection (from inspect/brep/inspect.py)
inspection namespace - BRepModel (from inspect/brep/model.py)
inspection namespace - EntityInspectionParity (from inspect/brep/parity.py)
inspection namespace - InspectionSummaryComparison (from inspect/brep/compare.py)
inspection namespace - SliceSpec (from inspect/brep/slices.py)
inspection namespace - clear_step_model_cache_rnone (from inspect/brep/model.py)
inspection namespace - compare_boundary_distance_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - compare_entities_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - compare_global_properties_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - compare_inspections_rinspectionsummarycomparison (from inspect/brep/compare.py)
inspection namespace - compare_material_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - compare_model_to_inspection_rentityinspectionparity (from inspect/brep/parity.py)
inspection namespace - compare_sections_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - compare_shape_slices_rslicecomparison (from inspect/brep/slices.py)
inspection namespace - compare_shapes_rbrepcomparison (from inspect/brep/compare.py)
inspection namespace - compare_step_slices_rslicecomparison (from inspect/brep/slices.py)
inspection namespace - compare_step_to_inspection_rentityinspectionparity (from inspect/brep/parity.py)
inspection namespace - compare_steps_rbrepcomparison (from inspect/brep/compare.py)
inspection namespace - evaluate_reconstruction_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - index_shape_rbrepmodel (from inspect/brep/model.py)
inspection namespace - inspect_difference_regions_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - inspect_face_boundaries_rdescriptor (from inspect/brep/queries.py)
inspection namespace - inspect_nearby_entities_rdescriptor (from inspect/brep/diagnostics.py)
inspection namespace - inspect_point_rdescriptor (from inspect/brep/queries.py)
inspection namespace - inspect_section_rdescriptor (from inspect/brep/queries.py)
inspection namespace - inspect_shape_rbrepinspection (from inspect/brep/inspect.py)
inspection namespace - inspect_step_components_rdescriptorlist (from inspect/brep/render.py)
inspection namespace - inspect_step_entity_rdescriptor (from inspect/brep/model.py)
inspection namespace - inspect_step_rbrepinspection (from inspect/brep/inspect.py)
inspection namespace - inspect_step_rsummary (from inspect/brep/model.py)
inspection namespace - inspect_topology_neighborhood_rdescriptor (from inspect/brep/queries.py)
inspection namespace - load_step_rbrepmodel (from inspect/brep/model.py)
inspection namespace - load_step_rshape (from inspect/brep/io.py)
inspection namespace - make_center_slice_specs_rslicespeclist (from inspect/brep/slices.py)
inspection namespace - measure_entity_relation_rdescriptor (from inspect/brep/queries.py)
inspection namespace - measure_shape_mass_rtuple (from inspect/brep/io.py)
inspection namespace - render_entity_kind_maps_rpath (from inspect/brep/render.py)
inspection namespace - render_entity_map_rpath (from inspect/brep/render.py)
inspection namespace - render_region_rpath (from inspect/brep/render.py)
inspection namespace - render_shape_views_rpath (from inspect/brep/render.py)
inspection namespace - render_step_components_colored_rpath (from inspect/brep/render.py)
inspection namespace - render_step_components_rpath (from inspect/brep/render.py)
inspection namespace - render_step_views_rpath (from inspect/brep/render.py)
inspection namespace - select_region_entities_rdescriptor (from inspect/brep/queries.py)
inspection namespace
- 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 - SurfaceBoundary (from operations.py)
top-level - SurfaceFillingSettings (from operations.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 - explain_tag (from operations.py)
top-level - fill_holes_rshell (from operations.py)
top-level - fit_point_grid_rface (from operations.py)
top-level - forward_connector_rassembly (from operations.py)
top-level - free_boundaries_rwirelist (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 - operation_event (from ql.py)
submodule:ql - or_ (from ql.py)
submodule:ql - origin_role (from ql.py)
submodule:ql - output_role (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 - sew_faces_rshell (from operations.py)
top-level - shells (from ql.py)
submodule:ql - solve_assembly_constraints_rassembly (from operations.py)
top-level - source_binding (from ql.py)
submodule:ql - source_topology (from ql.py)
submodule:ql - tag (from ql.py)
submodule:ql - twisted_sweep_rsolid (from operations.py)
top-level - unground_component_rassembly (from operations.py)
top-level - value (from ql.py)
submodule:ql