]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Add the rest sketch constraints help pages.
authormzn <mzn@opencascade.com>
Thu, 13 Sep 2018 16:07:17 +0000 (19:07 +0300)
committermzn <mzn@opencascade.com>
Thu, 13 Sep 2018 16:07:17 +0000 (19:07 +0300)
95 files changed:
src/SketchPlugin/doc/SketchPlugin.rst
src/SketchPlugin/doc/TUI_angle.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_coincident.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_collinear.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_equal.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_fixed.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_horizontal.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_length.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_middle.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_parallel.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_perpendicular.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_radius.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_tangent.rst [new file with mode: 0644]
src/SketchPlugin/doc/TUI_vertical.rst [new file with mode: 0644]
src/SketchPlugin/doc/angleFeature.rst
src/SketchPlugin/doc/coincedenceFeature.rst [deleted file]
src/SketchPlugin/doc/coincedentFeature.rst [new file with mode: 0644]
src/SketchPlugin/doc/collinearFeature.rst
src/SketchPlugin/doc/distanceFeature.rst
src/SketchPlugin/doc/equalFeature.rst
src/SketchPlugin/doc/examples/angle.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/coincident.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/collinear.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/equal.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/fixed.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/horizontal.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/length.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/middle.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/parallel.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/perpendicular.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/radius.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/tangent.py [new file with mode: 0644]
src/SketchPlugin/doc/examples/vertical.py [new file with mode: 0644]
src/SketchPlugin/doc/fixedFeature.rst [new file with mode: 0644]
src/SketchPlugin/doc/horizontalDistFeature.rst
src/SketchPlugin/doc/horizontalFeature.rst
src/SketchPlugin/doc/images/Angle.png [deleted file]
src/SketchPlugin/doc/images/Angle_field_view.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Angle_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Angle_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Coincident.png [deleted file]
src/SketchPlugin/doc/images/Coincident_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Coincident_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Colinear.png [deleted file]
src/SketchPlugin/doc/images/Collinear_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Collinear_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Equal.png
src/SketchPlugin/doc/images/Equal_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Equal_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Fixed.png
src/SketchPlugin/doc/images/Fixed_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Fixed_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Horizontal.png [deleted file]
src/SketchPlugin/doc/images/Horizontal_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Horizontal_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Length.png
src/SketchPlugin/doc/images/Length_field_view.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Length_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Length_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/MiddlePoint.png
src/SketchPlugin/doc/images/Middlepoint_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Middlepoint_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Parallel.png
src/SketchPlugin/doc/images/Parallel_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Parallel_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Perpendicular.png
src/SketchPlugin/doc/images/Perpendicular_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Perpendicular_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Radius_field_view.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Radius_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Radius_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Tangent.png
src/SketchPlugin/doc/images/Tangent_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Tangent_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Vertical.png
src/SketchPlugin/doc/images/VerticalDist.png [deleted file]
src/SketchPlugin/doc/images/Vertical_panel.png [new file with mode: 0644]
src/SketchPlugin/doc/images/Vertical_res.png [new file with mode: 0644]
src/SketchPlugin/doc/images/angle_backward.png [new file with mode: 0644]
src/SketchPlugin/doc/images/angle_complementary.png [new file with mode: 0644]
src/SketchPlugin/doc/images/angle_constr.png [new file with mode: 0644]
src/SketchPlugin/doc/images/angle_direct.png [new file with mode: 0644]
src/SketchPlugin/doc/images/coincedence.png [new file with mode: 0644]
src/SketchPlugin/doc/images/collinear.png [new file with mode: 0644]
src/SketchPlugin/doc/images/horisontal.png [new file with mode: 0644]
src/SketchPlugin/doc/images/radius_constr.png [new file with mode: 0644]
src/SketchPlugin/doc/lengthFeature.rst
src/SketchPlugin/doc/middleFeature.rst
src/SketchPlugin/doc/parallelFeature.rst
src/SketchPlugin/doc/perpendicularFeature.rst
src/SketchPlugin/doc/radiusFeature.rst
src/SketchPlugin/doc/rigidFeature.rst [deleted file]
src/SketchPlugin/doc/tangentFeature.rst
src/SketchPlugin/doc/verticalDistFeature.rst
src/SketchPlugin/doc/verticalFeature.rst

index b0970fad3a8f9f46c75f2bb41aa3f8e37c191572..44c20219546170b23fb945c11b499484b6c9b7ac 100644 (file)
@@ -122,19 +122,19 @@ The plug-in includes the following constraints:
    distanceFeature.rst
    horizontalDistFeature.rst
    verticalDistFeature.rst
+   lengthFeature.rst
    angleFeature.rst
-   coincedenceFeature.rst
-   collinearFeature.rst
-   equalFeature.rst
+   radiusFeature.rst
    horizontalFeature.rst
-   lengthFeature.rst
-   middleFeature.rst
+   verticalFeature.rst
+   fixedFeature.rst
    parallelFeature.rst
    perpendicularFeature.rst
-   radiusFeature.rst
-   rigidFeature.rst
    tangentFeature.rst
-   verticalFeature.rst
+   coincedentFeature.rst
+   middleFeature.rst
+   equalFeature.rst
+   collinearFeature.rst
 
 .. _sketch_operations:
 
diff --git a/src/SketchPlugin/doc/TUI_angle.rst b/src/SketchPlugin/doc/TUI_angle.rst
new file mode 100644 (file)
index 0000000..8b067f6
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_angle:
+
+Create Angle constraint
+=======================
+
+.. literalinclude:: examples/angle.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/angle.py>`
diff --git a/src/SketchPlugin/doc/TUI_coincident.rst b/src/SketchPlugin/doc/TUI_coincident.rst
new file mode 100644 (file)
index 0000000..579d600
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_coincident:
+
+Create Coincident constraint
+============================
+
+.. literalinclude:: examples/coincident.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/coincident.py>`
diff --git a/src/SketchPlugin/doc/TUI_collinear.rst b/src/SketchPlugin/doc/TUI_collinear.rst
new file mode 100644 (file)
index 0000000..f840ae6
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_collinear:
+
+Create Collinear constraint
+===========================
+
+.. literalinclude:: examples/collinear.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/collinear.py>`
diff --git a/src/SketchPlugin/doc/TUI_equal.rst b/src/SketchPlugin/doc/TUI_equal.rst
new file mode 100644 (file)
index 0000000..1a61814
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_equal:
+
+Create Equal constraint
+=======================
+
+.. literalinclude:: examples/equal.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/equal.py>`
diff --git a/src/SketchPlugin/doc/TUI_fixed.rst b/src/SketchPlugin/doc/TUI_fixed.rst
new file mode 100644 (file)
index 0000000..1c8b471
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_fixed:
+
+Create Fixed constraint
+=======================
+
+.. literalinclude:: examples/fixed.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/fixed.py>`
diff --git a/src/SketchPlugin/doc/TUI_horizontal.rst b/src/SketchPlugin/doc/TUI_horizontal.rst
new file mode 100644 (file)
index 0000000..2ccbead
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_horizontal:
+
+Create Horizontal constraint
+============================
+
+.. literalinclude:: examples/horizontal.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/horizontal.py>`
diff --git a/src/SketchPlugin/doc/TUI_length.rst b/src/SketchPlugin/doc/TUI_length.rst
new file mode 100644 (file)
index 0000000..368851c
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_length:
+
+Create Length constraint
+========================
+
+.. literalinclude:: examples/length.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/length.py>`
diff --git a/src/SketchPlugin/doc/TUI_middle.rst b/src/SketchPlugin/doc/TUI_middle.rst
new file mode 100644 (file)
index 0000000..4f87ed8
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_middle:
+
+Create Middle point constraint
+==============================
+
+.. literalinclude:: examples/middle.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/middle.py>`
diff --git a/src/SketchPlugin/doc/TUI_parallel.rst b/src/SketchPlugin/doc/TUI_parallel.rst
new file mode 100644 (file)
index 0000000..428900e
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_parallel:
+
+Create Parallel constraint
+==========================
+
+.. literalinclude:: examples/parallel.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/parallel.py>`
diff --git a/src/SketchPlugin/doc/TUI_perpendicular.rst b/src/SketchPlugin/doc/TUI_perpendicular.rst
new file mode 100644 (file)
index 0000000..78abd1d
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_perpendicular:
+
+Create Perpendicular constraint
+==========================
+
+.. literalinclude:: examples/perpendicular.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/perpendicular.py>`
diff --git a/src/SketchPlugin/doc/TUI_radius.rst b/src/SketchPlugin/doc/TUI_radius.rst
new file mode 100644 (file)
index 0000000..45d2ad0
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_radius:
+
+Create Radius constraint
+========================
+
+.. literalinclude:: examples/radius.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/radius.py>`
diff --git a/src/SketchPlugin/doc/TUI_tangent.rst b/src/SketchPlugin/doc/TUI_tangent.rst
new file mode 100644 (file)
index 0000000..17f10f2
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_tangent:
+
+Create Tangent constraint
+=========================
+
+.. literalinclude:: examples/tangent.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/tangent.py>`
diff --git a/src/SketchPlugin/doc/TUI_vertical.rst b/src/SketchPlugin/doc/TUI_vertical.rst
new file mode 100644 (file)
index 0000000..8ed40ec
--- /dev/null
@@ -0,0 +1,11 @@
+
+  .. _tui_create_vertical:
+
+Create Vertical constraint
+==========================
+
+.. literalinclude:: examples/vertical.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/vertical.py>`
index 004f80781de69525ba63f5b2f6926fb93d4ce9c4..624e1220d1b6dd62892c835b180b11c2756b8192 100644 (file)
@@ -2,9 +2,88 @@
 Angle constraint
 ================
 
+Angle constraint fixes angle between two lines.
 
-.. image:: images/Angle.png
-  :align: center
+| Angle between two lines is thought of as an angle between two vectors.
+| So each line is treated as a vector with starting point equal to the line start point
+and terminal point equal to the line end point.
+
+To create Angle constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Angle* item  or
+#. click **Angle** button in Sketch toolbar:
+
+.. image:: images/angle_constr.png
+   :align: center
+
+.. centered::
+   **Angle** button
+
+Property panel:
+
+.. image:: images/Angle_panel.png
+   :align: center
+
+Input fields:
+
+- **Line 1** is the first line selected in the view
+- **Line 2** is the second line selected in the view
+- **Value** is an angle between the lines, could be modified to set the desirable value
+- **Angle type** is a type of angle measurement
+   .. image:: images/angle_direct.png
+      :align: left
+   **Direct** is an angle type measured directly between two lines.
+
+   .. image:: images/angle_complementary.png
+      :align: left
+   **Complementary** zzzzzzzz.
+
+   .. image:: images/angle_backward.png
+      :align: left
+   **Backward** zzzzzzzz.
+- **Text location** is a position of the angle value label relating to angle line (in the view)
+   .. image:: images/location_left.png
+      :align: left
+   **Left** inserts text at the left of the angle line.
+
+   .. image:: images/location_automatic.png
+      :align: left
+   **Automatic** inserts text at the middle of the angle line if it has enough length, otherwise - to the left.
+
+   .. image:: images/location_right.png
+      :align: left
+   **Right** inserts text to the right of the angle line.
+
+When both lines are selected angle value is displayed in the property panel and in the view.
+
+When creating the constraint, after selection of two lines at the first time:
+
+- drag the angle presentation in the view to the desired position (by move mouse and click once)
+- set desirable angle value in the input field in the view and press **Enter** or just press **Enter** to keep the current angle
+
+.. image:: images/Angle_field_view.png
+   :align: center
 
 .. centered::
-  Create an angle constraint
+   Angle input in the view
+
+**TUI Command**:
+
+- *Sketch_1.setAngle(Line1, Line2, Value)*
+- *Sketch_1.setAngleComplementary(Line1, Line2, Value)*
+- *Sketch_1.setAngleBackward(Line1, Line2, Value)*
+
+**Arguments**:  2 lines + angle value
+
+Result
+""""""
+
+Created Angle appears in the view.
+
+.. image:: images/Angle_res.png
+          :align: center
+
+.. centered::
+   Angle created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_angle` operation.
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/coincedenceFeature.rst b/src/SketchPlugin/doc/coincedenceFeature.rst
deleted file mode 100644 (file)
index e29792a..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-
-Coincidence constraint
-======================
-
-
-.. image:: images/Coincident.png
-  :align: center
-
-.. centered::
-  Create a coincedence constraint
diff --git a/src/SketchPlugin/doc/coincedentFeature.rst b/src/SketchPlugin/doc/coincedentFeature.rst
new file mode 100644 (file)
index 0000000..6811792
--- /dev/null
@@ -0,0 +1,47 @@
+
+Coincident constraint
+=====================
+
+Coincident constraint makes two points to be coincident, or one point to lie on a line or circumference of a circle (or an arc).
+
+To create Coincident in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Coincident* item  or
+#. click **Coincident** button in Sketch toolbar:
+
+.. image:: images/coincedence.png
+   :align: center
+
+.. centered::
+   **Coincident**  button
+
+Property panel:
+
+.. image:: images/Coincident_panel.png
+   :align: center
+
+Input fields:
+
+- **First object** is a point, a line, a circle or an arc selected in the view.
+- **Second object** is a point, a line, a circle or an arc selected in the view.
+
+Note that one of two objects should be a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
+
+After the objects are selected the point becomes yellow colored in the view.
+
+**TUI Command**: *Sketch_1.setCoincident(Object1, Object2)*
+
+**Arguments**:  2 objects (one of them is a point, the second one is a point, a circle, an arc or a line)
+
+Result
+""""""
+
+Created Coincident constraint appears in the view.
+
+.. image:: images/Coincident_res.png
+          :align: center
+
+.. centered::
+   Coincident constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_coincident` operation.
\ No newline at end of file
index 1a43b42a7f38f6ae59e4afc022c266a10aae7d44..f8346dd26c03a42b6ed1935a000a5a88cd9625dd 100644 (file)
@@ -2,9 +2,45 @@
 Collinear constraint
 ====================
 
+Collinear constraint makes to lines collinear.
 
-.. image:: images/Colinear.png
-  :align: center
+To create Collinear in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Collinear* item  or
+#. click **Collinear** button in Sketch toolbar:
+
+.. image:: images/collinear.png
+   :align: center
 
 .. centered::
-  Create a collinear constraint
+   **Collinear**  button
+
+Property panel:
+
+.. image:: images/Collinear_panel.png
+   :align: center
+
+Input fields:
+
+- **First line** is the first line selected in the view.
+- **Second line** is the second line selected in the view.
+
+| After the lines are selected they becomes translated as to be collinear.
+| The lines are marked with the special sign.
+
+**TUI Command**: *Sketch_1.setCollinear(Line1, Line2)*
+
+**Arguments**:  2 line objects
+
+Result
+""""""
+
+Created Collinear constraint appears in the view.
+
+.. image:: images/Collinear_res.png
+          :align: center
+
+.. centered::
+   Collinear constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_collinear` operation.
index 325c61ce2df2c9b8cb9a52f97c50dc32f5918221..32b8eef376de67894b723bb6d2f27e58fe6619f0 100644 (file)
@@ -2,7 +2,9 @@
 Distance constraint
 ===================
 
-Distance can be defined between two objects such as point, line, line or arc end point, center of circle or arc.
+Distance constraint fixes distance between two objects.
+
+The constraint can be defined between such objects as point, line, line or arc end point, center of circle or arc.
 
 To create Distance constraint in the active Sketch:
 
@@ -22,10 +24,10 @@ Property panel:
 
 Input fields:
 
-- **First object** - the first object
-- **Second object** - the second object
-- **Value** - distance between the objects, could be modified to set the desirable value
-- **Text location** - position of the distance value label relating to extension line (in the view)
+- **First object** is the first object selected in the view
+- **Second object** is the second object selected in the view
+- **Value** is a distance between the objects, could be modified to set the desirable value
+- **Text location** is a position of the distance value label relating to extension line (in the view)
    .. image:: images/location_left.png
       :align: left
    **Left** inserts text at the left of the distance extension line.
@@ -37,11 +39,11 @@ Input fields:
    .. image:: images/location_right.png
       :align: left
    **Right** inserts text to the right of the distance extension line.
-- **Keep orientation** fixes the relative position between selected objects
+- **Keep orientation** fixes the relative position between selected objects
 
-When the both objects are selected distance value is displayed in the property panel and in the view.
+When both objects are selected distance value is displayed in the property panel and in the view.
 
-When creating the constraint and the both objects are selected the first time:
+When creating the constraint, after selection of two objects at the first time:
 
 - drag the distance presentation in the view to the desired position (by move mouse and click once)
 - set desirable distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
index 3f76374fb4ff8efc0e933dff585c59d6428d2a53..a3679689653cb8f588173cad3be734605d483fe5 100644 (file)
@@ -2,9 +2,48 @@
 Equal constraint
 ================
 
+| Equal constraint makes lines, circles or arcs of equal size.
+| Lines becomes of equal length, circles and arcs - of equal radius.
 
-.. image:: images/Equal.png
-  :align: center
+To create Equal in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Equal* item  or
+#. click **Equal** button in Sketch toolbar:
+
+.. image:: images/equal.png
+   :align: center
+
+.. centered::
+   **Equal**  button
+
+Property panel:
+
+.. image:: images/Equal_panel.png
+   :align: center
+
+Input fields:
+
+- **First object** is a line, a circle or an arc selected in the view.
+- **Second object** is a line, a circle or an arc selected in the view.
+
+Note that a line could be equal to a line only, a circle - to a circle or an arc.
+
+| After the objects are selected the object sizes become equal.
+| The equal objects are marked with **=** sign.
+
+**TUI Command**: *Sketch_1.setEqual(Object1, Object2)*
+
+**Arguments**:  2 objects (2 lines, 2 arcs, 2 circles or circle and arc)
+
+Result
+""""""
+
+Created Equal constraint appears in the view.
+
+.. image:: images/Equal_res.png
+          :align: center
 
 .. centered::
-  Create an equal constraint
+   Equal constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_equal` operation.
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/angle.py b/src/SketchPlugin/doc/examples/angle.py
new file mode 100644 (file)
index 0000000..d7b558c
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(55.1, 13.0, 6.42, 35.5)
+SketchLine_2 = Sketch_1.addLine(50.2, 22.4, 36.8, 58.8)
+SketchConstraintAngle_1 = Sketch_1.setAngle(SketchLine_2.result(), SketchLine_1.result(), 45)
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/coincident.py b/src/SketchPlugin/doc/examples/coincident.py
new file mode 100644 (file)
index 0000000..1ee8ad0
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchCircle_1 = Sketch_1.addCircle(34, 28, 12)
+SketchLine_1 = Sketch_1.addLine(41, 45, 61, 72)
+SketchConstraintCoincidence_1 = Sketch_1.setCoincident(SketchCircle_1.results()[1], SketchLine_1.startPoint())
+model.do()
+model.end()
diff --git a/src/SketchPlugin/doc/examples/collinear.py b/src/SketchPlugin/doc/examples/collinear.py
new file mode 100644 (file)
index 0000000..eabe2b4
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(6, 25, 20, 40)
+SketchLine_2 = Sketch_1.addLine(44, 26, 80, 61)
+SketchConstraintCollinear_1 = Sketch_1.setCollinear(SketchLine_1.result(), SketchLine_2.result())
+model.do()
+model.end()
diff --git a/src/SketchPlugin/doc/examples/equal.py b/src/SketchPlugin/doc/examples/equal.py
new file mode 100644 (file)
index 0000000..fe2c230
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchCircle_1 = Sketch_1.addCircle(27, 25, 5)
+SketchArc_1 = Sketch_1.addArc(55.58, 56.8, 70.53, 54.47, 65.76, 67.99, True)
+SketchConstraintEqual_1 = Sketch_1.setEqual(SketchCircle_1.results()[1], SketchArc_1.results()[1])
+model.do()
+model.end()
diff --git a/src/SketchPlugin/doc/examples/fixed.py b/src/SketchPlugin/doc/examples/fixed.py
new file mode 100644 (file)
index 0000000..cf43168
--- /dev/null
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchCircle_1 = Sketch_1.addCircle(38.7, 43.3, 29.29)
+SketchConstraintRigid_1 = Sketch_1.setFixed(SketchCircle_1.results()[1])
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/horizontal.py b/src/SketchPlugin/doc/examples/horizontal.py
new file mode 100644 (file)
index 0000000..1e79c71
--- /dev/null
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(14.5, 16.0, 71.0, 62.0)
+SketchConstraintHorizontal_1 = Sketch_1.setHorizontal(SketchLine_1.result())
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/length.py b/src/SketchPlugin/doc/examples/length.py
new file mode 100644 (file)
index 0000000..7a52958
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(14.6, 14.2, 59.4, 61.9)
+SketchLine_1.result().setColor(225, 0, 0)
+SketchConstraintLength_1 = Sketch_1.setLength(SketchLine_1.result(), 65.5)
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/middle.py b/src/SketchPlugin/doc/examples/middle.py
new file mode 100644 (file)
index 0000000..8eed6b6
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchCircle_1 = Sketch_1.addCircle(16, 54, 10)
+SketchLine_1 = Sketch_1.addLine(10, 10, 80, 80)
+SketchConstraintMiddle_1 = Sketch_1.setMiddlePoint(SketchCircle_1.center(), SketchLine_1.result())
+model.do()
+model.end()
diff --git a/src/SketchPlugin/doc/examples/parallel.py b/src/SketchPlugin/doc/examples/parallel.py
new file mode 100644 (file)
index 0000000..bf8e9a9
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(13, 58, 69, 75)
+SketchLine_2 = Sketch_1.addLine(12, 38, 73, 23)
+SketchConstraintParallel_1 = Sketch_1.setParallel(SketchLine_1.result(), SketchLine_2.result())
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/perpendicular.py b/src/SketchPlugin/doc/examples/perpendicular.py
new file mode 100644 (file)
index 0000000..ca08471
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(13, 58, 69, 75)
+SketchLine_2 = Sketch_1.addLine(12, 38, 73, 23)
+SketchConstraintParallel_1 = Sketch_1.setPerpendicular(SketchLine_1.result(), SketchLine_2.result())
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/radius.py b/src/SketchPlugin/doc/examples/radius.py
new file mode 100644 (file)
index 0000000..e7af76a
--- /dev/null
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchCircle_1 = Sketch_1.addCircle(35, 50, 25)
+SketchConstraintRadius_1 = Sketch_1.setRadius(SketchCircle_1.results()[1], 25)
+model.do()
+model.end()
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/examples/tangent.py b/src/SketchPlugin/doc/examples/tangent.py
new file mode 100644 (file)
index 0000000..56d2686
--- /dev/null
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchCircle_1 = Sketch_1.addCircle(30, 30, 15)
+SketchLine_1 = Sketch_1.addLine(10, 80, 80, 27)
+SketchConstraintTangent_1 = Sketch_1.setTangent(SketchCircle_1.results()[1], SketchLine_1.result())
+model.do()
+model.end()
diff --git a/src/SketchPlugin/doc/examples/vertical.py b/src/SketchPlugin/doc/examples/vertical.py
new file mode 100644 (file)
index 0000000..70038dc
--- /dev/null
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(15.5, 14.5, 71.0, 62.8)
+SketchConstraintVertical_1 = Sketch_1.setVertical(SketchLine_1.result())
+model.do()
+model.end()
diff --git a/src/SketchPlugin/doc/fixedFeature.rst b/src/SketchPlugin/doc/fixedFeature.rst
new file mode 100644 (file)
index 0000000..849ba4e
--- /dev/null
@@ -0,0 +1,52 @@
+
+Fixed constraint
+================
+
+Fixed constraint fixes objects position and size.
+
+The constraint can be defined for such objects as point, line, line or arc end point, center of circle or arc, whole circle or arc.
+
+To create Fixed constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Fixed* item  or
+#. click **Fixed** button in Sketch toolbar:
+
+.. image:: images/fixed.png
+   :align: center
+
+.. centered::
+   **Fixed**  button
+
+Property panel:
+
+.. image:: images/Fixed_panel.png
+   :align: center
+
+Input fields:
+
+- **Object** is the object selected in the view.
+
+After the object is selected anchor sign will be added close to it in the view.
+
+Selection rules:
+
+- Selection of end point on the line, center of circle or arc - fixes only the selected point.
+- To fix the whole line the segment between endpoints should be selected.
+- To fix the whole circle or arc the circumference should be selected.
+
+**TUI Command**: *Sketch_1.setFixed(Object)*
+
+**Arguments**:  1 object
+
+Result
+""""""
+
+Created Fixed constraint appears in the view.
+
+.. image:: images/Fixed_res.png
+          :align: center
+
+.. centered::
+   Fixed constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_fixed` operation.
index 74b09541403fd6d913e11da8920dbe23ae39fde8..f6981cb2a60a329eedbbc01a5ede169f8b19673a 100644 (file)
@@ -2,7 +2,7 @@
 Horizontal distance constraint
 ==============================
 
-Horizontal Distance constraint fixes distance between two objects along the horizontal axis.
+Horizontal Distance constraint fixes distance between two points along the horizontal axis.
 
 The constraint can be defined between two points such as point object, line or arc end point, center of circle or arc.
 
@@ -24,10 +24,10 @@ Property panel:
 
 Input fields:
 
-- **First object** - the first object
-- **Second object** - the second object
-- **Value** - distance between the objects, could be modified to set the desirable value
-- **Text location** - position of the distance value label relating to extension line (in the view)
+- **First point** is the first point selected in the view
+- **Second point** is the second point selected in the view
+- **Value** is a distance between the objects, could be modified to set the desirable value
+- **Text location** is a position of the distance value label relating to extension line (in the view)
    .. image:: images/location_left.png
       :align: left
    **Left** inserts text at the left of the distance extension line.
@@ -40,9 +40,9 @@ Input fields:
       :align: left
    **Right** inserts text to the right of the distance extension line.
 
-When the both objects are selected horizontal distance value is displayed in the property panel and in the view.
+When both objects are selected horizontal distance value is displayed in the property panel and in the view.
 
-When creating the constraint and the both objects are selected the first time:
+When creating the constraint, after selection of two objects at the first time:
 
 - drag the horizontal distance presentation in the view to the desired position (by move mouse and click once)
 - set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
index 8b29c33b9399c1a5b6aabaa8ef81f19faa357a7a..12ab024fe334029da630b488910fe086d800ac6a 100644 (file)
@@ -2,9 +2,44 @@
 Horizontal constraint
 =====================
 
+Horizontal constraint fixes lines to lie parallel to the horizontal axis.
 
-.. image:: images/Horizontal.png
-  :align: center
+To create Horizontal constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Horizontal* item  or
+#. click **Horizontal** button in Sketch toolbar:
+
+.. image:: images/horisontal.png
+   :align: center
 
 .. centered::
-  Create a horizontal constaint
+   **Horizontal**  button
+
+Property panel:
+
+.. image:: images/Horizontal_panel.png
+   :align: center
+
+Input fields:
+
+- **Line** is the line selected in the view.
+
+| After the line is selected it becomes parallel to the horizontal axis in the view.
+| **H** sign added above the line.
+
+**TUI Command**: *Sketch_1.setHorizontal(LineObject)*
+
+**Arguments**:  1 line object
+
+Result
+""""""
+
+Created Horizontal constraint appears in the view.
+
+.. image:: images/Horizontal_res.png
+          :align: center
+
+.. centered::
+   Horizontal constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_horizontal` operation.
\ No newline at end of file
diff --git a/src/SketchPlugin/doc/images/Angle.png b/src/SketchPlugin/doc/images/Angle.png
deleted file mode 100644 (file)
index f781cb4..0000000
Binary files a/src/SketchPlugin/doc/images/Angle.png and /dev/null differ
diff --git a/src/SketchPlugin/doc/images/Angle_field_view.png b/src/SketchPlugin/doc/images/Angle_field_view.png
new file mode 100644 (file)
index 0000000..0e89b26
Binary files /dev/null and b/src/SketchPlugin/doc/images/Angle_field_view.png differ
diff --git a/src/SketchPlugin/doc/images/Angle_panel.png b/src/SketchPlugin/doc/images/Angle_panel.png
new file mode 100644 (file)
index 0000000..b5c99e8
Binary files /dev/null and b/src/SketchPlugin/doc/images/Angle_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Angle_res.png b/src/SketchPlugin/doc/images/Angle_res.png
new file mode 100644 (file)
index 0000000..ecae78f
Binary files /dev/null and b/src/SketchPlugin/doc/images/Angle_res.png differ
diff --git a/src/SketchPlugin/doc/images/Coincident.png b/src/SketchPlugin/doc/images/Coincident.png
deleted file mode 100644 (file)
index ae64f01..0000000
Binary files a/src/SketchPlugin/doc/images/Coincident.png and /dev/null differ
diff --git a/src/SketchPlugin/doc/images/Coincident_panel.png b/src/SketchPlugin/doc/images/Coincident_panel.png
new file mode 100644 (file)
index 0000000..f690641
Binary files /dev/null and b/src/SketchPlugin/doc/images/Coincident_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Coincident_res.png b/src/SketchPlugin/doc/images/Coincident_res.png
new file mode 100644 (file)
index 0000000..0305857
Binary files /dev/null and b/src/SketchPlugin/doc/images/Coincident_res.png differ
diff --git a/src/SketchPlugin/doc/images/Colinear.png b/src/SketchPlugin/doc/images/Colinear.png
deleted file mode 100644 (file)
index 3a09d12..0000000
Binary files a/src/SketchPlugin/doc/images/Colinear.png and /dev/null differ
diff --git a/src/SketchPlugin/doc/images/Collinear_panel.png b/src/SketchPlugin/doc/images/Collinear_panel.png
new file mode 100644 (file)
index 0000000..98a1c40
Binary files /dev/null and b/src/SketchPlugin/doc/images/Collinear_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Collinear_res.png b/src/SketchPlugin/doc/images/Collinear_res.png
new file mode 100644 (file)
index 0000000..88f1daa
Binary files /dev/null and b/src/SketchPlugin/doc/images/Collinear_res.png differ
index af8f97ec995269b0fbc69a4b35cc9820ac3edfdd..e8873c0a40859d715e2d0126e92650b0504d8e94 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Equal.png and b/src/SketchPlugin/doc/images/Equal.png differ
diff --git a/src/SketchPlugin/doc/images/Equal_panel.png b/src/SketchPlugin/doc/images/Equal_panel.png
new file mode 100644 (file)
index 0000000..c9518ea
Binary files /dev/null and b/src/SketchPlugin/doc/images/Equal_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Equal_res.png b/src/SketchPlugin/doc/images/Equal_res.png
new file mode 100644 (file)
index 0000000..32f8447
Binary files /dev/null and b/src/SketchPlugin/doc/images/Equal_res.png differ
index 554189b4ce85d2df20723cf7af66bd3c4afc10c1..d5085325d296b00107312c66feac259e22bcbd55 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Fixed.png and b/src/SketchPlugin/doc/images/Fixed.png differ
diff --git a/src/SketchPlugin/doc/images/Fixed_panel.png b/src/SketchPlugin/doc/images/Fixed_panel.png
new file mode 100644 (file)
index 0000000..6228dde
Binary files /dev/null and b/src/SketchPlugin/doc/images/Fixed_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Fixed_res.png b/src/SketchPlugin/doc/images/Fixed_res.png
new file mode 100644 (file)
index 0000000..0470891
Binary files /dev/null and b/src/SketchPlugin/doc/images/Fixed_res.png differ
diff --git a/src/SketchPlugin/doc/images/Horizontal.png b/src/SketchPlugin/doc/images/Horizontal.png
deleted file mode 100644 (file)
index f44695c..0000000
Binary files a/src/SketchPlugin/doc/images/Horizontal.png and /dev/null differ
diff --git a/src/SketchPlugin/doc/images/Horizontal_panel.png b/src/SketchPlugin/doc/images/Horizontal_panel.png
new file mode 100644 (file)
index 0000000..506bebd
Binary files /dev/null and b/src/SketchPlugin/doc/images/Horizontal_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Horizontal_res.png b/src/SketchPlugin/doc/images/Horizontal_res.png
new file mode 100644 (file)
index 0000000..679d5f4
Binary files /dev/null and b/src/SketchPlugin/doc/images/Horizontal_res.png differ
index cd4f8618e7b30e9a12066a4af384134a4fb4cfdb..8bdb113d5f7026eaf57d3e2320c67a2ec9346a3b 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Length.png and b/src/SketchPlugin/doc/images/Length.png differ
diff --git a/src/SketchPlugin/doc/images/Length_field_view.png b/src/SketchPlugin/doc/images/Length_field_view.png
new file mode 100644 (file)
index 0000000..ccee662
Binary files /dev/null and b/src/SketchPlugin/doc/images/Length_field_view.png differ
diff --git a/src/SketchPlugin/doc/images/Length_panel.png b/src/SketchPlugin/doc/images/Length_panel.png
new file mode 100644 (file)
index 0000000..f92f7ba
Binary files /dev/null and b/src/SketchPlugin/doc/images/Length_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Length_res.png b/src/SketchPlugin/doc/images/Length_res.png
new file mode 100644 (file)
index 0000000..e5ab5f5
Binary files /dev/null and b/src/SketchPlugin/doc/images/Length_res.png differ
index 45de38df647d0aaf18c40dcc655fc4c83081cc80..af1252161e0d28dbd966b5dd5bee2f4a4fe33314 100644 (file)
Binary files a/src/SketchPlugin/doc/images/MiddlePoint.png and b/src/SketchPlugin/doc/images/MiddlePoint.png differ
diff --git a/src/SketchPlugin/doc/images/Middlepoint_panel.png b/src/SketchPlugin/doc/images/Middlepoint_panel.png
new file mode 100644 (file)
index 0000000..ea30695
Binary files /dev/null and b/src/SketchPlugin/doc/images/Middlepoint_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Middlepoint_res.png b/src/SketchPlugin/doc/images/Middlepoint_res.png
new file mode 100644 (file)
index 0000000..8eed330
Binary files /dev/null and b/src/SketchPlugin/doc/images/Middlepoint_res.png differ
index 057126a120148ced110f01ae1d13224468714dc7..8d152d3be7fe4956115ecfab9a7e20c66f3024c5 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Parallel.png and b/src/SketchPlugin/doc/images/Parallel.png differ
diff --git a/src/SketchPlugin/doc/images/Parallel_panel.png b/src/SketchPlugin/doc/images/Parallel_panel.png
new file mode 100644 (file)
index 0000000..64d7e3b
Binary files /dev/null and b/src/SketchPlugin/doc/images/Parallel_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Parallel_res.png b/src/SketchPlugin/doc/images/Parallel_res.png
new file mode 100644 (file)
index 0000000..c1d01a7
Binary files /dev/null and b/src/SketchPlugin/doc/images/Parallel_res.png differ
index 8e119691cf07d67d634048c6f58e1b58cd701709..1fb695c6a37c182b53552d4a4799fe46302bbc99 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Perpendicular.png and b/src/SketchPlugin/doc/images/Perpendicular.png differ
diff --git a/src/SketchPlugin/doc/images/Perpendicular_panel.png b/src/SketchPlugin/doc/images/Perpendicular_panel.png
new file mode 100644 (file)
index 0000000..0747cff
Binary files /dev/null and b/src/SketchPlugin/doc/images/Perpendicular_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Perpendicular_res.png b/src/SketchPlugin/doc/images/Perpendicular_res.png
new file mode 100644 (file)
index 0000000..af1f713
Binary files /dev/null and b/src/SketchPlugin/doc/images/Perpendicular_res.png differ
diff --git a/src/SketchPlugin/doc/images/Radius_field_view.png b/src/SketchPlugin/doc/images/Radius_field_view.png
new file mode 100644 (file)
index 0000000..eee0829
Binary files /dev/null and b/src/SketchPlugin/doc/images/Radius_field_view.png differ
diff --git a/src/SketchPlugin/doc/images/Radius_panel.png b/src/SketchPlugin/doc/images/Radius_panel.png
new file mode 100644 (file)
index 0000000..98febd8
Binary files /dev/null and b/src/SketchPlugin/doc/images/Radius_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Radius_res.png b/src/SketchPlugin/doc/images/Radius_res.png
new file mode 100644 (file)
index 0000000..561a9a7
Binary files /dev/null and b/src/SketchPlugin/doc/images/Radius_res.png differ
index 6e0d3c9b216e37da38a26e0813d6974175e78051..ec54eae31550d652bf4cc54e874e67bc600e241e 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Tangent.png and b/src/SketchPlugin/doc/images/Tangent.png differ
diff --git a/src/SketchPlugin/doc/images/Tangent_panel.png b/src/SketchPlugin/doc/images/Tangent_panel.png
new file mode 100644 (file)
index 0000000..bdffcd0
Binary files /dev/null and b/src/SketchPlugin/doc/images/Tangent_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Tangent_res.png b/src/SketchPlugin/doc/images/Tangent_res.png
new file mode 100644 (file)
index 0000000..bd931cd
Binary files /dev/null and b/src/SketchPlugin/doc/images/Tangent_res.png differ
index ba157a938c6f9dcd2298bbcf5a458b6cc02596a6..430386c98c773958a0553444af5b0bf0146e4a56 100644 (file)
Binary files a/src/SketchPlugin/doc/images/Vertical.png and b/src/SketchPlugin/doc/images/Vertical.png differ
diff --git a/src/SketchPlugin/doc/images/VerticalDist.png b/src/SketchPlugin/doc/images/VerticalDist.png
deleted file mode 100644 (file)
index fcea0d2..0000000
Binary files a/src/SketchPlugin/doc/images/VerticalDist.png and /dev/null differ
diff --git a/src/SketchPlugin/doc/images/Vertical_panel.png b/src/SketchPlugin/doc/images/Vertical_panel.png
new file mode 100644 (file)
index 0000000..fe75e7e
Binary files /dev/null and b/src/SketchPlugin/doc/images/Vertical_panel.png differ
diff --git a/src/SketchPlugin/doc/images/Vertical_res.png b/src/SketchPlugin/doc/images/Vertical_res.png
new file mode 100644 (file)
index 0000000..b5994bd
Binary files /dev/null and b/src/SketchPlugin/doc/images/Vertical_res.png differ
diff --git a/src/SketchPlugin/doc/images/angle_backward.png b/src/SketchPlugin/doc/images/angle_backward.png
new file mode 100644 (file)
index 0000000..d052d80
Binary files /dev/null and b/src/SketchPlugin/doc/images/angle_backward.png differ
diff --git a/src/SketchPlugin/doc/images/angle_complementary.png b/src/SketchPlugin/doc/images/angle_complementary.png
new file mode 100644 (file)
index 0000000..aa61390
Binary files /dev/null and b/src/SketchPlugin/doc/images/angle_complementary.png differ
diff --git a/src/SketchPlugin/doc/images/angle_constr.png b/src/SketchPlugin/doc/images/angle_constr.png
new file mode 100644 (file)
index 0000000..e0c46df
Binary files /dev/null and b/src/SketchPlugin/doc/images/angle_constr.png differ
diff --git a/src/SketchPlugin/doc/images/angle_direct.png b/src/SketchPlugin/doc/images/angle_direct.png
new file mode 100644 (file)
index 0000000..95c18e8
Binary files /dev/null and b/src/SketchPlugin/doc/images/angle_direct.png differ
diff --git a/src/SketchPlugin/doc/images/coincedence.png b/src/SketchPlugin/doc/images/coincedence.png
new file mode 100644 (file)
index 0000000..ee77538
Binary files /dev/null and b/src/SketchPlugin/doc/images/coincedence.png differ
diff --git a/src/SketchPlugin/doc/images/collinear.png b/src/SketchPlugin/doc/images/collinear.png
new file mode 100644 (file)
index 0000000..d96834f
Binary files /dev/null and b/src/SketchPlugin/doc/images/collinear.png differ
diff --git a/src/SketchPlugin/doc/images/horisontal.png b/src/SketchPlugin/doc/images/horisontal.png
new file mode 100644 (file)
index 0000000..63ea87d
Binary files /dev/null and b/src/SketchPlugin/doc/images/horisontal.png differ
diff --git a/src/SketchPlugin/doc/images/radius_constr.png b/src/SketchPlugin/doc/images/radius_constr.png
new file mode 100644 (file)
index 0000000..83fabad
Binary files /dev/null and b/src/SketchPlugin/doc/images/radius_constr.png differ
index f4197f5cbaf0edb5cdc1db6c69e6d127c44bc79c..c74ec6ccd19435cd72f3251acdba626f5416fb09 100644 (file)
@@ -2,9 +2,67 @@
 Length constraint
 =================
 
+Length constraint fixes length of lines such as standalone line or rectangle side.
 
-.. image:: images/Length.png
-  :align: center
+To create Length constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Length* item  or
+#. click **Length** button in Sketch toolbar:
+
+.. image:: images/length.png
+   :align: center
+
+.. centered::
+   **Length**  button
+
+Property panel:
+
+.. image:: images/Length_panel.png
+   :align: center
+
+Input fields:
+
+- **Line** is the the line object selected in the view
+- **Value** is a line length, could be modified to set the desirable value
+- **Text location** is a position of the length value label relating to extension line (in the view)
+   .. image:: images/location_left.png
+      :align: left
+   **Left** inserts text at the left of the length extension line.
+
+   .. image:: images/location_automatic.png
+      :align: left
+   **Automatic** inserts text at the middle of the length extension line if it has enough length, otherwise - to the left.
+
+   .. image:: images/location_right.png
+      :align: left
+   **Right** inserts text to the right of the length extension line.
+
+When the line is selected length value is displayed in the property panel and in the view.
+
+When creating the constraint, after selection of a line at the first time:
+
+- drag the length presentation in the view to the desired position (by move mouse and click once)
+- set desirable length value in the input field in the view and press **Enter** or just press **Enter** to keep the current length
+
+.. image:: images/Length_field_view.png
+   :align: center
 
 .. centered::
-  Create a length constraint
+   Length input in the view
+
+**TUI Command**: *Sketch_1.setLength(LineObject, Value)*
+
+**Arguments**:  line + length value
+
+Result
+""""""
+
+Created Length appears in the view.
+
+.. image:: images/Length_res.png
+          :align: center
+
+.. centered::
+   Length created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_length` operation.
index 075b57a460887ce777aedc1e3166096c9d0365a6..75ff8a7657682025b0b8c1bdd60b3417106efbe5 100644 (file)
@@ -1,10 +1,48 @@
 
-Middle constraint
-=================
+Middle point constraint
+=======================
 
+Middle point constraint makes one point to lie in the middle of a line.
 
-.. image:: images/MiddlePoint.png
-  :align: center
+To create Middle point in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Middle point* item  or
+#. click **Middle point** button in Sketch toolbar:
+
+.. image:: images/middlepoint.png
+   :align: center
+
+.. centered::
+   **Middle point**  button
+
+Property panel:
+
+.. image:: images/Middlepoint_panel.png
+   :align: center
+
+Input fields:
+
+- **First object** is a point or a line selected in the view.
+- **Second object** is a point or a line selected in the view.
+
+Note that one of two objects should be a line and another one a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
+
+| After the objects are selected the point becomes located in the middle of the line.
+| The middle point are marked with the special sign.
+
+**TUI Command**: *Sketch_1.setMiddlePoint(Point, Line)*
+
+**Arguments**:  2 objects (the first is a point, the second one is a line)
+
+Result
+""""""
+
+Created Middle point constraint appears in the view.
+
+.. image:: images/Middlepoint_res.png
+          :align: center
 
 .. centered::
-  Create a middle constraint
+   Middle point constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_middle` operation.
index 5886038dde4d91fbd4e1767c02af434cdd29a344..2aaa933a6d2c1859e2550f190e854f9a55b39901 100644 (file)
@@ -2,9 +2,44 @@
 Parallel constraint
 ===================
 
+Parallel constraint fixes two lines to lie parallel to one another.
 
-.. image:: images/Parallel.png
-  :align: center
+To create Parallel in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Parallel* item  or
+#. click **Parallel** button in Sketch toolbar:
+
+.. image:: images/parallel.png
+   :align: center
 
 .. centered::
-  Create a parallel constraint
+   **Parallel**  button
+
+Property panel:
+
+.. image:: images/Parallel_panel.png
+   :align: center
+
+Input fields:
+
+- **First line** is the first line selected in the view.
+- **Second line** is the second line selected in the view.
+
+After the lines are selected **||** sign will be added to each of them in the view.
+
+**TUI Command**: *Sketch_1.setParallel(Line1, Line2)*
+
+**Arguments**:  2 line objects
+
+Result
+""""""
+
+Created Parallel constraint appears in the view.
+
+.. image:: images/Parallel_res.png
+          :align: center
+
+.. centered::
+   Parallel constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_parallel` operation.
\ No newline at end of file
index 3c411968866a97ee32fab5b06c4d078d2c6835b0..a14512206435d97f9dae128adf268a495b56e769 100644 (file)
@@ -2,9 +2,44 @@
 Perpendicular constraint
 ========================
 
+Perpendicular constraint fixes two lines to lie at 90 degrees to one another.
 
-.. image:: images/Perpendicular.png
-  :align: center
+To create Perpendicular in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Perpendicular* item  or
+#. click **Perpendicular** button in Sketch toolbar:
+
+.. image:: images/perpendicular.png
+   :align: center
 
 .. centered::
-  Create a perpendicular constraint
+   **Perpendicular**  button
+
+Property panel:
+
+.. image:: images/Perpendicular_panel.png
+   :align: center
+
+Input fields:
+
+- **First line** is the first line selected in the view.
+- **Second line** is the second line selected in the view.
+
+After the lines are selected the special sign will be added to each of them in the view.
+
+**TUI Command**: *Sketch_1.setPerpendicular(Line1, Line2)*
+
+**Arguments**:  2 line objects
+
+Result
+""""""
+
+Created Perpendicular constraint appears in the view.
+
+.. image:: images/Perpendicular_res.png
+          :align: center
+
+.. centered::
+   Perpendicular constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_perpendicular` operation.
index 6613ad95e0b0d19eb44256cbf72ab60db258079b..9cc3b472f0b33abf8697cf0b44e523bad77ee388 100644 (file)
@@ -2,9 +2,67 @@
 Radius constraint
 =================
 
+Radius constraint fixes radius of circle or arc.
 
-.. image:: images/Radius.png
-  :align: center
+To create Radius constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Radius* item  or
+#. click **Radius** button in Sketch toolbar:
+
+.. image:: images/radius_constr.png
+   :align: center
+
+.. centered::
+   **Radius**  button
+
+Property panel:
+
+.. image:: images/Radius_panel.png
+   :align: center
+
+Input fields:
+
+- **Circle or Arc** is the circe or arc circumference selected in the view
+- **Value** is a radius of the selected object, could be modified to set the desirable value
+- **Text location** is a position of the radius value label relating to extension line (in the view)
+   .. image:: images/location_left.png
+      :align: left
+   **Left** inserts text at the left of the radius extension line.
+
+   .. image:: images/location_automatic.png
+      :align: left
+   **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left.
+
+   .. image:: images/location_right.png
+      :align: left
+   **Right** inserts text to the right of the radius extension line.
+
+When circle or arc is selected radius value is displayed in the property panel and in the view.
+
+When creating the constraint, after selection of the circle or arc at the first time :
+
+- drag the radius presentation in the view to the desired position (by move mouse and click once)
+- set desirable radius value in the input field in the view and press **Enter** or just press **Enter** to keep the current radius
+
+.. image:: images/Radius_field_view.png
+   :align: center
 
 .. centered::
-  Create a radius constraint
+   Radius input in the view
+
+**TUI Command**: *Sketch_1.setRadius(CircleOrArc, Value)*
+
+**Arguments**:  circle or arc circumference object + radius value
+
+Result
+""""""
+
+Created Radius appears in the view.
+
+.. image:: images/Radius_res.png
+          :align: center
+
+.. centered::
+   Radius created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_radius` operation.
diff --git a/src/SketchPlugin/doc/rigidFeature.rst b/src/SketchPlugin/doc/rigidFeature.rst
deleted file mode 100644 (file)
index e920e47..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-
-Fixed constraint
-================
-
-
-.. image:: images/Fixed.png
-  :align: center
-
-.. centered::
-  Create a fixed constraint
index feb048afbcd19742a759af05491316843e0b8f60..11903d6c1618b04d4c744fd2f4e31a37d5ad8637 100644 (file)
@@ -2,9 +2,46 @@
 Tangent constraint
 ==================
 
+Tangent constraint fixes a circle (or an arc) and a line so that a line is tangent to a circle (or an arc).
 
-.. image:: images/Tangent.png
-  :align: center
+To create Tangent in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Tangent* item  or
+#. click **Tangent** button in Sketch toolbar:
+
+.. image:: images/tangent.png
+   :align: center
+
+.. centered::
+   **Tangent**  button
+
+Property panel:
+
+.. image:: images/Tangent_panel.png
+   :align: center
+
+Input fields:
+
+- **First object** is a line, a circle or an arc selected in the view.
+- **Second object** is a line, a circle or an arc selected in the view.
+
+Note that one of two objects should be a line.
+
+After the objects are selected the special sign will be added close to the tangency point in the view.
+
+**TUI Command**: *Sketch_1.setTangent(Line, CircleOrArc)*
+
+**Arguments**:  2 objects (the first is a line, the second one is a circle or an arc)
+
+Result
+""""""
+
+Created Tangent constraint appears in the view.
+
+.. image:: images/Tangent_res.png
+          :align: center
 
 .. centered::
-  Create a tangent constraint
+   Tangent constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_tangent` operation.
index 47e718a99401cc5aad6b0843c303dba9f4bfb855..6a512e3256757684937b9dfe4a0a3dd8e272b246 100644 (file)
@@ -2,7 +2,7 @@
 Vertical distance constraint
 ============================
 
-Vertical Distance constraint fixes distance between two objects along the vertical axis.
+Vertical Distance constraint fixes distance between two points along the vertical axis.
 
 The constraint can be defined between two points such as point object, line or arc end point, center of circle or arc.
 
@@ -24,10 +24,10 @@ Property panel:
 
 Input fields:
 
-- **First object** - the first object
-- **Second object** - the second object
-- **Value** - distance between the objects, could be modified to set the desirable value
-- **Text location** - position of the distance value label relating to extension line (in the view)
+- **First point** is the first point selected in the view
+- **Second point** is the second point selected in the view
+- **Value** is a distance between the objects, could be modified to set the desirable value
+- **Text location** is a position of the distance value label relating to extension line (in the view)
    .. image:: images/location_left.png
       :align: left
    **Left** inserts text at the left of the distance extension line.
@@ -40,9 +40,9 @@ Input fields:
       :align: left
    **Right** inserts text to the right of the distance extension line.
 
-When the both objects are selected vertical distance value is displayed in the property panel and in the view.
+When both objects are selected vertical distance value is displayed in the property panel and in the view.
 
-When creating the constraint and the both objects are selected the first time:
+When creating the constraint, after selection of two objects at the first time:
 
 - drag the Vertical distance presentation in the view to the desired position (by move mouse and click once)
 - set desirable vertical distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
index 61b76aae6c5d059eb4f4293dd90a4fbad79dce81..4de7dfe8eb169a02821aea12fbcb9f90b724ff14 100644 (file)
@@ -2,9 +2,44 @@
 Vertical constraint
 ===================
 
+Vertical constraint fixes lines to lie parallel to the vertical axis.
 
-.. image:: images/Vertical.png
-  :align: center
+To create Vertical constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Vertical* item  or
+#. click **Vertical** button in Sketch toolbar:
+
+.. image:: images/vertical.png
+   :align: center
 
 .. centered::
-  Create a vertical constraint
+   **Vertical**  button
+
+Property panel:
+
+.. image:: images/Vertical_panel.png
+   :align: center
+
+Input fields:
+
+- **Line** is the line selected in the view.
+
+| After the line is selected it becomes parallel to the vertical axis in the view.
+| **V** sign added above the line.
+
+**TUI Command**: *Sketch_1.setVertical(LineObject)*
+
+**Arguments**:  1 line object
+
+Result
+""""""
+
+Created Vertical constraint appears in the view.
+
+.. image:: images/Vertical_res.png
+          :align: center
+
+.. centered::
+   Vertical constraint created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_vertical` operation.
\ No newline at end of file