Sketcher helper constraint/ru: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(One intermediate revision by the same user not shown)
Line 3: Line 3:
[[Image:Sketcher helper constraint example1.png|thumb|500px|Example of a helper constraint (Constraint5 - point on circle) for a tangent constraint (Constraint6; in tangent-via-point mode). Only one helper constraint is used in this case, since the point of tangency is the endpoint of ellipse's major diameter, which inherently lies on the ellipse.]]
[[Image:Sketcher helper constraint example1.png|thumb|500px|Example of a helper constraint (Constraint5 - point on circle) for a tangent constraint (Constraint6; in tangent-via-point mode). Only one helper constraint is used in this case, since the point of tangency is the endpoint of ellipse's major diameter, which inherently lies on the ellipse.]]


Helper constraint is a regular sketcher constraint that is needed as a part of a more complex constraint, but is exposed in user interface to assist dealing with redundancy. For example, for [[Constraint SnellsLaw|Snell's Law]] constraint, the two lines that represent rays of light need to be connected ([[Constraint PointOnPoint|coincident constraint]]), and the joint must lie on the interface ([[Constraint PointOnObject|Point On Object constraint]]).
Helper constraint is a regular sketcher constraint that is needed as a part of a more complex constraint, but is exposed in user interface to assist dealing with redundancy. For example, for [[Sketcher ConstrainSnellsLaw|Snell's Law]] constraint, the two lines that represent rays of light need to be connected ([[ Sketcher ConstrainCoincident ‎|coincident constraint]]), and the joint must lie on the interface ([[Sketcher ConstrainPointOnObject|Point On Object constraint]]).


Helper constraints are added automatically when they are needed. The decision for if they are needed is currently made by evaluating the helper constraint error for current state of geometry (this may change in future versions). If the error is small enough, the constraint is considered to be unnecessary, and is not added. In some cases, this logic can lead to errors (the constraint can be satisfied by accident, which can easily happen when Sketcher Grid Snapping is on).
Helper constraints are added automatically when they are needed. The decision for if they are needed is currently made by evaluating the helper constraint error for current state of geometry (this may change in future versions). If the error is small enough, the constraint is considered to be unnecessary, and is not added. In some cases, this logic can lead to errors (the constraint can be satisfied by accident, which can easily happen when Sketcher Grid Snapping is on).
Line 10: Line 10:


Helper constraints are currently required for:
Helper constraints are currently required for:
* [[Constraint Tangent]] (in tangent-via-point mode; two point-on-object constraints are needed)
* [[Sketcher ConstrainTangent|Constraint Tangent]] (in tangent-via-point mode; two point-on-object constraints are needed)
* [[Constraint Perpendicular]] (in perpendicular-via-point mode; two point-on-object constraints are needed)
* [[Sketcher ConstrainPerpendicular|Constraint Perpendicular]] (in perpendicular-via-point mode; two point-on-object constraints are needed)
* [[Constraint InternalAngle]] (in angle-via-point mode; two point-on-object constraints are needed)
* [[Sketcher ConstrainAngle|Constraint Angle]] (in angle-via-point mode; two point-on-object constraints are needed)
* [[Constraint SnellsLaw]] (coincident constraint and point-on-object constraint are needed)
* [[Sketcher ConstrainSnellsLaw|Constraint SnellsLaw]] (coincident constraint and point-on-object constraint are needed)


==Scripting==
==Scripting==

Revision as of 19:20, 8 October 2018

Overview

Example of a helper constraint (Constraint5 - point on circle) for a tangent constraint (Constraint6; in tangent-via-point mode). Only one helper constraint is used in this case, since the point of tangency is the endpoint of ellipse's major diameter, which inherently lies on the ellipse.

Helper constraint is a regular sketcher constraint that is needed as a part of a more complex constraint, but is exposed in user interface to assist dealing with redundancy. For example, for Snell's Law constraint, the two lines that represent rays of light need to be connected (coincident constraint), and the joint must lie on the interface (Point On Object constraint).

Helper constraints are added automatically when they are needed. The decision for if they are needed is currently made by evaluating the helper constraint error for current state of geometry (this may change in future versions). If the error is small enough, the constraint is considered to be unnecessary, and is not added. In some cases, this logic can lead to errors (the constraint can be satisfied by accident, which can easily happen when Sketcher Grid Snapping is on).

If this happens (a helper constraint is missing, and the required conditions is not satisfied otherwise), the complex constraint will be broken. It will do something, but the actual behavior is undefined. Such a broken constraint can be repaired by adding the missing helper constraint manually.

Helper constraints are currently required for:

Scripting

When constraints requiring helpers are added from Python, no helper constraints are automatically added. One can replicate the automatic decision-making of the UI commands in a script by testing the following functions, specifically added for the purpose and used in the UI routines:

Sketch.isPointOnCurve(icurve,x,y)

isPointOnCurve tests if a virtual point, given by sketch coordinates x,y (float values), happens to satisfy a virtual point-on-object constraint - i.e. lies on curve specified by curve index icurve. Returns True if the point is on curve, and False if it doesn't.

Sketch.calculateConstraintError(iconstr)

calculateConstraintError evaluates an error function of a constraint specified by its index iconstr in the sketch. If there is only one error function in the constraint, the return value is the signed return value of the error function. If there is more than one error function associated with the constraint (i.e. the constraint removes more than one degree of freedom), the return value is the RMS of all the error functions (always positive).

Version

Helper constraints were introduced in v0.15.4387