Assembly

Parts, components, placements, connectors, assembly constraints, and solve reports.

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

Modules

Symbol	Import	Summary
assembly	from cadflow import assembly	Product and assembly domain facade.

Classes

Symbol	Import	Summary
Assembly	from cadflow import Assembly	Product structure containing placed Part or subassembly components.
Component	from cadflow import Component	Assembly-local instance of a Part or subassembly.
Connector	from cadflow import Connector	Semantic datum frame anchored by geometry, placement, or forwarding.
ConnectorAnchor	from cadflow import ConnectorAnchor	Serializable source for a connector datum frame.
ConnectorBindingDocument	from cadflow.scene import ConnectorBindingDocument	ConnectorBindingDocument(value: 'DocumentValue | Mapping[str, Any]') -> 'None'
ConnectorRef	from cadflow import ConnectorRef	Reference to a connector through a component instance.
Constraint	from cadflow import Constraint	Connector-to-connector assembly constraint.
ConstraintReport	from cadflow import ConstraintReport	Assembly constraint inspection report.
ConstraintResidual	from cadflow import ConstraintResidual	Residual for a single assembly constraint.
GeometryRef	from cadflow import GeometryRef	Serializable reference to a sub-shape selected via QL.
Material	from cadflow import Material	Material definition assigned to a Part through assign_material_rpart.
Part	from cadflow import Part	Single-body product item wrapping exactly one Solid.
Placement	from cadflow import Placement	Right-handed placement mapping child-local coordinates to parent coordinates.
ScalarLimit	from cadflow import ScalarLimit	Closed scalar range for a constraint drive coordinate.

Functions

Symbol	Import	Summary
add_belt_constraint_rassembly	from cadflow import add_belt_constraint_rassembly	Couple two revolute axes as belt-linked pulleys with same-direction rotation.
add_component_rassembly	from cadflow import add_component_rassembly	Add a placed Part or subassembly component instance to an Assembly.
add_connector_rassembly	from cadflow import add_connector_rassembly	Attach a connector datum frame to an Assembly definition.
add_connector_rpart	from cadflow import add_connector_rpart	Attach a connector datum frame to a Part definition.
add_fixed_constraint_rassembly	from cadflow import add_fixed_constraint_rassembly	Constrain two component connectors to the same frame.
add_gear_constraint_rassembly	from cadflow import add_gear_constraint_rassembly	Couple two revolute axes as meshing gears with inverse rotation.
add_prismatic_constraint_rassembly	from cadflow import add_prismatic_constraint_rassembly	Constrain two connectors as a prismatic slider pair.
add_rack_pinion_constraint_rassembly	from cadflow import add_rack_pinion_constraint_rassembly	Couple a prismatic rack axis to a revolute pinion axis.
add_revolute_constraint_rassembly	from cadflow import add_revolute_constraint_rassembly	Constrain two connectors as a revolute axis pair.
assert_connector_binding	from cadflow.scene import assert_connector_binding	Public function in this domain.
compose_placements	from cadflow.assembly import compose_placements	Public function in this domain.
forward_connector_rassembly	from cadflow import forward_connector_rassembly	Expose an internal component connector as an assembly-level connector.
ground_component_rassembly	from cadflow import ground_component_rassembly	Ground a component at its current authored placement.
identity_placement	from cadflow.assembly import identity_placement	Public function in this domain.
identity_placement_rplacement	from cadflow import identity_placement_rplacement	Create the identity placement of the active workplane.
inspect_assembly_constraints	from cadflow.assembly import inspect_assembly_constraints	Public function in this domain.
inspect_assembly_constraints_rconstraintreport	from cadflow import inspect_assembly_constraints_rconstraintreport	Inspect all assembly constraint residuals without mutating the assembly.
inspect_step_components_rdescriptorlist	from cadflow.inspect.brep import inspect_step_components_rdescriptorlist	List targetable XCAF component occurrences with unique hierarchy paths.
inverse_placement	from cadflow.assembly import inverse_placement	Public function in this domain.
make_assembly_rassembly	from cadflow import make_assembly_rassembly	Create an empty assembly product structure.
make_compound_from_assembly_rcompound	from cadflow import make_compound_from_assembly_rcompound	Project an Assembly into an explicit flattened Compound geometry value.
make_connector_ref_rconnectorref	from cadflow import make_connector_ref_rconnectorref	Reference a connector through a component instance.
make_edge_connector_rconnector	from cadflow import make_edge_connector_rconnector	Create a connector anchored to an Edge.
make_face_connector_rconnector	from cadflow import make_face_connector_rconnector	Create a connector anchored to a Face.
make_placement_connector_rconnector	from cadflow import make_placement_connector_rconnector	Create a connector anchored to an explicit local placement frame.
make_placement_rplacement	from cadflow import make_placement_rplacement	Create a canonical right-handed placement in the active workplane.
make_vertex_connector_rconnector	from cadflow import make_vertex_connector_rconnector	Create a connector anchored to a Vertex.
measure_constraint_residual	from cadflow.assembly import measure_constraint_residual	Public function in this domain.
place_component_rassembly	from cadflow import place_component_rassembly	Move an existing assembly component by replacing its placement.
relative_placement	from cadflow.assembly import relative_placement	Public function in this domain.
render_step_components_colored_rpath	from cadflow.inspect.brep import render_step_components_colored_rpath	Render multiple STEP components, each in its own color.
render_step_components_rpath	from cadflow.inspect.brep import render_step_components_rpath	Render named XCAF component occurrences, optionally in assembly context.
resolve_connector_placement	from cadflow.assembly import resolve_connector_placement	Public function in this domain.
rotate_z_placement	from cadflow.assembly import rotate_z_placement	Public function in this domain.
solve_assembly_constraints	from cadflow.assembly import solve_assembly_constraints	Public function in this domain.
solve_assembly_constraints_rassembly	from cadflow import solve_assembly_constraints_rassembly	Solve fixed, revolute, and prismatic assembly constraints.
translate_z_placement	from cadflow.assembly import translate_z_placement	Public function in this domain.
unground_component_rassembly	from cadflow import unground_component_rassembly	Remove a component grounding marker.
validate_connector_binding	from cadflow.scene import validate_connector_binding	Public function in this domain.