Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.

[modules/shaper.git] / src / SketchPlugin / doc / SketchPlugin.rst

diff --git a/src/SketchPlugin/doc/SketchPlugin.rst b/src/SketchPlugin/doc/SketchPlugin.rst
index ce7b6fd1920467a943cc0457e7826acf463c0bfe..af4cefe57be960111ca2cb96c8aedc0e0376e77b 100644 (file)
--- a/src/SketchPlugin/doc/SketchPlugin.rst
+++ b/src/SketchPlugin/doc/SketchPlugin.rst
@@ -1,11 +1,12 @@
 
 .. _sketchPlugin:
 
 .. _sketchPlugin:

-.. |SketchButton.icon|    image:: images/SketchButton.png

 
 
 Sketch plug-in
 ================
 
 
 
 Sketch plug-in
 ================
 

+.. |SketchButton.icon|    image:: images/SketchButton.png
+

 Sketch plug-in includes features for creation of 2D shapes.
 
 The sketch creation takes the following steps:
 Sketch plug-in includes features for creation of 2D shapes.
 
 The sketch creation takes the following steps:


@@ -24,7 +25,7 @@ To create a Sketch:
 
 First define a plane for the sketch:
 
 
 First define a plane for the sketch:
 

-.. image:: images/PlaneDefinition.png
+.. figure:: images/PlaneDefinition.png

    :align: center
 
 - specify plane size (equal to 25 in the example above);
    :align: center
 
 - specify plane size (equal to 25 in the example above);


@@ -32,22 +33,25 @@ First define a plane for the sketch:
 
 Note that coordinate planes will be suggested for selection if no convenient objects for plane selection are displayed in the viewer:
 
 
 Note that coordinate planes will be suggested for selection if no convenient objects for plane selection are displayed in the viewer:
 

-.. image:: images/CoordinatePlanes.png
+.. figure:: images/CoordinatePlanes.png

    :align: center
 
 After the plane for sketch is selected, the following property panel will be opened:
 
    :align: center
 
 After the plane for sketch is selected, the following property panel will be opened:
 

-.. image:: images/SketchPanel.png
+.. figure:: images/SketchPanel.png

    :align: center
 
    :align: center
 

-.. centered::
-  Sketch general panel
+   Sketch general panel

 
 - **Reversed** check box - allows reversing the sketch plane normal;
 - **Set plane view** button - switches the viewer to the top view for the sketch plane;
 - **Show geometrical constraints** check box - displays/hides geometrical constraints:
 - **Show dimensional constraints** check box - displays/hides dimensional constraints; 
 - **Show existing expressions** check box - displays/hides expressions.
 
 - **Reversed** check box - allows reversing the sketch plane normal;
 - **Set plane view** button - switches the viewer to the top view for the sketch plane;
 - **Show geometrical constraints** check box - displays/hides geometrical constraints:
 - **Show dimensional constraints** check box - displays/hides dimensional constraints; 
 - **Show existing expressions** check box - displays/hides expressions.

+- **Show free points** check box - highlights free points in the current sketch if it is checked.
+- **Automatic constraints** - automatically create horizontal or vertical constraints if angle between created line and horizontal or vertical less then angular tolerance (defined in preferences).
+- **Change sketch plane** button - allows to change working plane of the current sketch.
+- **Show remaining DoFs** button - highlights all sketch edges which are not fully constrained.

 
 Now it is possible to:
 
 
 Now it is possible to:
 


@@ -86,6 +90,9 @@ The plug-in includes the following features for creation of 2D objects:
    rectangleFeature.rst
    circleFeature.rst
    arcFeature.rst
    rectangleFeature.rst
    circleFeature.rst
    arcFeature.rst

+   ellipseFeature.rst
+   arcEllipseFeature.rst
+   bsplineFeature.rst

 
 .. _sketch_constraints:
 
 
 .. _sketch_constraints:
 


@@ -98,19 +105,17 @@ The goal of constraints creation is to fix sketch geometry, i.e. set degrees of
 
 If all degrees of freedom are eliminated, the sketch is fixed and displayed with green color.
 
 
 If all degrees of freedom are eliminated, the sketch is fixed and displayed with green color.
 

-.. image:: images/Sketch_fixed.png
+.. figure:: images/Sketch_fixed.png

    :align: center
 
    :align: center
 

-.. centered::
-  Fixed Sketch
+   Fixed Sketch

 
 If any degrees of freedom remain unsolved, the sketch is under-constrained and displayed with red color.
 
 
 If any degrees of freedom remain unsolved, the sketch is under-constrained and displayed with red color.
 

-.. image:: images/Sketch_underconstrained.png
+.. figure:: images/Sketch_underconstrained.png

    :align: center
 
    :align: center
 

-.. centered::
-  Underconstrained Sketch
+   Underconstrained Sketch

 
 The plug-in includes the following constraints:
 
 
 The plug-in includes the following constraints:
 


@@ -136,6 +141,25 @@ The plug-in includes the following constraints:
 
 .. _sketch_operations:
 
 
 .. _sketch_operations:
 

+Overconstraned state
+--------------------
+
+Sketcher comes into overconstrained state when an extra constraint was defined. The following picture shows an example of the overconstrained state:
+
+.. figure:: images/Overconstrained.png
+   :align: center
+
+   Overconstrained Sketch
+
+When Sketcher gets this state then:
+
+- buttons Apply and Cancel for the whole Sketcher are blocked;
+- a constraint which causes the overconstraint state is highlightid by red color;
+- a warning message in sketcher Property Panel is shown with recomendation what to do in this case;
+- an additional Undo button is shown under the warning messages;
+
+After undoing the last operation or deletion of a conflicting constraint Sketcher will be reverted into a normal state.
+

 Operations
 ----------
 Operations modify existing features of the sketch or create new ones by copying them.
 Operations
 ----------
 Operations modify existing features of the sketch or create new ones by copying them.


@@ -154,3 +178,4 @@ The plug-in includes the following operations:
    translationFeature.rst
    rotationFeature.rst
    sketchDrawer.rst
    translationFeature.rst
    rotationFeature.rst
    sketchDrawer.rst

+   sketchCopy.rst