Skip to main content

Modeling and geometry

Geometry creation, features, booleans, transforms, topology, selection, measurement, and exchange.

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

Modules

SymbolImportSummary
modelingfrom cadflow import modelingModeling domain facade; implementations are selected by the backend.
queryfrom cadflow import queryTopology query language domain facade.
surfacesfrom cadflow import surfacesSurface modeling domain facade.
topologyfrom cadflow import topologyTopology history and tracking data domain facade.

Classes

SymbolImportSummary
Compoundfrom cadflow import CompoundOCP-native compound wrapper for explicit multi-shape projections.
CoordinateSystemfrom cadflow import CoordinateSystemThree-dimensional coordinate system.
Edgefrom cadflow import EdgeOCP-native edge wrapper with tag support.
Facefrom cadflow import FaceOCP-native face wrapper with tag support.
SemanticDeltafrom cadflow import SemanticDeltaSemantic entity change set attached to a single recorded operation.
SemanticReffrom cadflow import SemanticRefStable reference to a semantic model entity in the recorded graph.
Shellfrom cadflow import ShellOCP-native connected surface shell with face and edge topology.
SimpleWorkplanefrom cadflow import SimpleWorkplaneWorkplane context manager defining a local coordinate system.
Solidfrom cadflow import SolidOCP-native solid wrapper with tag support.
SurfaceBoundaryfrom cadflow import SurfaceBoundaryOne edge constraint used by make_surface_patch_rface.
SurfaceFillingSettingsfrom cadflow import SurfaceFillingSettingsExplicit OCCT filling controls; units are model units and radians.
TaggedMixinfrom cadflow import TaggedMixinTag mixin that provides tagging support for geometry objects.
Vertexfrom cadflow import VertexOCP-native vertex wrapper with tag support.
Wirefrom cadflow import WireOCP-native wire wrapper with tag support.

Functions

SymbolImportSummary
apply_tagfrom cadflow import apply_tagAttach a local user tag with continuation/fragment lineage policy.
apply_tag_rselectionfrom cadflow import apply_tag_rselectionReturn a semantic shape view with a canonical tag assignment.
assign_material_rpartfrom cadflow import assign_material_rpartAssign a Material to a Part and return the updated Part.
chamfer_rsolidfrom cadflow import chamfer_rsolidApply chamfers, with optional tagging of kernel-proven patch faces.
create_angle_arcfrom cadflow import create_angle_arcCreate an arc edge from a center, radius, and angle range.
create_angle_arc_wirefrom cadflow import create_angle_arc_wireCreate a wire containing an arc defined by a center, radius, and angle range.
create_arcfrom cadflow import create_arcCreate an arc edge from three points.
create_arc_wirefrom cadflow import create_arc_wireCreate a wire containing an arc defined by three points.
create_boxfrom cadflow import create_boxCreate a box with native kernel-backed Face topology tags.
create_circle_edgefrom cadflow import create_circle_edgeCreate a circular edge.
create_circle_facefrom cadflow import create_circle_faceCreate a circular face.
create_circle_wirefrom cadflow import create_circle_wireCreate a circular wire.
create_cylinderfrom cadflow import create_cylinderCreate a cylinder with native kernel-backed Face and Edge topology tags.
create_face_from_wirefrom cadflow import create_face_from_wireCreate a face from a closed wire.
create_face_from_wiresfrom cadflow import create_face_from_wiresCreate a face from one outer closed wire and optional inner closed wires.
create_helixfrom cadflow import create_helixCreate a helix edge.
create_helix_wirefrom cadflow import create_helix_wireCreate a helix wire.
create_interpolated_splinefrom cadflow import create_interpolated_splineInterpolate an exact B-spline edge through the supplied points.
create_interpolated_spline_wirefrom cadflow import create_interpolated_spline_wireCreate a one-edge wire that interpolates the supplied points.
create_linefrom cadflow import create_lineCreate a straight edge between two points.
create_periodic_spline_wirefrom cadflow import create_periodic_spline_wireCreate a closed periodic spline wire interpolating the supplied points.
create_pointfrom cadflow import create_pointCreate a point in 3D space and return it as a vertex.
create_polyline_wirefrom cadflow import create_polyline_wireCreate a polyline wire from a point list.
create_rectangle_facefrom cadflow import create_rectangle_faceCreate a rectangular face.
create_rectangle_wirefrom cadflow import create_rectangle_wireCreate a rectangular wire.
create_segmentfrom cadflow import create_segmentAlias of make_line_redge that returns a straight edge.
create_segment_wirefrom cadflow import create_segment_wireCreate a wire containing a single straight segment.
create_spherefrom cadflow import create_sphereCreate a sphere solid.
create_splinefrom cadflow import create_splineCreate an exact B-spline edge from named control-point parameters.
create_spline_wirefrom cadflow import create_spline_wireCreate a wire containing one exact B-spline edge.
create_wire_from_edgesfrom cadflow import create_wire_from_edgesCreate a wire from a list of connected edges.
cutfrom cadflow import cutCompute the boolean difference of solids.
explain_tagfrom cadflow import explain_tagExplain every visible binding that produces a tag token.
export_stepfrom cadflow import export_stepExport shapes to STEP.
export_stlfrom cadflow import export_stlExport shapes to STL.
extrudefrom cadflow import extrudeCreate a solid by extruding a profile, with optional role-based tags.
fill_holes_rshellfrom cadflow import fill_holes_rshellFill selected closed free boundaries and return a sewn Shell.
fillet_rsolidfrom cadflow import fillet_rsolidApply fillets, with optional tagging of kernel-proven patch faces.
fit_point_grid_rfacefrom cadflow import fit_point_grid_rfaceFit a B-spline Face through a rectangular 3D point grid.
free_boundaries_rwirelistfrom cadflow import free_boundaries_rwirelistReturn unique closed and open free boundary wires of a Shell.
get_current_csfrom cadflow import get_current_csPublic function in this domain.
helical_sweep_rsolidfrom cadflow import helical_sweep_rsolidCreate a solid by sweeping a profile along a helical path.
intersectfrom cadflow import intersectCompute the boolean intersection of solids.
linear_pattern_rsolidlistfrom cadflow import linear_pattern_rsolidlistCreate a linear pattern of solids.
list_tagsfrom cadflow import list_tagsReturn shape tags in deterministic sorted order for one scope.
loft_rshellfrom cadflow import loft_rshellCreate an open loft Shell with endpoint-Wire and side-Face naming.
loft_rsolidfrom cadflow import loft_rsolidCreate a lofted solid, with optional kernel-role-based tags.
make_2d_cut_rfacefrom cadflow import make_2d_cut_rfaceSubtract one 2D face from another (2D boolean difference).
make_2d_intersect_rfacefrom cadflow import make_2d_intersect_rfaceCompute the boolean intersection of two 2D faces.
make_2d_union_rfacefrom cadflow import make_2d_union_rfaceCompute the boolean union of two 2D faces.
make_bezier_surface_rfacefrom cadflow import make_bezier_surface_rfaceCreate a trimmed Face carrying a tensor-product Bezier surface.
make_cone_rsolidfrom cadflow import make_cone_rsolidCreate a cone or frustum with native kernel-backed topology tags.
make_gordon_surface_rfacefrom cadflow import make_gordon_surface_rfaceCreate a Gordon Face from intersecting profile and guide edge networks.
make_material_rmaterialfrom cadflow import make_material_rmaterialCreate a material definition for later Part assignment.
make_n_hole_flange_rsolidfrom cadflow import make_n_hole_flange_rsolidCreate an n-hole flange with a raised boss ring and optional chamfers. The center of the bottom face is placed at the origin.
make_naca_propeller_blade_rsolidfrom cadflow import make_naca_propeller_blade_rsolidCreate a single propeller blade solid from a twisted NACA 0016 profile. The blade root starts at the origin and extends along +Z.
make_part_rpartfrom cadflow import make_part_rpartWrap exactly one Solid as a semantic single-body Part.
make_ruled_surface_rfacefrom cadflow import make_ruled_surface_rfaceCreate a ruled Face spanning two compatible edges.
make_scalar_limit_rscalarlimitfrom cadflow import make_scalar_limit_rscalarlimitCreate a closed scalar limit for driven constraint coordinates.
make_surface_patch_rfacefrom cadflow import make_surface_patch_rfaceFill a constrained boundary network into one Face, optionally with holes.
make_threaded_rod_rsolidfrom cadflow import make_threaded_rod_rsolidCreate a threaded rod with configurable rod length, thread span, and pitch. The top center is placed at the origin and the rod extends in -Z.
measure_constraint_residual_rconstraintresidualfrom cadflow import measure_constraint_residual_rconstraintresidualMeasure residual for one assembly constraint without mutating the assembly.
mirror_shapefrom cadflow import mirror_shapeMirror a shape across a plane.
radial_pattern_rsolidlistfrom cadflow import radial_pattern_rsolidlistCreate a radial pattern of solids.
render_screenshot_rpathfrom cadflow import render_screenshot_rpathRender SDK solids through the shared OCCT/VTK BREP renderer.
revolvefrom cadflow import revolveCreate a revolved solid, with optional kernel-role-based tags.
rotatefrom cadflow import rotateRotate a shape around an axis.
select_edges_by_tagfrom cadflow import select_edges_by_tagSelect edges by tag.
select_faces_by_tagfrom cadflow import select_faces_by_tagSelect faces by tag.
sew_faces_rshellfrom cadflow import sew_faces_rshellSew faces into exactly one connected Shell.
shell_rsolidfrom cadflow import shell_rsolidShell a solid, with optional kernel-role-based face tags.
sweep_rsolidfrom cadflow import sweep_rsolidCreate a swept solid, with optional kernel-role-based tags.
translatefrom cadflow import translateTranslate a shape by an offset vector.
twisted_sweep_rsolidfrom cadflow import twisted_sweep_rsolidSweep a planar profile along a straight axis with linear rotation.
unionfrom cadflow import unionCompute the boolean union and return one manifold solid.

Constants

SymbolImportSummary
WORLD_CSfrom cadflow import WORLD_CSThree-dimensional coordinate system.