constraints.HorizontalConstraint

constraints.HorizontalConstraint(point1, point2, *, weight=1.0)

Constraint that forces two sketch points onto a horizontal line.

This constraint enforces: y1 = y2 (in sketch-plane coordinates).

Reduces DOF by 1 (one scalar equation).

Parameters

Name Type Description Default
point1 Vector2 First sketch point (Vector2 parameter) required
point2 Vector2 Second sketch point (Vector2 parameter) required

Example

p1 = Vector2([0, 0], free=True, name='p1')
p2 = Vector2([2, 1], free=True, name='p2')
constraint = HorizontalConstraint(p1, p2)

Methods

Name Description
compute_residual Compute horizontal constraint residual: y1 - y2.
dof_reduction Horizontal constraint adds 1 scalar equation.
get_parameters Return both points involved in the horizontal constraint.

compute_residual

constraints.HorizontalConstraint.compute_residual(param_values)

Compute horizontal constraint residual: y1 - y2.

Parameters

Name Type Description Default
param_values dict[str, Array] Dict with keys matching parameter names required

Returns

Name Type Description
Array Scalar residual (0 when constraint is satisfied)

dof_reduction

constraints.HorizontalConstraint.dof_reduction()

Horizontal constraint adds 1 scalar equation.

get_parameters

constraints.HorizontalConstraint.get_parameters()

Return both points involved in the horizontal constraint.