From: dbv Date: Thu, 4 Oct 2018 11:39:32 +0000 (+0300) Subject: Documentation X-Git-Tag: CEA_2018-2~5 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=92fd01627d9ab299cfd35df5404e4f54a5340a55;p=modules%2Fshaper.git Documentation --- diff --git a/src/FeaturesPlugin/doc/TUI_extrusionByBoundingPlanes.rst b/src/FeaturesPlugin/doc/TUI_extrusionByBoundingPlanes.rst new file mode 100644 index 000000000..d34c3c806 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_extrusionByBoundingPlanes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_extrusion_by_bounding_planes: + +Create Extrusion by bounding planes +=================================== + +.. literalinclude:: examples/extrusion_by_bounding_planes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_extrusionBySizes.rst b/src/FeaturesPlugin/doc/TUI_extrusionBySizes.rst new file mode 100644 index 000000000..a6cfeaf2b --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_extrusionBySizes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_extrusion_by_sizes: + +Create Extrusion by sizes +========================= + +.. literalinclude:: examples/extrusion_by_sizes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_extrusionCutByBoundingPlanes.rst b/src/FeaturesPlugin/doc/TUI_extrusionCutByBoundingPlanes.rst new file mode 100644 index 000000000..4927e4093 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_extrusionCutByBoundingPlanes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_extrusion_cut_by_bounding_planes: + +Create Extrusion Cut by bounding planes +======================================= + +.. literalinclude:: examples/extrusion_cut_by_bounding_planes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_extrusionCutBySizes.rst b/src/FeaturesPlugin/doc/TUI_extrusionCutBySizes.rst new file mode 100644 index 000000000..8f2cafa97 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_extrusionCutBySizes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_extrusion_cut_by_sizes: + +Create Extrusion Cut by sizes +============================= + +.. literalinclude:: examples/extrusion_cut_by_sizes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_extrusionFeature.rst b/src/FeaturesPlugin/doc/TUI_extrusionFeature.rst deleted file mode 100644 index 633cf7374..000000000 --- a/src/FeaturesPlugin/doc/TUI_extrusionFeature.rst +++ /dev/null @@ -1,12 +0,0 @@ - - .. tui_create_extrusion: - -Create Extrusion by sizes -========================= - -.. literalinclude:: examples/extrusion.py - :linenos: - :language: python - -:download:`Download this script ` - diff --git a/src/FeaturesPlugin/doc/TUI_extrusionFuseByBoundingPlanes.rst b/src/FeaturesPlugin/doc/TUI_extrusionFuseByBoundingPlanes.rst new file mode 100644 index 000000000..17a255fe6 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_extrusionFuseByBoundingPlanes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_extrusion_fuse_by_bounding_planes: + +Create Extrusion Fuse by bounding planes +======================================== + +.. literalinclude:: examples/extrusion_fuse_by_bounding_planes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_extrusionFuseBySizes.rst b/src/FeaturesPlugin/doc/TUI_extrusionFuseBySizes.rst new file mode 100644 index 000000000..84bdf576b --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_extrusionFuseBySizes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_extrusion_fuse_by_sizes: + +Create Extrusion Fuse by sizes +============================== + +.. literalinclude:: examples/extrusion_fuse_by_sizes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_removeSubShapesFeature.rst b/src/FeaturesPlugin/doc/TUI_removeSubShapesFeature.rst new file mode 100644 index 000000000..49e95a62f --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_removeSubShapesFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_remove_subshapes: + +Remove Sub-Shapes +================= + +.. literalinclude:: examples/remove_subshapes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_revolutionByAngles.rst b/src/FeaturesPlugin/doc/TUI_revolutionByAngles.rst new file mode 100644 index 000000000..2ada16697 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_revolutionByAngles.rst @@ -0,0 +1,12 @@ + + .. _tui_create_revolution_by_angles: + +Create Revolution by angles +=========================== + +.. literalinclude:: examples/revolution_by_angles.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_revolutionByBoundingPlanes.rst b/src/FeaturesPlugin/doc/TUI_revolutionByBoundingPlanes.rst new file mode 100644 index 000000000..e72ab58e8 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_revolutionByBoundingPlanes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_revolution_by_bounding_planes: + +Create Revolution by bounding planes +==================================== + +.. literalinclude:: examples/revolution_by_bounding_planes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_revolutionCutByAngles.rst b/src/FeaturesPlugin/doc/TUI_revolutionCutByAngles.rst new file mode 100644 index 000000000..a9a57c409 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_revolutionCutByAngles.rst @@ -0,0 +1,12 @@ + + .. _tui_create_revolution_cut_by_angles: + +Create Revolution Cut by angles +=============================== + +.. literalinclude:: examples/revolution_cut_by_angles.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_revolutionCutByBoundingPlanes.rst b/src/FeaturesPlugin/doc/TUI_revolutionCutByBoundingPlanes.rst new file mode 100644 index 000000000..0cad5692d --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_revolutionCutByBoundingPlanes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_revolution_cut_by_bounding_planes: + +Create Revolution Cut by bounding planes +======================================== + +.. literalinclude:: examples/revolution_cut_by_bounding_planes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_revolutionFuseByAngles.rst b/src/FeaturesPlugin/doc/TUI_revolutionFuseByAngles.rst new file mode 100644 index 000000000..aba5f2a12 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_revolutionFuseByAngles.rst @@ -0,0 +1,12 @@ + + .. _tui_create_revolution_fuse_by_angles: + +Create Revolution Fuse by angles +================================ + +.. literalinclude:: examples/revolution_fuse_by_angles.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/TUI_revolutionFuseByBoundingPlanes.rst b/src/FeaturesPlugin/doc/TUI_revolutionFuseByBoundingPlanes.rst new file mode 100644 index 000000000..f70c94056 --- /dev/null +++ b/src/FeaturesPlugin/doc/TUI_revolutionFuseByBoundingPlanes.rst @@ -0,0 +1,12 @@ + + .. _tui_create_revolution_fuse_by_bounding_planes: + +Create Revolution Fuse by bounding planes +========================================= + +.. literalinclude:: examples/revolution_fuse_by_bounding_planes.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/FeaturesPlugin/doc/examples/extrusion_by_bounding_planes.py b/src/FeaturesPlugin/doc/examples/extrusion_by_bounding_planes.py new file mode 100644 index 000000000..a570b01a8 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/extrusion_by_bounding_planes.py @@ -0,0 +1,28 @@ +# -*- 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.standardPlane("XOY")) +SketchCircle_1 = Sketch_1.addCircle(0, 0, 50) +model.do() +Plane_4 = model.addPlane(Part_1_doc, + model.selection("FACE", "PartSet/XOY"), + model.selection("EDGE", "PartSet/OX"), + 45) +Plane_5 = model.addPlane(Part_1_doc, + model.selection("FACE", "PartSet/XOY"), + model.selection("EDGE", "PartSet/OX"), + 315) +Extrusion_1 = model.addExtrusion(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection(), + model.selection("FACE", "Plane_2"), + 50, + model.selection("FACE", "Plane_1"), + 50) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/extrusion_by_sizes.py b/src/FeaturesPlugin/doc/examples/extrusion_by_sizes.py index 56f329f7a..b169094fc 100644 --- a/src/FeaturesPlugin/doc/examples/extrusion_by_sizes.py +++ b/src/FeaturesPlugin/doc/examples/extrusion_by_sizes.py @@ -7,11 +7,12 @@ partSet = model.moduleDocument() Part_1 = model.addPart(partSet) Part_1_doc = Part_1.document() Sketch_1 = model.addSketch(Part_1_doc, model.standardPlane("XOY")) -SketchProjection_1 = Sketch_1.addProjection(model.selection("VERTEX", "PartSet/Origin"), False) -SketchPoint_1 = SketchProjection_1.createdFeature() -SketchCircle_1 = Sketch_1.addCircle(0, 0, 27.26724996788554) -SketchConstraintCoincidence_1 = Sketch_1.setCoincident(SketchPoint_1.result(), SketchCircle_1.center()) +SketchCircle_1 = Sketch_1.addCircle(0, 0, 25) model.do() -Extrusion_1 = model.addExtrusion(Part_1_doc, [model.selection("FACE", "Sketch_1/Face-SketchCircle_1_2f")], model.selection(), 50, 0) +Extrusion_1 = model.addExtrusion(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection(), + 50, + 0) model.do() model.end() diff --git a/src/FeaturesPlugin/doc/examples/extrusion_cut_by_bounding_planes.py b/src/FeaturesPlugin/doc/examples/extrusion_cut_by_bounding_planes.py new file mode 100644 index 000000000..1f27f5f77 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/extrusion_cut_by_bounding_planes.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +ExtrusionCut_1 = model.addExtrusionCut(Part_1_doc, + [], + model.selection(), + model.selection("FACE", "Box_1_1/Bottom"), + 0, + model.selection("FACE", "Box_1_1/Top"), + 0, + [model.selection("SOLID", "Box_1_1")]) +Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 0, 2) +ExtrusionCut_1.setNestedSketch(Sketch_1) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/extrusion_cut_by_sizes.py b/src/FeaturesPlugin/doc/examples/extrusion_cut_by_sizes.py new file mode 100644 index 000000000..237ea8528 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/extrusion_cut_by_sizes.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +ExtrusionCut_1 = model.addExtrusionCut(Part_1_doc, + [], + model.selection(), + 0, + 5, + [model.selection("SOLID", "Box_1_1")]) +Sketch_1 = model.addSketch(Part_1_doc, + model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 0, 2) +ExtrusionCut_1.setNestedSketch(Sketch_1) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/extrusion_fuse_by_bounding_planes.py b/src/FeaturesPlugin/doc/examples/extrusion_fuse_by_bounding_planes.py new file mode 100644 index 000000000..6e9dbea5d --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/extrusion_fuse_by_bounding_planes.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +ExtrusionFuse_1 = model.addExtrusionFuse(Part_1_doc, + [], + model.selection(), + model.selection("FACE", "Box_1_1/Bottom"), + 0, + model.selection("FACE", "Box_1_1/Top"), + 0, + [model.selection("SOLID", "Box_1_1")]) +Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 0, 2) +ExtrusionFuse_1.setNestedSketch(Sketch_1) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/extrusion_fuse_by_sizes.py b/src/FeaturesPlugin/doc/examples/extrusion_fuse_by_sizes.py new file mode 100644 index 000000000..c16590ff3 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/extrusion_fuse_by_sizes.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +ExtrusionFuse_1 = model.addExtrusionFuse(Part_1_doc, + [], + model.selection(), + 0, + 5, + [model.selection("SOLID", "Box_1_1")]) +Sketch_1 = model.addSketch(Part_1_doc, + model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 0, 2) +ExtrusionFuse_1.setNestedSketch(Sketch_1) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/remove_subshapes.py b/src/FeaturesPlugin/doc/examples/remove_subshapes.py new file mode 100644 index 000000000..161ecca30 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/remove_subshapes.py @@ -0,0 +1,22 @@ +# -*- 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.standardPlane("XOY")) +SketchCircle_1 = Sketch_1.addCircle(0, -25, 50) +SketchCircle_2 = Sketch_1.addCircle(0, 25, 50) +model.do() +Extrusion_1 = model.addExtrusion(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection(), + 10, + 0) +Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, + model.selection("COMPSOLID", "Extrusion_1_1")) +Remove_SubShapes_1.setSubShapesToRemove([model.selection("SOLID", "Extrusion_1_1_2")]) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/revolution_by_angles.py b/src/FeaturesPlugin/doc/examples/revolution_by_angles.py new file mode 100644 index 000000000..81748cef3 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/revolution_by_angles.py @@ -0,0 +1,18 @@ +# -*- 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.standardPlane("XOY")) +SketchCircle_1 = Sketch_1.addCircle(20, 20, 10) +model.do() +Revolution_1 = model.addRevolution(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection("EDGE", "PartSet/OY"), + 360, + 0) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/revolution_by_bounding_planes.py b/src/FeaturesPlugin/doc/examples/revolution_by_bounding_planes.py new file mode 100644 index 000000000..0830605ba --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/revolution_by_bounding_planes.py @@ -0,0 +1,20 @@ +# -*- 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.standardPlane("XOY")) +SketchCircle_1 = Sketch_1.addCircle(20, 20, 10) +model.do() +Revolution_1 = model.addRevolution(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection("EDGE", "PartSet/OY"), + model.selection("FACE", "PartSet/XOY"), + 0, + model.selection("FACE", "PartSet/YOZ"), + 0) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/revolution_cut_by_angles.py b/src/FeaturesPlugin/doc/examples/revolution_cut_by_angles.py new file mode 100644 index 000000000..295a9493c --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/revolution_cut_by_angles.py @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 5, 2.5) +model.do() +RevolutionCut_1 = model.addRevolutionCut(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), + 0, + 90, + [model.selection("SOLID", "Box_1_1")]) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/revolution_cut_by_bounding_planes.py b/src/FeaturesPlugin/doc/examples/revolution_cut_by_bounding_planes.py new file mode 100644 index 000000000..fba7ef081 --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/revolution_cut_by_bounding_planes.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 5, 2.5) +model.do() +RevolutionCut_1 = model.addRevolutionCut(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), + model.selection(), + 0, + model.selection("FACE", "Box_1_1/Front"), + 0, + [model.selection("SOLID", "Box_1_1")]) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/revolution_fuse_by_angles.py b/src/FeaturesPlugin/doc/examples/revolution_fuse_by_angles.py new file mode 100644 index 000000000..145a9a0fb --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/revolution_fuse_by_angles.py @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 5, 2.5) +model.do() +RevolutionCut_1 = model.addRevolutionFuse(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), + 90, + 0, + [model.selection("SOLID", "Box_1_1")]) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/examples/revolution_fuse_by_bounding_planes.py b/src/FeaturesPlugin/doc/examples/revolution_fuse_by_bounding_planes.py new file mode 100644 index 000000000..3e2c2e0ec --- /dev/null +++ b/src/FeaturesPlugin/doc/examples/revolution_fuse_by_bounding_planes.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Sketch_1 = model.addSketch(Part_1_doc, model.selection("FACE", "Box_1_1/Top")) +SketchCircle_1 = Sketch_1.addCircle(5, 5, 2.5) +model.do() +RevolutionCut_1 = model.addRevolutionFuse(Part_1_doc, + [model.selection("COMPOUND", "Sketch_1")], + model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), + model.selection("FACE", "Box_1_1/Front"), + 0, + model.selection(), + 0, + [model.selection("SOLID", "Box_1_1")]) +model.do() +model.end() diff --git a/src/FeaturesPlugin/doc/extrusionCutFeature.rst b/src/FeaturesPlugin/doc/extrusionCutFeature.rst index dfa156f03..f37762fc5 100644 --- a/src/FeaturesPlugin/doc/extrusionCutFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionCutFeature.rst @@ -1,7 +1,21 @@ -Extrusion cut +Extrusion Cut ============= +Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts result from other objects. + +To perform Extrusion Cut in the active part: + +#. select in the Main Menu *Features - > Extrusion Cut* item or +#. click **Extrusion Cut** button in the toolbar + +.. image:: images/extrusion_cut_btn.png + :align: center + +.. centered:: + **Extrusion Cut** button + +The following property panel will be opened: .. image:: images/StartSketch.png :align: center @@ -9,16 +23,95 @@ Extrusion cut .. centered:: Start sketch +After selecting one of the options property panel for Extrusion Cut will be opened with two variants: + +.. image:: images/extrusion_by_sizes.png + :align: left +**By Sizes** extrudes objects by specifying sizes. + +.. image:: images/extrusion_by_bounding_planes.png + :align: left +**By Bounding Planes** extrudes objects by specifying bounding planes and offsets. + + +By sizes +-------- .. image:: images/ExtrusionCut1.png :align: center .. centered:: - Extrusion: definition by sizes + Extrusion Cut: definition by sizes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used. +- **To size** size for extrusion along direction. +- **From size** size for extrusion in opposite direction. +- **Cut from** contains a list of objects which will but cut with the result of extrusion. + +**TUI Command**: *model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut);* + +**Arguments**: Part + list of objects for extrusion + size + list of objects to cut from. + +**TUI Command**: *model.addExtrusionCut(part, objects, direction, size, objectsToCut);* + +**Arguments**: Part + list of objects for extrusion + direction + size + list of objects to cut from. + +**TUI Command**: *model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut);* + +**Arguments**: Part + list of objects for extrusion + to size + from size + list of objects to cut from. + +**TUI Command**: *model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut);* + +**Arguments**: Part + list of objects for extrusion + direction + to size + from size + list of objects to cut from. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_cut_by_sizes_result.png + :align: center + +.. centered:: + **Extrusion Cut created** + +**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_cut_by_sizes` operation. +By bounding planes +------------------ .. image:: images/ExtrusionCut2.png :align: center .. centered:: - Extrusion: definition by bounding planes + Extrusion Cut: definition by bounding planes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used. +- **To plane** planar face can be selected to bound extrusion from one side. +- **To offset** offset for extrusion or for bounding plane if selected. +- **From plane** planar face can be selected to bound extrusion from other side. +- **From offset** offset for extrusion or for bounding plane if selected. +- **Cut from** contains a list of objects which will but cut with the result of extrusion. + +**TUI Command**: *model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut);* + +**Arguments**: Part + list of objects for extrusion + to object + to offset + from object + from offset + list of objects to cut from. + +**TUI Command**: *model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut);* + +**Arguments**: Part + list of objects for extrusion + direction + to object + to offset + from object + from offset + list of objects to cut from. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_cut_by_bounding_planes_result.png + :align: center + +.. centered:: + **Extrusion Cut created** + +**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_cut_by_bounding_planes` operation. diff --git a/src/FeaturesPlugin/doc/extrusionFeature.rst b/src/FeaturesPlugin/doc/extrusionFeature.rst index d1b85f14c..831509d68 100644 --- a/src/FeaturesPlugin/doc/extrusionFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFeature.rst @@ -1,4 +1,3 @@ -.. _featureExtrusion: Extrusion ========= @@ -35,8 +34,8 @@ After selecting one of the options property panel for Extrusion will be opened w **By Bounding Planes** extrudes objects by specifying bounding planes and offsets. -Simple ------- +By sizes +-------- .. image:: images/Extrusion1.png :align: center @@ -70,19 +69,47 @@ Result The Result of the operation will be an extruded shape: -.. image:: images/extrusion_result.png +.. image:: images/extrusion_by_sizes_result.png :align: center .. centered:: **Extrusion created** -**See Also** a sample TUI Script of a :ref:`tui_create_extrusion` operation. - - +**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_by_sizes` operation. +By bounding planes +------------------ .. image:: images/Extrusion2.png :align: center .. centered:: Extrusion: definition by bounding planes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used. +- **To plane** planar face can be selected to bound extrusion from one side. +- **To offset** offset for extrusion or for bounding plane if selected. +- **From plane** planar face can be selected to bound extrusion from other side. +- **From offset** offset for extrusion or for bounding plane if selected. + +**TUI Command**: *model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset);* + +**Arguments**: Part + list of objects + to object + to offset + from object + from offset. + +**TUI Command**: *model.addExtrusion(part, objects, direction, toObject, toOffset, fromObject, fromOffset);* + +**Arguments**: Part + list of objects + direction + to object + to offset + from object + from offset. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_by_bounding_planes_result.png + :align: center + +.. centered:: + **Extrusion created** + +**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_by_bounding_planes` operation. diff --git a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst index ab214ebf2..b67d1faa6 100644 --- a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst @@ -1,7 +1,21 @@ -Extrusion fuse -============== +Extrusion Fuse +============= +Extrusion Fuse feature extrudes selected objects along their normals or selected axis and fuses result with other objects. + +To perform Extrusion Fuse in the active part: + +#. select in the Main Menu *Features - > Extrusion Fuse* item or +#. click **Extrusion Fuse** button in the toolbar + +.. image:: images/extrusion_fuse_btn.png + :align: center + +.. centered:: + **Extrusion Fuse** button + +The following property panel will be opened: .. image:: images/StartSketch.png :align: center @@ -9,16 +23,95 @@ Extrusion fuse .. centered:: Start sketch +After selecting one of the options property panel for Extrusion Fuse will be opened with two variants: + +.. image:: images/extrusion_by_sizes.png + :align: left +**By Sizes** extrudes objects by specifying sizes. + +.. image:: images/extrusion_by_bounding_planes.png + :align: left +**By Bounding Planes** extrudes objects by specifying bounding planes and offsets. + + +By sizes +-------- .. image:: images/ExtrusionFuse1.png :align: center .. centered:: - Extrusion: definition by sizes + Extrusion Fuse: definition by sizes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used. +- **To size** size for extrusion along direction. +- **From size** size for extrusion in opposite direction. +- **Fuse with** contains a list of objects which will but fused with the result of extrusion. + +**TUI Command**: *model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse);* + +**Arguments**: Part + list of objects for extrusion + size + list of objects to fuse with. + +**TUI Command**: *model.addExtrusionFuse(part, objects, direction, size, objectsToFuse);* + +**Arguments**: Part + list of objects for extrusion + direction + size + list of objects to fuse with. + +**TUI Command**: *model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse);* + +**Arguments**: Part + list of objects for extrusion + to size + from size + list of objects to fuse with. + +**TUI Command**: *model.addExtrusionFuse(part, objects, direction, toSize, fromSize, objectsToFuse);* + +**Arguments**: Part + list of objects for extrusion + direction + to size + from size + list of objects to fuse with. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_fuse_by_sizes_result.png + :align: center + +.. centered:: + **Extrusion Fuse created** + +**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_fuse_by_sizes` operation. +By bounding planes +------------------ .. image:: images/ExtrusionFuse2.png :align: center .. centered:: - Extrusion: definition by bounding planes + Extrusion Fuse: definition by bounding planes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded. +- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used. +- **To plane** planar face can be selected to bound extrusion from one side. +- **To offset** offset for extrusion or for bounding plane if selected. +- **From plane** planar face can be selected to bound extrusion from other side. +- **From offset** offset for extrusion or for bounding plane if selected. +- **Fuse with** contains a list of objects which will but fused with the result of extrusion. + +**TUI Command**: *model.addExtrusionFuse(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToFuse);* + +**Arguments**: Part + list of objects for extrusion + to object + to offset + from object + from offset + list of objects to fuse with. + +**TUI Command**: *model.addExtrusionFuse(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToFuse);* + +**Arguments**: Part + list of objects for extrusion + direction + to object + to offset + from object + from offset + list of objects to fuse with. + +Result +"""""" + +The Result of the operation will be an extruded shape: + +.. image:: images/extrusion_fuse_by_bounding_planes_result.png + :align: center + +.. centered:: + **Extrusion Fuse created** + +**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_fuse_by_bounding_planes` operation. diff --git a/src/FeaturesPlugin/doc/fillFeature.rst b/src/FeaturesPlugin/doc/fillFeature.rst index 40d16ad6d..81504a80a 100644 --- a/src/FeaturesPlugin/doc/fillFeature.rst +++ b/src/FeaturesPlugin/doc/fillFeature.rst @@ -4,7 +4,7 @@ Fill The feature Fill implements a boolean operation for filling of main objects by parts of tool objects. -To perform a boolean opration Fill in the active part: +To perform a boolean operation Fill in the active part: #. select in the Main Menu *Features - > Fill* item or #. click **Fill** button in the toolbar diff --git a/src/FeaturesPlugin/doc/images/CreatedFill.png b/src/FeaturesPlugin/doc/images/CreatedFill.png index 68b7ac2de..7d8b28faa 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedFill.png and b/src/FeaturesPlugin/doc/images/CreatedFill.png differ diff --git a/src/FeaturesPlugin/doc/images/CreatedUnion.png b/src/FeaturesPlugin/doc/images/CreatedUnion.png index 2df9dba24..500465ec5 100644 Binary files a/src/FeaturesPlugin/doc/images/CreatedUnion.png and b/src/FeaturesPlugin/doc/images/CreatedUnion.png differ diff --git a/src/FeaturesPlugin/doc/images/Fill.png b/src/FeaturesPlugin/doc/images/Fill.png index c5e11d29e..e5c4cd41e 100644 Binary files a/src/FeaturesPlugin/doc/images/Fill.png and b/src/FeaturesPlugin/doc/images/Fill.png differ diff --git a/src/FeaturesPlugin/doc/images/StartSketch.png b/src/FeaturesPlugin/doc/images/StartSketch.png index 20245cf91..ec4ed7ed9 100644 Binary files a/src/FeaturesPlugin/doc/images/StartSketch.png and b/src/FeaturesPlugin/doc/images/StartSketch.png differ diff --git a/src/FeaturesPlugin/doc/images/Union.png b/src/FeaturesPlugin/doc/images/Union.png index 50b90188b..04072bb3b 100644 Binary files a/src/FeaturesPlugin/doc/images/Union.png and b/src/FeaturesPlugin/doc/images/Union.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_by_bounding_planes_result.png b/src/FeaturesPlugin/doc/images/extrusion_by_bounding_planes_result.png new file mode 100644 index 000000000..c0471ea23 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_by_bounding_planes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_by_sizes_result.png b/src/FeaturesPlugin/doc/images/extrusion_by_sizes_result.png new file mode 100644 index 000000000..4773d0ce8 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_by_sizes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_cut_btn.png b/src/FeaturesPlugin/doc/images/extrusion_cut_btn.png new file mode 100644 index 000000000..77ba5b3a4 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_cut_btn.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_cut_by_bounding_planes_result.png b/src/FeaturesPlugin/doc/images/extrusion_cut_by_bounding_planes_result.png new file mode 100644 index 000000000..99c1b8d37 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_cut_by_bounding_planes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_cut_by_sizes_result.png b/src/FeaturesPlugin/doc/images/extrusion_cut_by_sizes_result.png new file mode 100644 index 000000000..3b9bb74cc Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_cut_by_sizes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_fuse_btn.png b/src/FeaturesPlugin/doc/images/extrusion_fuse_btn.png new file mode 100644 index 000000000..0914eb7dc Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_fuse_btn.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_fuse_by_bounding_planes_result.png b/src/FeaturesPlugin/doc/images/extrusion_fuse_by_bounding_planes_result.png new file mode 100644 index 000000000..1a17f1009 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_fuse_by_bounding_planes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_fuse_by_sizes_result.png b/src/FeaturesPlugin/doc/images/extrusion_fuse_by_sizes_result.png new file mode 100644 index 000000000..5de52bb18 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/extrusion_fuse_by_sizes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/extrusion_result.png b/src/FeaturesPlugin/doc/images/extrusion_result.png deleted file mode 100644 index 4773d0ce8..000000000 Binary files a/src/FeaturesPlugin/doc/images/extrusion_result.png and /dev/null differ diff --git a/src/FeaturesPlugin/doc/images/keep_subshapes_32x32.png b/src/FeaturesPlugin/doc/images/keep_subshapes_32x32.png new file mode 100644 index 000000000..45319ebe6 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/keep_subshapes_32x32.png differ diff --git a/src/FeaturesPlugin/doc/images/remove_subshapes_32x32.png b/src/FeaturesPlugin/doc/images/remove_subshapes_32x32.png new file mode 100644 index 000000000..094f6d47f Binary files /dev/null and b/src/FeaturesPlugin/doc/images/remove_subshapes_32x32.png differ diff --git a/src/FeaturesPlugin/doc/images/remove_subshapes_btn.png b/src/FeaturesPlugin/doc/images/remove_subshapes_btn.png new file mode 100644 index 000000000..98d7a8ce8 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/remove_subshapes_btn.png differ diff --git a/src/FeaturesPlugin/doc/images/remove_subshapes_result.png b/src/FeaturesPlugin/doc/images/remove_subshapes_result.png new file mode 100644 index 000000000..a38607d2f Binary files /dev/null and b/src/FeaturesPlugin/doc/images/remove_subshapes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_btn.png b/src/FeaturesPlugin/doc/images/revolution_btn.png new file mode 100644 index 000000000..f475b2a6b Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_btn.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_by_angles.png b/src/FeaturesPlugin/doc/images/revolution_by_angles.png new file mode 100644 index 000000000..25cb0e556 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_by_angles.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_by_angles_result.png b/src/FeaturesPlugin/doc/images/revolution_by_angles_result.png new file mode 100644 index 000000000..1975a1dec Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_by_angles_result.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_by_bounding_planes.png b/src/FeaturesPlugin/doc/images/revolution_by_bounding_planes.png new file mode 100644 index 000000000..49f81f8e9 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_by_bounding_planes.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_by_bounding_planes_result.png b/src/FeaturesPlugin/doc/images/revolution_by_bounding_planes_result.png new file mode 100644 index 000000000..090fc74da Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_by_bounding_planes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_cut_btn.png b/src/FeaturesPlugin/doc/images/revolution_cut_btn.png new file mode 100644 index 000000000..2a5dfe1e6 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_cut_btn.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_cut_by_angles_result.png b/src/FeaturesPlugin/doc/images/revolution_cut_by_angles_result.png new file mode 100644 index 000000000..690572198 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_cut_by_angles_result.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_cut_by_bounding_planes_result.png b/src/FeaturesPlugin/doc/images/revolution_cut_by_bounding_planes_result.png new file mode 100644 index 000000000..690572198 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_cut_by_bounding_planes_result.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_fuse_btn.png b/src/FeaturesPlugin/doc/images/revolution_fuse_btn.png new file mode 100644 index 000000000..147b045fa Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_fuse_btn.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_fuse_by_angles_result.png b/src/FeaturesPlugin/doc/images/revolution_fuse_by_angles_result.png new file mode 100644 index 000000000..a41d77885 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_fuse_by_angles_result.png differ diff --git a/src/FeaturesPlugin/doc/images/revolution_fuse_by_bounding_planes_result.png b/src/FeaturesPlugin/doc/images/revolution_fuse_by_bounding_planes_result.png new file mode 100644 index 000000000..b7b304dd6 Binary files /dev/null and b/src/FeaturesPlugin/doc/images/revolution_fuse_by_bounding_planes_result.png differ diff --git a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst index a8f1d440d..c1fe7f950 100644 --- a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst +++ b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst @@ -1,10 +1,67 @@ -Remove sub-shapes +Remove Sub-Shapes ================= +Remove Sub-Shapes allows to remove sub shapes from wires, shells, compsolids, compounds. + +To perform Remove Sub-Shapes in the active part: + +#. select in the Main Menu *Features - > Remove Sub-Shapes* item or +#. click **Remove Sub-Shapes** button in the toolbar + +.. image:: images/remove_subshapes_btn.png + :align: center + +.. centered:: + **Remove Sub-Shapes** button + +The following property panel will be opened: .. image:: images/RemoveSubShapes.png :align: center .. centered:: - Remove sub-shapes + Remove Sub-Shapes + +- **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids, compounds allowed for selection. + +There are 2 options for removing sub-shapes: + +.. image:: images/remove_subshapes_32x32.png + :align: left +**By removing** allows to select which sub-shapes will be removed. + +- **Sub-Shapes to remove** list of sub-shapes which should be removed. + +**TUI Command**: + | *Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, object)* + | *Remove_SubShapes_1.setSubShapesToRemove(subShapes)* + +**Arguments**: Part + object; List of sub-shapes to remove. + + +.. image:: images/keep_subshapes_32x32.png + :align: left +**By keeping** allows to select which sub-shapes will be kept. + +- **Sub-Shapes to keep** list of sub-shapes which should be kept. + +**TUI Command**: + | *Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, object)* + | *Remove_SubShapes_1.setSubShapesToKeep(subShapes)* + +**Arguments**: Part + object; List of sub-shapes to keep. + + +Result +"""""" + +The Result of the operation will be a shape without removed sub-shapes: + +.. image:: images/remove_subshapes_result.png + :align: center + +.. centered:: + **Remove Sub-Shapes created** + +**See Also** a sample TUI Script of a :ref:`tui_create_remove_subshapes` operation. diff --git a/src/FeaturesPlugin/doc/revolutionCutFeature.rst b/src/FeaturesPlugin/doc/revolutionCutFeature.rst index ac60837f2..bc5d5f78b 100644 --- a/src/FeaturesPlugin/doc/revolutionCutFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionCutFeature.rst @@ -1,7 +1,21 @@ -Revolution cut +Revolution Cut ============== +Revolution Cut feature revolves selected objects around selected axis and cuts result from other objects. + +To perform Revolution Cut in the active part: + +#. select in the Main Menu *Features - > Revolution Cut* item or +#. click **Revolution Cut** button in the toolbar + +.. image:: images/revolution_cut_btn.png + :align: center + +.. centered:: + **Revolution Cut** button + +The following property panel will be opened: .. image:: images/StartSketch.png :align: center @@ -9,16 +23,83 @@ Revolution cut .. centered:: Start sketch +After selecting one of the options property panel for Revolution Cut will be opened with two variants: + +.. image:: images/revolution_by_angles.png + :align: left +**By Angles** revolves objects by specifying angles. + +.. image:: images/revolution_by_bounding_planes.png + :align: left +**By Bounding Planes** revolves objects by specifying bounding planes and angles. + + +By angles +-------- .. image:: images/RevolutionCut1.png :align: center .. centered:: - Revolution: definition by angles + Revolution Cut: definition by angles + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved. +- **Axis** axis of revolution. +- **To angle** end angle of revolution. +- **From angle** start angle of revolution. +- **Cut from** contains a list of objects which will but cut with the result of revolution. + +**TUI Command**: *model.addRevolutionCut(part, objectsToRevolve, axis, angle, objectToCut);* + +**Arguments**: Part + list of objects for revolution + axis + angle + list of objects to cut from. + +**TUI Command**: *model.addRevolutionCut(part, objectsToRevolve, axis, toAngle, fromAngle, objectToCut);* + +**Arguments**: Part + list of objects for revolution + axis + to angle + from angle + list of objects to cut from. + +Result +"""""" + +The Result of the operation will be an revolved shape: + +.. image:: images/revolution_cut_by_angles_result.png + :align: center + +.. centered:: + **Revolution Cut created** + +**See Also** a sample TUI Script of a :ref:`tui_create_revolution_cut_by_angles` operation. +By bounding planes +------------------ .. image:: images/RevolutionCut2.png :align: center .. centered:: - Extrusion: definition by bounding planes + Revolution Cut: definition by bounding planes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved. +- **Axis** axis of revolution. +- **To plane** planar face can be selected to bound revolution from one side. +- **To offset** offset for revolution or for bounding plane if selected. +- **From plane** planar face can be selected to bound revolution from other side. +- **From offset** offset for revolution or for bounding plane if selected. +- **Cut from** contains a list of objects which will but cut with the result of revolution. + +**TUI Command**: *model.addRevolutionCut(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToCut);* + +**Arguments**: Part + list of objects for revolution + axis + to object + to offset + from object + from offset + list of objects to cut from. + +Result +"""""" + +The Result of the operation will be an revolved shape: + +.. image:: images/revolution_cut_by_bounding_planes_result.png + :align: center + +.. centered:: + **Revolution Cut created** + +**See Also** a sample TUI Script of a :ref:`tui_create_revolution_cut_by_bounding_planes` operation. \ No newline at end of file diff --git a/src/FeaturesPlugin/doc/revolutionFeature.rst b/src/FeaturesPlugin/doc/revolutionFeature.rst index ca419aa14..775c46b20 100644 --- a/src/FeaturesPlugin/doc/revolutionFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFeature.rst @@ -1,8 +1,21 @@ -.. _featureRevolution: Revolution ========== +Revolution feature revolves selected objects around selected axis. + +To perform Revolution in the active part: + +#. select in the Main Menu *Features - > Revolution* item or +#. click **Revolution** button in the toolbar + +.. image:: images/revolution_btn.png + :align: center + +.. centered:: + **Revolution** button + +The following property panel will be opened: .. image:: images/StartSketch.png :align: center @@ -10,6 +23,19 @@ Revolution .. centered:: Start sketch +After selecting one of the options property panel for Revolution will be opened with two variants: + +.. image:: images/revolution_by_angles.png + :align: left +**By Angles** revolves objects by specifying angles. + +.. image:: images/revolution_by_bounding_planes.png + :align: left +**By Bounding Planes** revolves objects by specifying bounding planes and angles. + + +By angles +-------- .. image:: images/Revolution1.png :align: center @@ -17,9 +43,61 @@ Revolution .. centered:: Revolution: definition by angles +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved. +- **Axis** axis of revolution. +- **To angle** end angle of revolution. +- **From angle** start angle of revolution. + +**TUI Command**: *model.addRevolution(part, objects, axis, angle);* + +**Arguments**: Part + list of objects + axis + angle. + +**TUI Command**: *model.addRevolution(part, objects, axis, toSize, fromSize);* + +**Arguments**: Part + list of objects + axis + to angle + from angle. + +Result +"""""" + +The Result of the operation will be an revolved shape: + +.. image:: images/revolution_by_angles_result.png + :align: center + +.. centered:: + **Revolution created** + +**See Also** a sample TUI Script of a :ref:`tui_create_revolution_by_angles` operation. + +By bounding planes +------------------ .. image:: images/Revolution2.png :align: center .. centered:: - Extrusion: definition by bounding planes + Revolution: definition by bounding planes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved. +- **Axis** axis of revolution. +- **To plane** planar face can be selected to bound revolution from one side. +- **To offset** offset for revolution or for bounding plane if selected. +- **From plane** planar face can be selected to bound revolution from other side. +- **From offset** offset for revolution or for bounding plane if selected. + +**TUI Command**: *model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset);* + +**Arguments**: Part + list of objects + axis + to object + to offset + from object + from offset. + +Result +"""""" + +The Result of the operation will be an revolved shape: + +.. image:: images/revolution_by_bounding_planes_result.png + :align: center + +.. centered:: + **Revolution created** + +**See Also** a sample TUI Script of a :ref:`tui_create_revolution_by_bounding_planes` operation. \ No newline at end of file diff --git a/src/FeaturesPlugin/doc/revolutionFuseFeature.rst b/src/FeaturesPlugin/doc/revolutionFuseFeature.rst index 77e77eb84..b78b1d2e4 100644 --- a/src/FeaturesPlugin/doc/revolutionFuseFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFuseFeature.rst @@ -1,7 +1,21 @@ -Revolution fuse +Revolution Fuse =============== +Revolution Fuse feature revolves selected objects around selected axis and fuses result from other objects. + +To perform Revolution Fuse in the active part: + +#. select in the Main Menu *Features - > Revolution Fuse* item or +#. click **Revolution Fuse** button in the toolbar + +.. image:: images/revolution_fuse_btn.png + :align: center + +.. centered:: + **Revolution Fuse** button + +The following property panel will be opened: .. image:: images/StartSketch.png :align: center @@ -9,16 +23,83 @@ Revolution fuse .. centered:: Start sketch +After selecting one of the options property panel for Revolution Fuse will be opened with two variants: + +.. image:: images/revolution_by_angles.png + :align: left +**By Angles** revolves objects by specifying angles. + +.. image:: images/revolution_by_bounding_planes.png + :align: left +**By Bounding Planes** revolves objects by specifying bounding planes and angles. + + +By angles +-------- .. image:: images/RevolutionFuse1.png :align: center .. centered:: - Revolution: definition by angles + Revolution Fuse: definition by angles + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved. +- **Axis** axis of revolution. +- **To angle** end angle of revolution. +- **From angle** start angle of revolution. +- **Fuse with** contains a list of objects which will but fuse with the result of revolution. + +**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse);* + +**Arguments**: Part + list of objects for revolution + axis + angle + list of objects to fuse with. + +**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse);* + +**Arguments**: Part + list of objects for revolution + axis + to angle + from angle + list of objects to fuse with. + +Result +"""""" + +The Result of the operation will be an revolved shape: + +.. image:: images/revolution_fuse_by_angles_result.png + :align: center + +.. centered:: + **Revolution Fuse created** + +**See Also** a sample TUI Script of a :ref:`tui_create_revolution_fuse_by_angles` operation. +By bounding planes +------------------ .. image:: images/RevolutionFuse2.png :align: center .. centered:: - Extrusion: definition by bounding planes + Revolution Fuse: definition by bounding planes + +- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved. +- **Axis** axis of revolution. +- **To plane** planar face can be selected to bound revolution from one side. +- **To offset** offset for revolution or for bounding plane if selected. +- **From plane** planar face can be selected to bound revolution from other side. +- **From offset** offset for revolution or for bounding plane if selected. +- **Fuse with** contains a list of objects which will but fuse with the result of revolution. + +**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToFuse);* + +**Arguments**: Part + list of objects for revolution + axis + to object + to offset + from object + from offset + list of objects to fuse with. + +Result +"""""" + +The Result of the operation will be an revolved shape: + +.. image:: images/revolution_fuse_by_bounding_planes_result.png + :align: center + +.. centered:: + **Revolution Fuse created** + +**See Also** a sample TUI Script of a :ref:`tui_create_revolution_fuse_by_bounding_planes` operation. \ No newline at end of file diff --git a/src/FeaturesPlugin/doc/unionFeature.rst b/src/FeaturesPlugin/doc/unionFeature.rst index a311dac32..efb06394c 100644 --- a/src/FeaturesPlugin/doc/unionFeature.rst +++ b/src/FeaturesPlugin/doc/unionFeature.rst @@ -2,9 +2,9 @@ Union ===== -The feature Union implements a boolean operation for creation of a uniono of selected objects. +The feature Union implements a boolean operation for creation of a union of selected objects. -To a create boolean opration Union in the active part: +To a create boolean operation Union in the active part: #. select in the Main Menu *Features - > Union* item or #. click **Union** button in the toolbar @@ -23,7 +23,7 @@ The following property panel will be opened: .. centered:: **Union operation** -Here it is necessary to select some objects. +Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection. **Apply** button creates the union shape.