Salome HOME
Add tutorial help page.
authormzn <mzn@opencascade.com>
Fri, 28 Sep 2018 11:42:47 +0000 (14:42 +0300)
committermzn <mzn@opencascade.com>
Fri, 28 Sep 2018 11:43:15 +0000 (14:43 +0300)
58 files changed:
doc/gui/CMakeLists.txt
doc/gui/TUI_tutorial.rst [new file with mode: 0644]
doc/gui/Tutorial.rst [new file with mode: 0644]
doc/gui/examples/tutorial.py [new file with mode: 0644]
doc/gui/images/tutorial10_1.png [new file with mode: 0644]
doc/gui/images/tutorial10_2.png [new file with mode: 0644]
doc/gui/images/tutorial11_1.png [new file with mode: 0644]
doc/gui/images/tutorial11_2.png [new file with mode: 0644]
doc/gui/images/tutorial1_1.png [new file with mode: 0644]
doc/gui/images/tutorial1_10.png [new file with mode: 0644]
doc/gui/images/tutorial1_11.png [new file with mode: 0644]
doc/gui/images/tutorial1_12.png [new file with mode: 0644]
doc/gui/images/tutorial1_2.png [new file with mode: 0644]
doc/gui/images/tutorial1_3.png [new file with mode: 0644]
doc/gui/images/tutorial1_4.png [new file with mode: 0644]
doc/gui/images/tutorial1_5.png [new file with mode: 0644]
doc/gui/images/tutorial1_6.png [new file with mode: 0644]
doc/gui/images/tutorial1_7.png [new file with mode: 0644]
doc/gui/images/tutorial1_8.png [new file with mode: 0644]
doc/gui/images/tutorial1_9.png [new file with mode: 0644]
doc/gui/images/tutorial2_1.png [new file with mode: 0644]
doc/gui/images/tutorial2_2.png [new file with mode: 0644]
doc/gui/images/tutorial2_3.png [new file with mode: 0644]
doc/gui/images/tutorial2_4.png [new file with mode: 0644]
doc/gui/images/tutorial3_1.png [new file with mode: 0644]
doc/gui/images/tutorial3_2.png [new file with mode: 0644]
doc/gui/images/tutorial4_1.png [new file with mode: 0644]
doc/gui/images/tutorial4_2.png [new file with mode: 0644]
doc/gui/images/tutorial5_1.png [new file with mode: 0644]
doc/gui/images/tutorial5_2.png [new file with mode: 0644]
doc/gui/images/tutorial6_1.png [new file with mode: 0644]
doc/gui/images/tutorial6_2.png [new file with mode: 0644]
doc/gui/images/tutorial7_1.png [new file with mode: 0644]
doc/gui/images/tutorial7_2.png [new file with mode: 0644]
doc/gui/images/tutorial7_3.png [new file with mode: 0644]
doc/gui/images/tutorial8_1.png [new file with mode: 0644]
doc/gui/images/tutorial8_2.png [new file with mode: 0644]
doc/gui/images/tutorial9_1.png [new file with mode: 0644]
doc/gui/images/tutorial9_2.png [new file with mode: 0644]
doc/gui/index.rst.in
src/BuildPlugin/doc/faceFeature.rst
src/BuildPlugin/doc/polylineFeature.rst
src/ConstructionPlugin/doc/pointFeature.rst
src/FeaturesPlugin/doc/angularCopyFeature.rst
src/FeaturesPlugin/doc/commonFeature.rst
src/FeaturesPlugin/doc/cutFeature.rst
src/FeaturesPlugin/doc/extrusionFeature.rst
src/FeaturesPlugin/doc/filletFeature.rst
src/FeaturesPlugin/doc/revolutionFeature.rst
src/FeaturesPlugin/doc/rotationFeature.rst
src/FeaturesPlugin/doc/translationFeature.rst
src/PartSetPlugin/doc/PartSetPlugin.rst
src/SketchPlugin/doc/coincedentFeature.rst
src/SketchPlugin/doc/equalFeature.rst
src/SketchPlugin/doc/lengthFeature.rst
src/SketchPlugin/doc/lineFeature.rst
src/SketchPlugin/doc/perpendicularFeature.rst
src/SketchPlugin/doc/rotationFeature.rst

index abdaa6c81af9f48695a5b95037bba3adcfa29d2c..27f10eb9106508eecc1a13079e089904297ac733 100644 (file)
@@ -24,6 +24,8 @@ SET(output ${CMAKE_CURRENT_BINARY_DIR}/conf.py)
 
 SET(DOC_FILES
   Introduction.rst
+  Tutorial.rst
+  TUI_tutorial.rst
   )
 
 CONFIGURE_FILE(${input} ${output})
diff --git a/doc/gui/TUI_tutorial.rst b/doc/gui/TUI_tutorial.rst
new file mode 100644 (file)
index 0000000..8a09c1f
--- /dev/null
@@ -0,0 +1,10 @@
+  .. _tui_tutorial:
+
+Tutorial TUI Script
+===================
+
+.. literalinclude:: examples/tutorial.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/tutorial.py>` 
\ No newline at end of file
diff --git a/doc/gui/Tutorial.rst b/doc/gui/Tutorial.rst
new file mode 100644 (file)
index 0000000..679b432
--- /dev/null
@@ -0,0 +1,320 @@
+
+.. _tutorial:
+
+
+Tutorial
+========
+
+This exercise illustrates how to create screw-nut shape from scratch.
+
+
+Step1. Sketch.
+--------------
+
+At this step we will create a regular hexagon.
+
+- Create a :ref:`new-part` via Main Menu *Part - > New part*
+- Start :ref:`Sketch <sketchPlugin>` creation via Main Menu *Sketch - > Sketch*
+- Set **Size of the view** parameter equal to 250 in the Sketch dialog
+- Select **XOY** plane in the view
+- Click **Set plane view** button in the Sketch property panel
+
+.. image:: images/tutorial1_1.png
+   :align: center
+
+.. centered::
+   Skecth plane XOY
+- Start :ref:`Line <sketchLine>` creation via Main Menu *Sketch - > Line*
+- Pick 3 points in the view one by one and select the first one at the end to get a triangle:
+
+.. image:: images/tutorial1_2.png
+   :align: center
+
+.. centered::
+   3 Lines forming a triangle
+- Hide trihedron via **Show/Hide trihedron** button in viewer toolbar
+- Select **Origin** object from **Part set / Constructions** folder in the object browser
+- Click on the eye icon on the left of the origin item to show it in the view
+- Select both origin and the bottom vertex of the triangle in the view (use **Shift** key for multi-selection)
+
+.. image:: images/tutorial1_3.png
+   :align: center
+
+.. centered::
+   Origin and triangle
+- Create :ref:`Coincident <sketchCoincident>` constraint via **Coincident** button in Sketch toolbar
+.. image:: images/tutorial1_4.png
+   :align: center
+
+.. centered::
+   Triangle vertex coincident with origin
+- Show trihedron
+- Select both **OY** axis and the upper side of the triangle in the view
+- Create :ref:`Perpendicular <sketchPerpendicular>` constraint via **Pependicular** button in Sketch toolbar
+.. image:: images/tutorial1_5.png
+   :align: center
+
+.. centered::
+   Upper triangle side perpendicular to OY axis
+- Select the left and the upper side of the triangle
+- Create :ref:`Equal <sketchEqual>` constraint via **Equal** button in Sketch toolbar
+- Make the upper and the right sides equal length in the same way
+.. image:: images/tutorial1_6.png
+   :align: center
+
+.. centered::
+   Equilateral triangle
+- Select the left side of the triangle
+- Check **Auxiliary** check box in the property panel and click **Apply** button
+.. image:: images/tutorial1_7.png
+   :align: center
+
+.. centered::
+   Line property panel
+- Make the right side auxiliary in the same way
+.. image:: images/tutorial1_8.png
+   :align: center
+
+.. centered::
+   The lateral sides are auxiliary
+- Start creation of :ref:`Angular copy <sketchAngularCopy>` feature via **Angular copy** button in Sketch toolbar
+- Select the upper side of the triangle for **Segments** parameter in the property panel
+- Select origin in the view as a center of rotation
+- Set **Total number** of objects equal to 6
+.. image:: images/tutorial1_9.png
+   :align: center
+
+.. centered::
+   Angular copy parameters
+- Click **Apply** button
+.. image:: images/tutorial1_10.png
+   :align: center
+
+.. centered::
+   Regular hexagon
+- Select the upper side of the hexagon
+- Start creation of :ref:`Length <sketchLength>` constraint via **Length** button in Sketch toolbar
+- Set length value equal to 115.4 and press **Enter**
+.. image:: images/tutorial1_11.png
+   :align: center
+
+.. centered::
+   Fully fixed regular hexagon
+- Click **Apply** button in the *Skecth* property panel to finish the sketch creation
+.. image:: images/tutorial1_12.png
+   :align: center
+
+.. centered::
+   Finished Sketch
+
+Step2. Polyline.
+----------------
+
+- Start :ref:`Point <constructionPoint>` creation via Main Menu *Construction - > Point*
+- Set x = 50, y = 0, z = 0
+.. image:: images/tutorial2_1.png
+   :align: center
+
+.. centered::
+   Construction of point (50, 0, 0)
+- Click **Apply** button to finish point creation
+- Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, 90), (50, 0, 90) in the same way
+- Select the created points in the object browser under **Part_1 / Constructions** node
+- Click right mouse button and select **Color...** item in the popup menu
+- Select blue color and click **OK** button
+.. image:: images/tutorial2_2.png
+   :align: center
+
+.. centered::
+   Points created from scratch
+- Start :ref:`Polyline <buildPolyline>` creation via Main Menu *Build - > Polyline*
+- Select all the 7 points (use **Shift** key for multi-selection)
+- Check **Closed** check box
+.. image:: images/tutorial2_3.png
+   :align: center
+
+.. centered::
+   Creation of closed polyline from 7 points
+- Click **Apply** button in the property panel
+.. image:: images/tutorial2_4.png
+   :align: center
+
+.. centered::
+   Closed Polyline
+
+Step3. Face.
+------------
+
+- Start :ref:`Face <buildFace>` creation via Main Menu *Build - > Face*
+- Select **Polyline_1_1** in the object browser under **Part_1 / Results** node
+.. image:: images/tutorial3_1.png
+   :align: center
+
+.. centered::
+   Construction of face from a polyline
+- Click **Apply** button in the property panel
+.. image:: images/tutorial3_2.png
+   :align: center
+
+.. centered::
+   Face
+
+Step4. Revolution.
+------------------
+
+- Start :ref:`Revolution <featureRevolution>` creation via Main Menu *Features - > Revolution*
+- Select the face created at step 3 in the view
+- Click on axis input field in the property panel and select **OZ** axis in the view
+.. image:: images/tutorial4_1.png
+   :align: center
+
+.. centered::
+   Revolution around OZ by 360 degrees
+- Click **Apply** button in the property panel
+.. image:: images/tutorial4_2.png
+   :align: center
+
+.. centered::
+   Solid created by rotation of face
+
+Step5. Extrusion.
+-----------------
+
+- Start :ref:`Extrusion <featureExtrusion>` creation via Main Menu *Features - > Extrusion*
+- Select the hexagon created at step 1
+- Click on axis input field in the property panel and select **OZ** axis in the view
+- Set **To size** parameter equal to 100
+.. image:: images/tutorial5_1.png
+   :align: center
+
+.. centered::
+   Extrusion along OZ axis from 0 to 100
+- Click **Apply** button in the property panel
+.. image:: images/tutorial5_2.png
+   :align: center
+
+.. centered::
+   Solid created by extrusion of sketch
+
+Step6. Common.
+--------------
+
+- Start :ref:`Common <featureCommon>` creation via Main Menu *Features - > Common*
+- Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection)
+.. image:: images/tutorial6_1.png
+   :align: center
+
+.. centered::
+   Common creation
+- Click **Apply** button in the property panel
+.. image:: images/tutorial6_2.png
+   :align: center
+
+.. centered::
+   The revolution and the extrusion common part
+
+Step7. Fillet.
+--------------
+
+- Start :ref:`Fillet <featureFillet>` creation via Main Menu *Features - > Fillet*
+- Select the edge
+.. image:: images/tutorial7_1.png
+   :align: center
+
+.. centered::
+   Select edge for a Fillet
+- Select **Radius** parameter equal to 10
+.. image:: images/tutorial7_2.png
+   :align: center
+
+.. centered::
+   Fillet with radius = 10
+- Click **Apply** button in the property panel
+.. image:: images/tutorial7_3.png
+   :align: center
+
+.. centered::
+   Fillet
+
+Step8. Box.
+-----------
+
+- Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view
+- Start :ref:`Box <box_feature>` creation via Main Menu *Primitives - > Box*
+- Set **DX** = 10, **DY** = 120, **DZ** = 20
+.. image:: images/tutorial8_1.png
+   :align: center
+
+.. centered::
+   Box creation
+- Click **Apply** button in the property panel
+.. image:: images/tutorial8_2.png
+   :align: center
+
+.. centered::
+   Box
+
+Step9. Translation.
+-------------------
+
+- Start :ref:`Translation <featureTranslation>` creation via Main Menu *Part - > Translation*
+- Check **By X, Y and Z dimensions** option on the top of the property panel
+- Select the box in the view
+- Set **DX** = -10, **DY** = 20, **DZ** = 70
+.. image:: images/tutorial9_1.png
+   :align: center
+
+.. centered::
+   Box translation
+- Click **Apply** button in the property panel
+.. image:: images/tutorial9_2.png
+   :align: center
+
+.. centered::
+   Translated Box
+
+Step10. Angular Copy.
+---------------------
+
+- Start :ref:`Angular Copy <featureAngularCopy>` creation via Main Menu *Part - > Angular Copy*
+- Select the box in the view
+- Click on axis input field in the property panel and select **OZ** axis in the view
+- Set **Nb copies** parameter equal to 6
+.. image:: images/tutorial10_1.png
+   :align: center
+
+.. centered::
+   Angular Copy around OZ
+- Click **Apply** button in the property panel
+.. image:: images/tutorial10_2.png
+   :align: center
+
+.. centered::
+   Copied Box
+
+Step11. Cut.
+------------
+
+- Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node
+- Click on the eye icon on the left of the result item to show it in the view
+- Start :ref:`Cut <featureCut>` creation via Main Menu *Features - > Cut*
+- Select the fillet object in the view as a main object
+- Select the angular copy object in the object browser as a tool object
+.. image:: images/tutorial11_1.png
+   :align: center
+
+.. centered::
+   Cut creation
+- Click **Apply** button in the property panel
+- Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node
+- Click right mouse button and select **Color...** item in the popup menu
+- Set (R: 255, G: 214, B: 0) color and click **OK** button
+
+.. image:: images/tutorial11_2.png
+   :align: center
+
+.. centered::
+   Cut
+
+
+**See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.
\ No newline at end of file
diff --git a/doc/gui/examples/tutorial.py b/doc/gui/examples/tutorial.py
new file mode 100644 (file)
index 0000000..d6519c9
--- /dev/null
@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+
+from SketchAPI import *
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+
+# Step1. Sketch.
+Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY"))
+SketchLine_1 = Sketch_1.addLine(-57.7, 99.93933159672423, 57.7, 99.93933159672423)
+SketchLine_2 = Sketch_1.addLine(57.7, 99.93933159672423, 0, 0)
+SketchLine_2.setAuxiliary(True)
+SketchConstraintCoincidence_1 = Sketch_1.setCoincident(SketchLine_1.endPoint(), SketchLine_2.startPoint())
+SketchLine_3 = Sketch_1.addLine(0, 0, -57.7, 99.93933159672423)
+SketchLine_3.setAuxiliary(True)
+SketchConstraintCoincidence_2 = Sketch_1.setCoincident(SketchLine_2.endPoint(), SketchLine_3.startPoint())
+SketchConstraintCoincidence_3 = Sketch_1.setCoincident(SketchLine_1.startPoint(), SketchLine_3.endPoint())
+SketchProjection_1 = Sketch_1.addProjection(model.selection("VERTEX", "PartSet/Origin"), False)
+SketchPoint_1 = SketchProjection_1.createdFeature()
+SketchConstraintCoincidence_4 = Sketch_1.setCoincident(SketchLine_3.startPoint(), SketchAPI_Point(SketchPoint_1).coordinates())
+SketchProjection_2 = Sketch_1.addProjection(model.selection("EDGE", "PartSet/OY"), False)
+SketchLine_4 = SketchProjection_2.createdFeature()
+SketchConstraintPerpendicular_1 = Sketch_1.setPerpendicular(SketchLine_4.result(), SketchLine_1.result())
+SketchConstraintEqual_1 = Sketch_1.setEqual(SketchLine_3.result(), SketchLine_1.result())
+SketchConstraintEqual_2 = Sketch_1.setEqual(SketchLine_2.result(), SketchLine_1.result())
+SketchMultiRotation_1 = Sketch_1.addRotation([SketchLine_1.result()], SketchAPI_Line(SketchLine_4).startPoint(), 360, 6, True)
+[SketchLine_5, SketchLine_6, SketchLine_7, SketchLine_8, SketchLine_9] = SketchMultiRotation_1.rotated()
+SketchConstraintLength_1 = Sketch_1.setLength(SketchLine_1.result(), 115.4)
+model.do()
+
+# Step2. Polyline.
+Point_2 = model.addPoint(Part_1_doc, 50, 0, 0)
+Point_2.result().setColor(0, 0, 255)
+Point_3 = model.addPoint(Part_1_doc, 80, 0, 0)
+Point_3.result().setColor(0, 0, 255)
+Point_4 = model.addPoint(Part_1_doc, 112, 0, 13)
+Point_4.result().setColor(0, 0, 255)
+Point_5 = model.addPoint(Part_1_doc, 112, 0, 48)
+Point_5.result().setColor(0, 0, 255)
+Point_6 = model.addPoint(Part_1_doc, 80, 0, 63)
+Point_6.result().setColor(0, 0, 255)
+Point_7 = model.addPoint(Part_1_doc, 80, 0, 90)
+Point_7.result().setColor(0, 0, 255)
+Point_8 = model.addPoint(Part_1_doc, 50, 0, 90)
+Point_8.result().setColor(0, 0, 255)
+
+Polyline_1_objects = [model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Point_2"),
+                      model.selection("VERTEX", "Point_3"), model.selection("VERTEX", "Point_4"),
+                      model.selection("VERTEX", "Point_5"), model.selection("VERTEX", "Point_6"),
+                      model.selection("VERTEX", "Point_7")]
+Polyline_1 = model.addPolyline3D(Part_1_doc, Polyline_1_objects, True)
+
+# Step3. Face.
+Face_1 = model.addFace(Part_1_doc, [model.selection("WIRE", "Polyline_1_1")])
+
+# Step4. Revolution.
+Revolution_1 = model.addRevolution(Part_1_doc, [model.selection("FACE", "Face_1_1")], model.selection("EDGE", "PartSet/OZ"), 360, 0)
+
+# Step5. Extrusion.
+Wire_Name = "Sketch_1/Wire-SketchLine_1r-SketchLine_5r-SketchLine_6r-SketchLine_7r-SketchLine_8r-SketchLine_9r"
+Extrusion_1 = model.addExtrusion(Part_1_doc, [model.selection("WIRE", Wire_Name)], model.selection("EDGE", "PartSet/OZ"), 100, 0)
+
+# Step6. Common.
+Common_1 = model.addCommon(Part_1_doc, [model.selection("SOLID", "Revolution_1_1"), model.selection("SOLID", "Extrusion_1_1")])
+
+# Step7. Fillet.
+Fillet_1 = model.addFillet(Part_1_doc, [model.selection("EDGE", "Revolution_1_1/Generated_Face_5&Common_1_1/Modified_Face_10")], 10)
+
+# Step8. Box.
+Box_1 = model.addBox(Part_1_doc, 20, 120, 20)
+
+# Step9. Translation.
+Translation_1 = model.addTranslation(Part_1_doc, [model.selection("SOLID", "Box_1_1")], -10, 20, 70)
+
+# Step10. Angular Copy.
+AngularCopy_1 = model.addMultiRotation(Part_1_doc, [model.selection("SOLID", "Translation_1_1")], model.selection("EDGE", "PartSet/OZ"), 6)
+
+# Step11. Cut.
+Cut_1 = model.addCut(Part_1_doc, [model.selection("SOLID", "Fillet_1_1")], [model.selection("COMPOUND", "AngularCopy_1_1")])
+Cut_1.result().setColor(255, 214, 0)
+
+model.do()
+model.end()
diff --git a/doc/gui/images/tutorial10_1.png b/doc/gui/images/tutorial10_1.png
new file mode 100644 (file)
index 0000000..43e9fed
Binary files /dev/null and b/doc/gui/images/tutorial10_1.png differ
diff --git a/doc/gui/images/tutorial10_2.png b/doc/gui/images/tutorial10_2.png
new file mode 100644 (file)
index 0000000..c2bb26d
Binary files /dev/null and b/doc/gui/images/tutorial10_2.png differ
diff --git a/doc/gui/images/tutorial11_1.png b/doc/gui/images/tutorial11_1.png
new file mode 100644 (file)
index 0000000..0590192
Binary files /dev/null and b/doc/gui/images/tutorial11_1.png differ
diff --git a/doc/gui/images/tutorial11_2.png b/doc/gui/images/tutorial11_2.png
new file mode 100644 (file)
index 0000000..503cbc5
Binary files /dev/null and b/doc/gui/images/tutorial11_2.png differ
diff --git a/doc/gui/images/tutorial1_1.png b/doc/gui/images/tutorial1_1.png
new file mode 100644 (file)
index 0000000..3959a9a
Binary files /dev/null and b/doc/gui/images/tutorial1_1.png differ
diff --git a/doc/gui/images/tutorial1_10.png b/doc/gui/images/tutorial1_10.png
new file mode 100644 (file)
index 0000000..bb4c6a8
Binary files /dev/null and b/doc/gui/images/tutorial1_10.png differ
diff --git a/doc/gui/images/tutorial1_11.png b/doc/gui/images/tutorial1_11.png
new file mode 100644 (file)
index 0000000..2333c29
Binary files /dev/null and b/doc/gui/images/tutorial1_11.png differ
diff --git a/doc/gui/images/tutorial1_12.png b/doc/gui/images/tutorial1_12.png
new file mode 100644 (file)
index 0000000..02757a8
Binary files /dev/null and b/doc/gui/images/tutorial1_12.png differ
diff --git a/doc/gui/images/tutorial1_2.png b/doc/gui/images/tutorial1_2.png
new file mode 100644 (file)
index 0000000..35b2d03
Binary files /dev/null and b/doc/gui/images/tutorial1_2.png differ
diff --git a/doc/gui/images/tutorial1_3.png b/doc/gui/images/tutorial1_3.png
new file mode 100644 (file)
index 0000000..3e03bb8
Binary files /dev/null and b/doc/gui/images/tutorial1_3.png differ
diff --git a/doc/gui/images/tutorial1_4.png b/doc/gui/images/tutorial1_4.png
new file mode 100644 (file)
index 0000000..b722cbd
Binary files /dev/null and b/doc/gui/images/tutorial1_4.png differ
diff --git a/doc/gui/images/tutorial1_5.png b/doc/gui/images/tutorial1_5.png
new file mode 100644 (file)
index 0000000..a0ec10d
Binary files /dev/null and b/doc/gui/images/tutorial1_5.png differ
diff --git a/doc/gui/images/tutorial1_6.png b/doc/gui/images/tutorial1_6.png
new file mode 100644 (file)
index 0000000..73b920b
Binary files /dev/null and b/doc/gui/images/tutorial1_6.png differ
diff --git a/doc/gui/images/tutorial1_7.png b/doc/gui/images/tutorial1_7.png
new file mode 100644 (file)
index 0000000..7be8ac8
Binary files /dev/null and b/doc/gui/images/tutorial1_7.png differ
diff --git a/doc/gui/images/tutorial1_8.png b/doc/gui/images/tutorial1_8.png
new file mode 100644 (file)
index 0000000..883489e
Binary files /dev/null and b/doc/gui/images/tutorial1_8.png differ
diff --git a/doc/gui/images/tutorial1_9.png b/doc/gui/images/tutorial1_9.png
new file mode 100644 (file)
index 0000000..67460cf
Binary files /dev/null and b/doc/gui/images/tutorial1_9.png differ
diff --git a/doc/gui/images/tutorial2_1.png b/doc/gui/images/tutorial2_1.png
new file mode 100644 (file)
index 0000000..c04a3ab
Binary files /dev/null and b/doc/gui/images/tutorial2_1.png differ
diff --git a/doc/gui/images/tutorial2_2.png b/doc/gui/images/tutorial2_2.png
new file mode 100644 (file)
index 0000000..15a18c2
Binary files /dev/null and b/doc/gui/images/tutorial2_2.png differ
diff --git a/doc/gui/images/tutorial2_3.png b/doc/gui/images/tutorial2_3.png
new file mode 100644 (file)
index 0000000..3bc12cc
Binary files /dev/null and b/doc/gui/images/tutorial2_3.png differ
diff --git a/doc/gui/images/tutorial2_4.png b/doc/gui/images/tutorial2_4.png
new file mode 100644 (file)
index 0000000..f79018b
Binary files /dev/null and b/doc/gui/images/tutorial2_4.png differ
diff --git a/doc/gui/images/tutorial3_1.png b/doc/gui/images/tutorial3_1.png
new file mode 100644 (file)
index 0000000..2f6c14e
Binary files /dev/null and b/doc/gui/images/tutorial3_1.png differ
diff --git a/doc/gui/images/tutorial3_2.png b/doc/gui/images/tutorial3_2.png
new file mode 100644 (file)
index 0000000..39256bb
Binary files /dev/null and b/doc/gui/images/tutorial3_2.png differ
diff --git a/doc/gui/images/tutorial4_1.png b/doc/gui/images/tutorial4_1.png
new file mode 100644 (file)
index 0000000..54b3d49
Binary files /dev/null and b/doc/gui/images/tutorial4_1.png differ
diff --git a/doc/gui/images/tutorial4_2.png b/doc/gui/images/tutorial4_2.png
new file mode 100644 (file)
index 0000000..8342c35
Binary files /dev/null and b/doc/gui/images/tutorial4_2.png differ
diff --git a/doc/gui/images/tutorial5_1.png b/doc/gui/images/tutorial5_1.png
new file mode 100644 (file)
index 0000000..7975c6c
Binary files /dev/null and b/doc/gui/images/tutorial5_1.png differ
diff --git a/doc/gui/images/tutorial5_2.png b/doc/gui/images/tutorial5_2.png
new file mode 100644 (file)
index 0000000..9fc0888
Binary files /dev/null and b/doc/gui/images/tutorial5_2.png differ
diff --git a/doc/gui/images/tutorial6_1.png b/doc/gui/images/tutorial6_1.png
new file mode 100644 (file)
index 0000000..cbaf203
Binary files /dev/null and b/doc/gui/images/tutorial6_1.png differ
diff --git a/doc/gui/images/tutorial6_2.png b/doc/gui/images/tutorial6_2.png
new file mode 100644 (file)
index 0000000..11cc511
Binary files /dev/null and b/doc/gui/images/tutorial6_2.png differ
diff --git a/doc/gui/images/tutorial7_1.png b/doc/gui/images/tutorial7_1.png
new file mode 100644 (file)
index 0000000..3ad2595
Binary files /dev/null and b/doc/gui/images/tutorial7_1.png differ
diff --git a/doc/gui/images/tutorial7_2.png b/doc/gui/images/tutorial7_2.png
new file mode 100644 (file)
index 0000000..a655a54
Binary files /dev/null and b/doc/gui/images/tutorial7_2.png differ
diff --git a/doc/gui/images/tutorial7_3.png b/doc/gui/images/tutorial7_3.png
new file mode 100644 (file)
index 0000000..6e078ab
Binary files /dev/null and b/doc/gui/images/tutorial7_3.png differ
diff --git a/doc/gui/images/tutorial8_1.png b/doc/gui/images/tutorial8_1.png
new file mode 100644 (file)
index 0000000..eb5bee6
Binary files /dev/null and b/doc/gui/images/tutorial8_1.png differ
diff --git a/doc/gui/images/tutorial8_2.png b/doc/gui/images/tutorial8_2.png
new file mode 100644 (file)
index 0000000..02bf758
Binary files /dev/null and b/doc/gui/images/tutorial8_2.png differ
diff --git a/doc/gui/images/tutorial9_1.png b/doc/gui/images/tutorial9_1.png
new file mode 100644 (file)
index 0000000..18ea3a2
Binary files /dev/null and b/doc/gui/images/tutorial9_1.png differ
diff --git a/doc/gui/images/tutorial9_2.png b/doc/gui/images/tutorial9_2.png
new file mode 100644 (file)
index 0000000..028c704
Binary files /dev/null and b/doc/gui/images/tutorial9_2.png differ
index ba442707e2a907e5cef105c7249dce736b60c3ef..76d491ee12519c154b1868f02145fd3fc6854693 100644 (file)
@@ -7,6 +7,7 @@ Welcome to SHAPER's documentation!
 ==================================
 
 - :ref:`introduction`
+- :ref:`tutorial`
 
 .. toctree::
    :titlesonly:
index ea1332265e1876f88a33fe9281da45bee6f8d05b..384a3b06b27401c8a167bd3b656ec9d5b26315bc 100644 (file)
@@ -1,3 +1,4 @@
+.. _buildFace:
 
 Face
 ====
index 1e08de4e42cf8e510f5d2757225deba3e577581d..8cff44a70fb8437cb232faa23a177d21c3b65f50 100644 (file)
@@ -1,3 +1,4 @@
+.. _buildPolyline:
 
 Polyline
 ========
index caeff7ca53e4929aa575fe01211de432073e2915..9d9ec927da46f23c8c2e46d4f1ca7d67219d8fd1 100644 (file)
@@ -1,3 +1,4 @@
+.. _constructionPoint:
 
 Point
 =====
index 4371726b783dc8586da36d312870933a2f067eb2..c6c5eb047cc02a007e3e639e9b85e7ceda9d9822 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureAngularCopy:
 
 Angular copy
 ============
index 7324955eb634f4e7fb15a0cb1966ecbf1f803a52..e6a7dc763372091262dddb115e4d6c2937ae59bf 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureCommon:
 
 Common
 ======
index 053bfa3a8ec603bdc0b1a27cb4208e2b62ca7312..e5c8bae88497df4b413379d667593c16e39e9539 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureCut:
 
 Cut
 ===
index 7ba3b93c6fc8a327ead51c1a0cfad302d68a6356..3fdf196be949fb2c9f2cfdf44bd0857a8f725bd5 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureExtrusion:
 
 Extrusion
 =========
index d30e8da2ed545bbf0cf2905d2dff397f35192de1..b3d0c89c3506137aff85d89ee7377227103dcfdc 100644 (file)
@@ -1,4 +1,6 @@
 
+.. _featureFillet:
+
 Fillet
 ======
 
index 648deb89d83b6bcb40a4abdd66b65830630bf9d9..ca419aa147039b958e2399133c45704ebd00f08e 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureRevolution:
 
 Revolution
 ==========
index 38bef70b99389a4170cbba9fb4378b469d261530..a196990ebfbe1bb6493d802051fde2b1d3a92cff 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureRotation:
 
 Rotation
 ========
index 47099261a7ec899c36e100a510134189cd3f7e88..d38c0d7600fc6b067c369e1841c02b29ce4c5afc 100644 (file)
@@ -1,3 +1,4 @@
+.. _featureTranslation:
 
 Translation
 ===========
index 70d009b7dfbe66ee8087064a89e801da2b45af67..25fcbf7c9953d1049f23530a66e52349f777cd1b 100644 (file)
@@ -4,6 +4,8 @@
 Part plug-in
 ============
 
+.. _new-part:
+
 New Part
 --------
 
index 68117925a7fc025b14076ed0205142297d5610e9..ef66b0a82e41bfcba78334aacdc753a5efcb6f99 100644 (file)
@@ -1,3 +1,4 @@
+.. _sketchCoincident:
 
 Coincident constraint
 =====================
index a3679689653cb8f588173cad3be734605d483fe5..373c977b4434cda7565b1c9bb3ad095f8d087d3b 100644 (file)
@@ -1,3 +1,4 @@
+.. _sketchEqual:
 
 Equal constraint
 ================
index c74ec6ccd19435cd72f3251acdba626f5416fb09..c6f720e469900bc050d0f9b39318ac7256de661a 100644 (file)
@@ -1,3 +1,4 @@
+.. _sketchLength:
 
 Length constraint
 =================
index a832a7e132beda8ae179f7a4f95c5179aec571e0..35207ee966ccf500420e1c1e9f8de25e5f01987c 100644 (file)
@@ -1,3 +1,4 @@
+.. _sketchLine:
 
 Line
 ====
index a14512206435d97f9dae128adf268a495b56e769..0a933c7f9c02d2f8495a61a6a92ed612df07e31f 100644 (file)
@@ -1,3 +1,4 @@
+.. _sketchPerpendicular:
 
 Perpendicular constraint
 ========================
index 592417d0403f562e57476db0c9e1812a17cebb9c..fb5324a6c17338f70c20b35874654743c6184d31 100644 (file)
@@ -1,3 +1,4 @@
+.. _sketchAngularCopy:
 
 Angular copy
 ============