Sketcher ConstrainSymmetric: Difference between revisions

From FreeCAD Documentation
(several ways added)
(WIP)
Line 1: Line 1:
<languages/>
<languages/>
{{Page_in_progress}}
<translate>
<translate>


Line 24: Line 25:


<!--T:2-->
<!--T:2-->
The [[Image:Sketcher_ConstrainSymmetric.svg|24px]] [[Sketcher_ConstrainSymmetric|Sketcher ConstrainSymmetric]] command defines two selected points to be symmetrical around a given line, i.e., both selected points are constrained to lie on a normal to the line through both points and are constrained to be equidistant from the line. Alternatively it can constrain two points to be symmetric with respect to a third one.
The [[Image:Sketcher_ConstrainSymmetric.svg|24px]] [[Sketcher_ConstrainSymmetric|Sketcher ConstrainSymmetric]] tool constrains two points to be symmetrical around a line or around a third point.


==Usage== <!--T:3-->
==Usage== <!--T:3-->


See also: [[Sketcher_Workbench#Drawing_aids|Drawing aids]].
<!--T:9-->
[[File:SymmetricConstraint1.png|500px]]


# Do one of the following (optional if the tool will run in [[Sketcher_Workbench#Continue_modes|continue mode]]):
<!--T:10-->
Select two points (vertexes) in the sketch and a line in the sketch. The selected points and the line will be dark green.
#* Select two points and a symmetry point (in that order).
#* Select two points and a symmetry line (in any order).

#* Select a line and a symmetry point (idem).
<!--T:11-->
# There are several ways to invoke the tool:
[[File:SymmetricConstraint2.png|500px]]
#* Press the {{Button|[[Image:Sketcher_ConstrainSymmetric.svg|16px]] [[Sketcher_ConstrainSymmetric|Constrain symmetrical]]}} button.

#* Select the {{MenuCommand|Sketch → Sketcher constraints → [[Image:Sketcher_ConstrainSymmetric.svg|16px]] Constrain symmetrical}} option from the menu.
<!--T:12-->
#* {{Version|0.22}}: Right-click in the [[3D_view|3D view]] and select the {{MenuCommand|Constrain → [[Image:Sketcher_ConstrainSymmetric.svg|16px]] Constrain symmetrical}} option from the context menu.
There are several ways to invoke the command:
#* Use the keyboard shortcut: {{KEY|S}}.
* Press the {{Button|[[Image:Sketcher_ConstrainSymmetric.svg|16px]] [[Sketcher_ConstrainSymmetric|Constrain symmetric]]}} button.
# If the tool runs in [[Sketcher_Workbench#Continue_modes|continue mode]]:
* Select the {{MenuCommand|Sketch → Sketcher constraints → [[Image:Sketcher_ConstrainSymmetric.svg|16px]] Constrain symmetric}} option from the menu.
## The cursor changes to a white cross with the tool icon.
* {{Version|0.22}}: Right-click in the [[3D_view|3D view]] and select the {{MenuCommand|[[Image:Sketcher_ConstrainSymmetric.svg|16px]] Constrain symmetric}} option from the context menu.
## Optionally keep selecting elements:
* Use the keyboard shortcut: {{KEY|S}}.
##* Select two points and a symmetry point (in that order).

##* Select two points and a symmetry line (idem).
<!--T:13-->
##* Select a point, a symmetry line and another point (idem).
This will apply the constraint to the selected items.
##* Select a line and a symmetry point (idem).

## To finish, right-click or press {{KEY|Esc}}, or start a another constraints or geometries tool.
<!--T:14-->
[[File:SymmetricConstraint3.png|500px]]

<!--T:15-->
{{Emphasis|Note:}} Before Version 0.19 (see fix [https://github.com/FreeCAD/FreeCAD/pull/3746]), if you want to define a symmetry constraint with respect to a point, the order of the selection is important, depending on if you select the tool at the beginning or at the end.
* If you click the tool first: select the first point, then the symmetry reference point, and finally the second point.
* If you click the tool last: select the first point, then the second point, and finally the symmetry reference point.

<!--T:16-->
See the tracker [https://freecadweb.org/tracker/view.php?id=4144 issue #4144], and [https://forum.freecadweb.org/viewtopic.php?f=3&t=39611 forum thread].


== Scripting == <!--T:18-->
== Scripting == <!--T:18-->

Revision as of 15:41, 1 March 2024

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Sketcher ConstrainSymmetric

Menu location
Sketch → Sketcher constraints → Constrain symmetrical
Workbenches
Sketcher
Default shortcut
S
Introduced in version
-
See also
Sketcher Constraint Parallel

Description

The Sketcher ConstrainSymmetric tool constrains two points to be symmetrical around a line or around a third point.

Usage

See also: Drawing aids.

  1. Do one of the following (optional if the tool will run in continue mode):
    • Select two points and a symmetry point (in that order).
    • Select two points and a symmetry line (in any order).
    • Select a line and a symmetry point (idem).
  2. There are several ways to invoke the tool:
    • Press the Constrain symmetrical button.
    • Select the Sketch → Sketcher constraints → Constrain symmetrical option from the menu.
    • introduced in version 0.22: Right-click in the 3D view and select the Constrain → Constrain symmetrical option from the context menu.
    • Use the keyboard shortcut: S.
  3. If the tool runs in continue mode:
    1. The cursor changes to a white cross with the tool icon.
    2. Optionally keep selecting elements:
      • Select two points and a symmetry point (in that order).
      • Select two points and a symmetry line (idem).
      • Select a point, a symmetry line and another point (idem).
      • Select a line and a symmetry point (idem).
    3. To finish, right-click or press Esc, or start a another constraints or geometries tool.

Scripting

Two points and a symmetry line:

Sketch.addConstraint(Sketcher.Constraint('Symmetric', Line1, PointOfLine1, Line2, PointOfLine2, SymmetryLine))

Two points and a symmetry point:

Sketch.addConstraint(Sketcher.Constraint('Symmetric', Line1, PointOfLine1, Line2, PointOfLine2, LineS, PointOfLineS))

A line and a symmetry point (In the GUI one can select a line and a point, but it uses internally the same form as above, with the two extremities of the same line):

Sketch.addConstraint(Sketcher.Constraint('Symmetric', Line, 1, Line, 2, LineS, PointOfLineS))

The Sketcher scripting page explains the values which can be used for Line1, Line2, LineS, Line, PointOfLine1, PointOfLine2 and PointOfLineS, and contains further examples on how to create constraints from Python scripts.