From: asozinov Date: Tue, 31 Jan 2023 11:21:44 +0000 (+0300) Subject: docs X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=refs%2Fheads%2F32541_bos;p=modules%2Fshaper.git docs --- diff --git a/src/SAMConverter/doc/SAMConverter.rst b/src/SAMConverter/doc/SAMConverter.rst index abe01e341..9aee331ad 100644 --- a/src/SAMConverter/doc/SAMConverter.rst +++ b/src/SAMConverter/doc/SAMConverter.rst @@ -4,9 +4,48 @@ SAM plug-in ================ -SAM plug-in implements features for Sketch conversion to SAM format and to call Suggest Constraints macro. +SAM plug-in include feature for Sketch conversion to SAM format followed by a Suggest Constraints macro call. -It provides the following features: +SAM format +"""""" + +SAM - Sketch datA Model. This format is a memory model written in Python + +This format provided following elements: + +**Available primitives** + +- Arc +- Circle +- Line +- Point + +**Available constraints** + +- Angle +- Coincident +- Distance +- HorizontalDistance +- VerticalDistance +- Equal +- Horizontal +- Midpoint +- Parallel +- Perpendicular +- Tangent +- Vertical +- Radius +- Length + +This elements are detected, but they is not part of the SAM model + +**External elements** + +- Projection +- Intersection + + +It provides the following feature: .. toctree:: :titlesonly: diff --git a/src/SAMConverter/doc/images/SuggestConstraint_afterApply.png b/src/SAMConverter/doc/images/SuggestConstraint_afterApply.png new file mode 100644 index 000000000..c0f122e28 Binary files /dev/null and b/src/SAMConverter/doc/images/SuggestConstraint_afterApply.png differ diff --git a/src/SAMConverter/doc/images/SuggestConstraint_beforeApply.png b/src/SAMConverter/doc/images/SuggestConstraint_beforeApply.png new file mode 100644 index 000000000..d5af98d04 Binary files /dev/null and b/src/SAMConverter/doc/images/SuggestConstraint_beforeApply.png differ diff --git a/src/SAMConverter/doc/suggestConstraintsFeature.rst b/src/SAMConverter/doc/suggestConstraintsFeature.rst index b78c91f23..a8fe64c06 100644 --- a/src/SAMConverter/doc/suggestConstraintsFeature.rst +++ b/src/SAMConverter/doc/suggestConstraintsFeature.rst @@ -42,7 +42,7 @@ Widget content: - *Checkbox* for select the constraints to be applied - *Line* for constraints that require a parameter(angle, length, etc) -- Information about remaining Degree of Liberty (DoF) and new DoF if the selected constraints are applied. +- Information about remaining Degree of Liberty (DoF) at the start of the macro activation and new DoF when the selected constraints are applied. - **Apply** button applies the selected restrictions and completes the operation - **Apply and continue** button applies the selected restrictions and show new predicted constraints. Old list of constraints will be cleared. @@ -55,4 +55,14 @@ if two constraints are applied together, they will also be cancelled together. Result """""" -Created new constraints, suggested using ML \ No newline at end of file +Created new constraints, suggested using ML + +Sketch before apply selected constraints + +.. figure:: images/SuggestConstraint_beforeApply.png + :align: center + +After click on Apply button: + +.. figure:: images/SuggestConstraint_afterApply.png + :align: center \ No newline at end of file