From: vsv Date: Fri, 12 Jul 2019 14:49:12 +0000 (+0300) Subject: Ameliorate help pages X-Git-Tag: VEDF2019Lot4~99 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=0fcd69345a4dfdb31e252574c68bc70e123999e8;p=modules%2Fshaper.git Ameliorate help pages --- diff --git a/src/BuildPlugin/doc/compoundFeature.rst b/src/BuildPlugin/doc/compoundFeature.rst index 0094e042a..16cb65d86 100644 --- a/src/BuildPlugin/doc/compoundFeature.rst +++ b/src/BuildPlugin/doc/compoundFeature.rst @@ -1,3 +1,4 @@ +.. |feature_compound.icon| image:: images/feature_compound.png Compound ======== @@ -7,13 +8,7 @@ Compound feature creates a compound using shapes already existing in other objec To create a compound in the active part: #. select in the Main Menu *Build - > Compound* item or -#. click **Compound** button in the toolbar - -.. image:: images/feature_compound.png - :align: center - -.. centered:: - **Compound** button +#. click |feature_compound.icon| **Compound** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Select one or several shapes in the viewer. The selected shapes can be of any ty **Cancel** button cancels the operation. -**TUI Command**: *model.addCompound(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addCompound(Part_doc, Shapes) -**Arguments**: Part document + a list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/compsolidFeature.rst b/src/BuildPlugin/doc/compsolidFeature.rst index d33fb9c21..ae81ffd03 100644 --- a/src/BuildPlugin/doc/compsolidFeature.rst +++ b/src/BuildPlugin/doc/compsolidFeature.rst @@ -1,3 +1,4 @@ +.. |feature_compsolid.icon| image:: images/feature_compsolid.png CompSolid ========= @@ -7,13 +8,7 @@ Compsolid feature creates a compsolid using shapes already existing in other obj To create a compsolid in the active part: #. select in the Main Menu *Build - > CompSolid* item or -#. click **CompSolid** button in the toolbar - -.. image:: images/feature_compsolid.png - :align: center - -.. centered:: - **CompSolid** button +#. click |feature_compsolid.icon| **CompSolid** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Select one or several shapes in the viewer. **Cancel** button cancels the operation. -**TUI Command**: *model.addCompSolid(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addCompSolid(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/edgeFeature.rst b/src/BuildPlugin/doc/edgeFeature.rst index 468d2e639..a94a22020 100644 --- a/src/BuildPlugin/doc/edgeFeature.rst +++ b/src/BuildPlugin/doc/edgeFeature.rst @@ -1,3 +1,4 @@ +.. |feature_edge.icon| image:: images/feature_edge.png Edge ==== @@ -7,13 +8,7 @@ Edge feature creates one or several edges using shapes already existing in other To create edges in the active part: #. select in the Main Menu *Build - > Edge* item or -#. click **Edge** button in the toolbar - -.. image:: images/feature_edge.png - :align: center - -.. centered:: - **Edge** button +#. click |feature_edge.icon| **Edge** button in the toolbar The options to create edges: @@ -41,9 +36,13 @@ Select one or several edges in the viewer. **Cancel** button cancels the operation. -**TUI Command**: *model.addEdge(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addEdge(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" @@ -74,9 +73,14 @@ Select two points in the viewer. **Cancel** button cancels the operation. -**TUI Command**: *model.addEdge(Part_doc, Point_1, Point_2)* +**TUI Command**: + +.. py:function:: model.addEdge(Part_doc, Point_1, Point_2) -**Arguments**: Part document + two points/vertices. + :param part: The current part object. + :param object: First point. + :param object: Second point. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/faceFeature.rst b/src/BuildPlugin/doc/faceFeature.rst index aee91f3a1..57f70a2c1 100644 --- a/src/BuildPlugin/doc/faceFeature.rst +++ b/src/BuildPlugin/doc/faceFeature.rst @@ -1,4 +1,5 @@ .. _buildFace: +.. |feature_face.icon| image:: images/feature_face.png Face ==== @@ -8,13 +9,7 @@ Face feature creates one or several faces using shapes already existing in other To create a face in the active part: #. select in the Main Menu *Build - > Face* item or -#. click **Face** button in the toolbar - -.. image:: images/feature_face.png - :align: center - -.. centered:: - **Face** button +#. click |feature_face.icon| **Face** button in the toolbar The following property panel will be opened: @@ -30,9 +25,13 @@ Select one or several faces in viewer. Additionally, a face can be build by a cl **Cancel** button cancels the operation. -**TUI Command**: *model.addFace(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addFace(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/fillingFeature.rst b/src/BuildPlugin/doc/fillingFeature.rst index da0b5ca24..7e0111cf7 100644 --- a/src/BuildPlugin/doc/fillingFeature.rst +++ b/src/BuildPlugin/doc/fillingFeature.rst @@ -1,3 +1,4 @@ +.. |feature_filling.icon| image:: images/feature_filling.png Filling ======= @@ -7,13 +8,7 @@ Filling feature creates one or several faces using shapes already existing in ot To create a filling in the active part: #. select in the Main Menu *Build - > Filling* item or -#. click **Filling** button in the toolbar - -.. image:: images/feature_filling.png - :align: center - -.. centered:: - **Filling** button +#. click |feature_filling.icon| **Filling** button in the toolbar The following property panel will be opened: @@ -31,9 +26,13 @@ Select two or more edges in the viewer. **Cancel** button cancels the operation. -**TUI Command**: *model.addFilling(Part_doc, Edges)* +**TUI Command**: + +.. py:function:: model.addFilling(Part_doc, Edges) -**Arguments**: Part document + list of edges. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/interpolationFeature.rst b/src/BuildPlugin/doc/interpolationFeature.rst index 2ab98ea60..6a7e28bab 100644 --- a/src/BuildPlugin/doc/interpolationFeature.rst +++ b/src/BuildPlugin/doc/interpolationFeature.rst @@ -1,3 +1,4 @@ +.. |feature_interpolation.icon| image:: images/feature_interpolation.png Interpolation ============= @@ -7,13 +8,7 @@ Interpolation feature creates a curve (edge) using vertices already existing in To create an interpolation in the active part: #. select in the Main Menu *Build - > Interpolation* item or -#. click **Interpolation** button in the toolbar - -.. image:: images/feature_interpolation.png - :align: center - -.. centered:: - **Interpolation** button +#. click |feature_interpolation.icon| **Interpolation** button in the toolbar The following property panel will be opened: @@ -35,15 +30,25 @@ Select one or several vertices or points in the viewer. **Cancel** button cancels the operation. -**TUI Command**: +**TUI Commands**: -- *model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)*. +.. py:function:: model.addInterpolation(Part_doc, Points, IsClosed, IsReordered) -**Arguments**: Part document + list of points + is closed + is reordered. + :param part: The current part object. + :param list: A list of points. + :param boolean: Is closed. + :param boolean: Is reordered. + :return: Result object. -- *model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)*. +.. py:function:: model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered) -**Arguments**: Part document + list of points + start edge + end edge + is closed + is reordered. + :param part: The current part object. + :param list: A list of points. + :param object: Start point. + :param object: End point. + :param boolean: Is closed. + :param boolean: Is reordered. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/polylineFeature.rst b/src/BuildPlugin/doc/polylineFeature.rst index 6df40143d..c6e71fb29 100644 --- a/src/BuildPlugin/doc/polylineFeature.rst +++ b/src/BuildPlugin/doc/polylineFeature.rst @@ -1,4 +1,5 @@ .. _buildPolyline: +.. |feature_polyline.icon| image:: images/feature_polyline.png Polyline ======== @@ -8,13 +9,7 @@ Polyline feature creates a wire. To create a Polyline in the active part: #. select in the Main Menu *Build - > Polyline* item or -#. click **Polyline** button in the toolbar - -.. image:: images/feature_polyline.png - :align: center - -.. centered:: - **Polyline** button +#. click |feature_polyline.icon| **Polyline** button in the toolbar The following property panel appears. @@ -29,9 +24,14 @@ Input fields: - **Points and vertices** panel contains a list of points and vertices selected in 3D OCC viewer. The Polyline consequently connects points; - **Closed** check-box turns on/off connection of the start and end points to make polyline closed/opened. -**TUI Commands**: *model.addPolyline3D(Part_1_doc, Polyline_objects, Key)* +**TUI Commands**: + +.. py:function:: model.addPolyline3D(Part_1_doc, Polyline_objects, Key) -**Arguments**: 1 part+ list of vertices selected in format *model.selection("VERTEX", "Point")* + Boolean key defining connection between the start and end points. + :param part: The current part object. + :param list: list of vertices selected in format *model.selection("VERTEX", "Point")*. + :param boolean: Is closed. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/shellFeature.rst b/src/BuildPlugin/doc/shellFeature.rst index 9317f0638..cc576b676 100644 --- a/src/BuildPlugin/doc/shellFeature.rst +++ b/src/BuildPlugin/doc/shellFeature.rst @@ -1,3 +1,4 @@ +.. |feature_shell.icon| image:: images/feature_shell.png Shell ===== @@ -7,13 +8,7 @@ Shell feature creates a shell using faces already existing in other objects. To create a shell in the active part: #. select in the Main Menu *Build - > Shell* item or -#. click **Shell** button in the toolbar - -.. image:: images/feature_shell.png - :align: center - -.. centered:: - **Shell** button +#. click |feature_shell.icon| **Shell** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Select one or several faces in the viewer. **Cancel** button cancels the operation. -**TUI Command**: *model.addShell(Part_doc, Objects)* +**TUI Command**: + +.. py:function:: model.addShell(Part_doc, Objects) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/solidFeature.rst b/src/BuildPlugin/doc/solidFeature.rst index 7af0590f7..e374577be 100644 --- a/src/BuildPlugin/doc/solidFeature.rst +++ b/src/BuildPlugin/doc/solidFeature.rst @@ -1,3 +1,4 @@ +.. |feature_solid.icon| image:: images/feature_solid.png Solid ===== @@ -7,13 +8,7 @@ Solid feature creates a solid using faces already existing in other objects. To create a solid in the active part: #. select in the Main Menu *Build - > Solid* item or -#. click **Solid** button in the toolbar - -.. image:: images/feature_solid.png - :align: center - -.. centered:: - **Solid** button +#. click |feature_solid.icon| **Solid** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Select one or several faces in the viewer. The selected faces have to define a c **Cancel** button cancels the operation. -**TUI Command**: *model.addSolid(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addSolid(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/subShapesFeature.rst b/src/BuildPlugin/doc/subShapesFeature.rst index d1b767232..276245b47 100644 --- a/src/BuildPlugin/doc/subShapesFeature.rst +++ b/src/BuildPlugin/doc/subShapesFeature.rst @@ -1,3 +1,4 @@ +.. |feature_subshapes.icon| image:: images/feature_subshapes.png Sub-shapes ========== @@ -10,13 +11,7 @@ The feature **Sub-shapes** modifies the selected entity by creating a non-manifo To create Sub-shapes in the active part: #. select in the Main Menu *Build - > Sub-shapes* item or -#. click **Sub-shapes** button in the toolbar - -.. image:: images/feature_subshapes.png - :align: center - -.. centered:: - **Sub-shapes** button +#. click |feature_subshapes.icon| **Sub-shapes** button in the toolbar The following property panel appears. @@ -31,9 +26,14 @@ Input fields: - **Shape** panel contains the shape to be modified. The shape is selected in 3D OCC viewer or object browser. For today it has to be a wire or a face; - **Sub-shapes** panel contains the list of sub-shapes which are already included into result. A sub-shape can be deleted from the list or the list can be extended with new shapes selected in the view. -**TUI Command**: *model.addSubShapes(Part_doc, shape, sub-shapes)* +**TUI Command**: + +.. py:function:: model.addSubShapes(Part_doc, shape, sub-shapes) -**Arguments**: 1 part + shape in format *model.selection(TYPE, shape)* + list of sub-shapes in format *model.selection(TYPE, subshape)*. + :param part: The current part object. + :param object: A shape in format *model.selection(TYPE, shape)*. + :param list: A list of sub-shapes in format *model.selection(TYPE, subshape)*. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/vertexFeature.rst b/src/BuildPlugin/doc/vertexFeature.rst index d32b519cd..5b7b1f62b 100644 --- a/src/BuildPlugin/doc/vertexFeature.rst +++ b/src/BuildPlugin/doc/vertexFeature.rst @@ -1,3 +1,4 @@ +.. |feature_vertex.icon| image:: images/feature_vertex.png Vertex ====== @@ -7,13 +8,7 @@ Vertex feature creates one or several vertices using vertices already existing i To create vertices in the active part: #. select in the Main Menu *Build - > Vertex* item or -#. click **Vertex** button in the toolbar - -.. image:: images/feature_vertex.png - :align: center - -.. centered:: - **Vertex** button +#. click |feature_vertex.icon| **Vertex** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Select one or several vertices in the viewer. **Cancel** button cancels operation. -**TUI Command**: *model.addVertex(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addVertex(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/BuildPlugin/doc/wireFeature.rst b/src/BuildPlugin/doc/wireFeature.rst index 946fb0be2..32d03e58f 100644 --- a/src/BuildPlugin/doc/wireFeature.rst +++ b/src/BuildPlugin/doc/wireFeature.rst @@ -1,3 +1,4 @@ +.. |feature_wire.icon| image:: images/feature_wire.png Wire ==== @@ -7,13 +8,7 @@ Wire feature creates a wire using edges already existing in other objects. To create a wire in the active part: #. select in the Main Menu *Build - > Wire* item or -#. click **Wire** button in the toolbar - -.. image:: images/feature_wire.png - :align: center - -.. centered:: - **Wire** button +#. click |feature_wire.icon| **Wire** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Select one or several edges in the viewer. For automatic selection of a closed c **Cancel** button cancels the operation. -**TUI Command**: *model.addWire(Part_doc, Shapes)* +**TUI Command**: + +.. py:function:: model.addWire(Part_doc, Shapes) -**Arguments**: Part document + list of shapes. + :param part: The current part object. + :param list: A list of shapes. + :return: Result object. Result """""" diff --git a/src/CollectionPlugin/doc/fieldFeature.rst b/src/CollectionPlugin/doc/fieldFeature.rst index a3f8cdaeb..97c555ee4 100644 --- a/src/CollectionPlugin/doc/fieldFeature.rst +++ b/src/CollectionPlugin/doc/fieldFeature.rst @@ -1,3 +1,4 @@ +.. |field.icon| image:: images/field.png Field ===== @@ -11,13 +12,7 @@ The field can include several sets of data called steps, each dedicated to a cer To create a Field in the active part: #. select in the Main Menu *Features - > Field* item or -#. click **Field** button in Shaper toolbar: - -.. image:: images/field.png - :align: center - -.. centered:: - Field button +#. click |field.icon| **Field** button in the toolbar: The following property panel appears. @@ -59,12 +54,22 @@ Input fields: - **Remove Step** button deletes the current time step. -**TUI Command**: *model.addField(Part_1_doc, 2, "DOUBLE", 2, ["DX", "DY"], [model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Top")])* +**TUI Commands**: + +.. py:function:: model.addField(Part_1_doc, 2, "DOUBLE", 2, ["DX", "DY"], [model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Top")]) -**Arguments**: 1 part + integer (number of steps) + text (Type of field) + integer (number of components) + list of text (names of components) + list of objects + :param part: The current part object + :param integer: Number of steps + :param text: Type of the field + :param integer: Number of components + :param list: List of components names + :param list: List of objects + :return: the created field object -**TUI Command**: *Field_1.addStep(step, stamp, [[0.1, 0.2], [2.1, 1.7], [3.7, 1.95]])* +.. py:function:: Field_1.addStep(step, stamp, [[0.1, 0.2], [2.1, 1.7], [3.7, 1.95]]) -**Arguments**: 2 integers + list of lists of values with Type of field + :param integer: step id + :param integer: time stamp id + :param list: list of lists of values with Type of field **See Also** a sample TUI Script of :ref:`tui_create_field` operation. diff --git a/src/CollectionPlugin/doc/groupFeature.rst b/src/CollectionPlugin/doc/groupFeature.rst index 5b7923c7d..5944cdadc 100644 --- a/src/CollectionPlugin/doc/groupFeature.rst +++ b/src/CollectionPlugin/doc/groupFeature.rst @@ -1,3 +1,4 @@ +.. |shape_group.icon| image:: images/shape_group.png Group ===== @@ -6,13 +7,7 @@ A group is a set of geometrical entities created by selection of sub-shapes of t To create a Group in the active part: #. select in the Main Menu *Features - > Group* item or -#. click **Group** button in Shaper toolbar: - -.. image:: images/shape_group.png - :align: center - -.. centered:: - Group button +#. click |shape_group.icon| **Group** button in the toolbar: The following property panel appears. @@ -47,10 +42,13 @@ Input fields: - Control **Add elements that share the same topology** allows to add automatically all elements laying on the same topology that was selected and remove these elements if they have disappeared due to the parametrical update. They will be represented as one line in the list of selection and managed in the viewer as one object if this flag is enabled. If flag becomes disabled when such elements are already in the list, they will become divided in one line per one shape. -**TUI Command**: *model.addGroup(Part_1_doc, [model.selection("EDGE", "Cone_1_1/Face_1&Cone_1_1/Face_2"), model.selection("EDGE", "Cone_1_1/Face_1")])* +**TUI Command**: -**Arguments**: 1 part + list of selected entities with type +.. py:function:: model.addGroup(Part_1_doc, [model.selection("EDGE", "Cone_1_1/Face_1&Cone_1_1/Face_2"), model.selection("EDGE", "Cone_1_1/Face_1")]) + :param part: The current part object + :param list: A list of selected entities with type + :return: Created object. Result """""" diff --git a/src/ConnectorPlugin/doc/ConnectorPlugin.rst b/src/ConnectorPlugin/doc/ConnectorPlugin.rst index 68009ee06..aa775167f 100644 --- a/src/ConnectorPlugin/doc/ConnectorPlugin.rst +++ b/src/ConnectorPlugin/doc/ConnectorPlugin.rst @@ -1,3 +1,4 @@ +.. |geom_export.icon| image:: images/geom_export.png Connector plug-in ================= @@ -5,16 +6,12 @@ Connector plug-in Connector plug-in is used to export Results, Groups, Fields created in active part into GEOM module: #. select in the Main Menu *Feature - > Export to GEOM* item or -#. click **Export to GEOM** button in Shaper toolbar: +#. click |geom_export.icon| **Export to GEOM** button in Shaper toolbar: -.. image:: images/geom_export.png - :align: center +**TUI Command**: -.. centered:: - Export to GEOM button +.. py:function:: model.exportGEOM(part) -**TUI Command**: *model.exportGEOM(part)* - -**Arguments**: 1 part + :param part: The current part object The result can be checked in GEOM module. \ No newline at end of file diff --git a/src/ConstructionPlugin/doc/axisFeature.rst b/src/ConstructionPlugin/doc/axisFeature.rst index 611e9049e..bb691a508 100644 --- a/src/ConstructionPlugin/doc/axisFeature.rst +++ b/src/ConstructionPlugin/doc/axisFeature.rst @@ -1,3 +1,4 @@ +.. |axis_button.icon| image:: images/axis_button.png Axis ==== @@ -7,13 +8,7 @@ Axis feature creates a new constructive axis line. Axis is a construction object and it can be created in a part or in a partset. To create an axis: #. select in the Main Menu *Construction - > Axis* item or -#. click **Axis** button in the toolbar - -.. image:: images/axis_button.png - :align: center - -.. centered:: - **Axis** button +#. click |axis_button.icon| **Axis** button in the toolbar There are 6 algorithms for creation of an Axis: @@ -52,9 +47,15 @@ By three dimensions An axis is defined by dX, dY and dZ values of a vector. -**TUI Commands**: *model.addAxis(Part_doc, 10, 10, 10)* +**TUI Commands**: -**Arguments**: Part + 3 values (dX, dY, dZ values). +.. py:function:: model.addAxis(Part_doc, 10, 10, 10) + + :param part: The current part object. + :param real: dX. + :param real: dY. + :param real: dZ. + :return: Result object. Result """""" @@ -81,9 +82,14 @@ By two points An axis is defined by two points or vertices. -**TUI Commands**: *model.addAxis(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"))* +**TUI Commands**: + +.. py:function:: model.addAxis(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom")) -**Arguments**: Part + 2 vertices. + :param part: The current part object. + :param object: Vertex 1. + :param object: Vertex 2. + :return: Result object. **See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation. @@ -112,9 +118,13 @@ By line An axis is defined by a linear edge. -**TUI Commands**: *model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"))* +**TUI Commands**: -**Arguments**: Part + edge. +.. py:function:: model.addAxis(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top")) + + :param part: The current part object. + :param object: Edge. + :return: Result object. Result """""" @@ -141,9 +151,13 @@ As an axis of cylindrical face An axis is defined by a cylindrical face. Axis of the cylinder will be an axis object. -**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1"))* +**TUI Commands**: + +.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Cylinder_1_1/Face_1")) -**Arguments**: Part + cylindrical face. + :param part: The current part object. + :param object: Cylindrical face. + :return: Result object. Result """""" @@ -170,9 +184,14 @@ By plane and point An axis is defined by a point or vertex and plane (or planar face) as a normal from the point to the plane. -**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Front"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top"))* +**TUI Commands**: -**Arguments**: Part + plane + point. +.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Front"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top")) + + :param part: The current part object. + :param object: Plane. + :param object: Point. + :return: Result object. Result """""" @@ -199,9 +218,18 @@ By two planes An axis is defined by two planes. The intersection of the planes defines an axis. It is possible to define offset for axis definition from both planes. -**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)* +**TUI Commands**: + +.. py:function:: model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False) -**Arguments**: Part + plane + offset value + is reversed flag + plane + offset value + is reversed flag. + :param part: The current part object. + :param object: Plane 1. + :param real: Offset value. + :param boolean: Is reversed. + :param object: Plane 2. + :param real: Offset value. + :param boolean: Is reversed. + :return: Result object. Result """""" diff --git a/src/ConstructionPlugin/doc/planeFeature.rst b/src/ConstructionPlugin/doc/planeFeature.rst index bebbe9fd6..beff53731 100644 --- a/src/ConstructionPlugin/doc/planeFeature.rst +++ b/src/ConstructionPlugin/doc/planeFeature.rst @@ -1,3 +1,4 @@ +.. |plane_button.icon| image:: images/plane_button.png Plane ===== @@ -7,13 +8,7 @@ Plane feature creates a new constructive plane. Plane is a construction object that can be created in a part or in a partset. To create a plane: #. select in the Main Menu *Construction - > Plane* item or -#. click **Point** button in the toolbar - -.. image:: images/plane_button.png - :align: center - -.. centered:: - **Plane** button +#. click |plane_button.icon| **Point** button in the toolbar There are 4 algorithms for creation of a Plane: @@ -45,9 +40,15 @@ By three points A plane is created by selecting three points in a viewer. -**TUI Commands**: *model.addPlane(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"))* +**TUI Commands**: + +.. py:function:: model.addPlane(Part_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom")) -**Arguments**: Part + 3 vertices. + :param part: The current part object. + :param object: Vertex 1. + :param object: Vertex 2. + :param object: Vertex 3. + :return: Result object. Result """""" @@ -74,9 +75,15 @@ By line and point A plane is created by selecting a linear edge and point. It is possible to create a new plane perpendicular to the selected edge. -**TUI Commands**: *model.addPlane(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False)* +**TUI Commands**: -**Arguments**: Part + line + point + is perpendicular to line flag. +.. py:function:: model.addPlane(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False) + + :param part: The current part object. + :param object: A line. + :param object: A point. + :param boolean: Is perpendicular to line. + :return: Result object. Result """""" @@ -118,9 +125,15 @@ By coincidence with a point. By rotation around an edge by a specified angle. -**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)* +**TUI Commands**: + +.. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False) -**Arguments**: Part + a plane + offset + is reverse flag. + :param part: The current part object. + :param object: A plane. + :param real: An offset. + :param boolean: Is reverse. + :return: Result object. Result """""" @@ -147,9 +160,14 @@ By two parallel planes A plane is created by selecting two parallel planes. A new plane will be defined between them. -**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right"))* +**TUI Commands**: + +.. py:function:: model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Right")) -**Arguments**: Part + 2 planes. + :param part: The current part object. + :param object: A plane 1. + :param object: A plane 2. + :return: Result object. Result """""" diff --git a/src/ConstructionPlugin/doc/pointFeature.rst b/src/ConstructionPlugin/doc/pointFeature.rst index e2bc9d1ef..5aac2ec2b 100644 --- a/src/ConstructionPlugin/doc/pointFeature.rst +++ b/src/ConstructionPlugin/doc/pointFeature.rst @@ -1,4 +1,5 @@ .. _constructionPoint: +.. |point_button.icon| image:: images/point_button.png Point ===== @@ -8,13 +9,7 @@ Point feature creates a new construction point. Point is a construction object and it can be created in a part or in a partset. To create a point: #. select in the Main Menu *Construction - > Point* item or -#. click **Point** button in the toolbar - -.. image:: images/point_button.png - :align: center - -.. centered:: - **Point** button +#. click |point_button.icon| **Point** button in the toolbar There are 5 algorithms for creation of a Point: @@ -49,9 +44,15 @@ By X,Y,Z A point is created by X, Y, and Z coordinates. -**TUI Commands**: *model.addPoint(Part_doc, 50, 50, 50)* +**TUI Commands**: + +.. py:function:: model.addPoint(Part_doc, 50, 50, 50) -**Arguments**: Part + 3 values (X, Y, Z coordinates). + :param part: The current part object. + :param real: X value. + :param real: Y value. + :param real: Z value. + :return: Result object. Result """""" @@ -77,9 +78,16 @@ By distance on edge To create a point, select an edge in a viewer and define a distance along the edge, where point will be defined. This distance can be defined by an absolute value or by a relative one as a ratio to the edge length. The direction of the edge can be reversed by the corresponded check box. -**TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False)* +**TUI Commands**: -**Arguments**: Part + edge + value + is by ratio flag + to reverse flag. +.. py:function:: model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False) + + :param part: The current part object. + :param object: An edge. + :param real: A value. + :param boolean: Is by ratio. + :param boolean: Is reversed. + :return: Result object. Result """""" @@ -105,9 +113,14 @@ By projection on edge or plane To create a point, select an existing point or vertex and an edge or face. The new point will be created by projection of the selected point on the edge or face. -**TUI Commands**: *model.addPoint(Part_doc, model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Top"), model.selection("EDGE", "Box_1_1/Right&Box_1_1/Top"))* +**TUI Commands**: + +.. py:function:: model.addPoint(Part_doc, model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Top"), model.selection("EDGE", "Box_1_1/Right&Box_1_1/Top")) -**Arguments**: Part + vertex + edge (or plane). + :param part: The current part object. + :param object: A vertex. + :param object: An edge or plane. + :return: Result object. Result """""" @@ -139,9 +152,16 @@ To create a point, select: The new point will be defined by intersection of the selected objects. -**TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), model.selection("FACE", "Box_1_1/Left"), 10, False)* +**TUI Commands**: -**Arguments**: Part + edge + plane (planar face) + offset value + is offset reversed. +.. py:function:: model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), model.selection("FACE", "Box_1_1/Left"), 10, False) + + :param part: The current part object. + :param object: An edge. + :param object: A plane. + :param real: Offset. + :param boolean: Is offset reversed. + :return: Result object. Result """""" @@ -167,9 +187,13 @@ By geometrical property of object In this case the new point can be defined as a center of gravity of the selected object or as a center of a circle. To create a point, select the desirable object. -**TUI Commands**: *model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1"))* +**TUI Commands**: + +.. py:function:: model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1")) -**Arguments**: Part + solid + :param part: The current part object. + :param object: Solid. + :return: Result object. Result """""" diff --git a/src/ExchangePlugin/doc/dumpFeature.rst b/src/ExchangePlugin/doc/dumpFeature.rst index 0e391766b..53adb4ae7 100644 --- a/src/ExchangePlugin/doc/dumpFeature.rst +++ b/src/ExchangePlugin/doc/dumpFeature.rst @@ -1,3 +1,4 @@ +.. |dump.icon| image:: images/dump.png Dump ==== @@ -7,13 +8,7 @@ The Dump feature allows exporting a current study to a Python script which dumps It is possible to dump the current study state into a Python script. To dump a study: #. select in the Main Menu *Part - > Dump* item or -#. click **Dump** button in the toolbar. - -.. image:: images/dump.png - :align: center - -.. centered:: - **Dump** button +#. click |dump.icon| **Dump** button in the toolbar. The following property panel will be opened: diff --git a/src/ExchangePlugin/doc/exportFeature.rst b/src/ExchangePlugin/doc/exportFeature.rst index be697bd00..41c4c34cc 100644 --- a/src/ExchangePlugin/doc/exportFeature.rst +++ b/src/ExchangePlugin/doc/exportFeature.rst @@ -1,3 +1,4 @@ +.. |export.icon| image:: images/export.png Export ====== @@ -7,13 +8,7 @@ The export feature allows exporting objects from the current study to an extern It is possible to export objects to files in the following formats: BREP, STEP, IGES, XAO. To export objects to a file: #. select in the Main Menu *Part - > Export* item or -#. click **Export** button in the toolbar. - -.. image:: images/export.png - :align: center - -.. centered:: - **Export** button +#. click |export.icon| **Export** button in the toolbar. The following property panel will be opened: @@ -37,9 +32,13 @@ Selection list in the property panel contains a list of exported objects which c **Cancel** button cancels the operation. -**TUI Command**: *model.exportToFile(Part_doc, FileNameString, ObjectsList)* +**TUI Command**: + +.. py:function:: model.exportToFile(Part_doc, FileNameString, ObjectsList)* -**Arguments**: Part + file name string + list of objects. + :param part: The current part object + :param string: The file name + :param list: A list of exporting objects Result """""" diff --git a/src/ExchangePlugin/doc/importFeature.rst b/src/ExchangePlugin/doc/importFeature.rst index d5042d1ca..937562ca4 100644 --- a/src/ExchangePlugin/doc/importFeature.rst +++ b/src/ExchangePlugin/doc/importFeature.rst @@ -1,3 +1,4 @@ +.. |import.icon| image:: images/import.png Import ====== @@ -7,13 +8,7 @@ The Import feature allows importing an external file into a current study. It is possible to import files in the following formats: BREP, STEP, IGES, XAO. To import a file into active part: #. select in the Main Menu *Part - > Import* item or -#. click **Import** button in the toolbar. - -.. image:: images/import.png - :align: center - -.. centered:: - **Import** button +#. click |import.icon| **Import** button in the toolbar. The following property panel will be opened: @@ -35,9 +30,12 @@ In this panel it is possible to enter a file name directly or press **'...'** bu **Cancel** button cancels the operation. -**TUI Command**: *model.addImport(Part_doc, FileNameString)* +**TUI Command**: + +.. py:function:: model.addImport(Part_doc, FileNameString) -**Arguments**: Part + file name string. + :param part: The current part object + :param string: A file name string. Result """""" diff --git a/src/FeaturesPlugin/doc/angularCopyFeature.rst b/src/FeaturesPlugin/doc/angularCopyFeature.rst index 30b708628..3be46c132 100644 --- a/src/FeaturesPlugin/doc/angularCopyFeature.rst +++ b/src/FeaturesPlugin/doc/angularCopyFeature.rst @@ -1,4 +1,5 @@ .. _featureAngularCopy: +.. |multirotation.icon| image:: images/multirotation.png Angular copy ============ @@ -8,13 +9,7 @@ The feature **Angular copy** makes a compound of several rotated shapes basing o To create an Angular copy in the active part: #. select in the Main Menu *Part - > Angular copy* item or -#. click **Angular copy** button in the toolbar - -.. image:: images/multirotation.png - :align: center - -.. centered:: - **Angular copy** button +#. click |multirotation.icon| **Angular copy** button in the toolbar The following property panel appears. @@ -31,9 +26,16 @@ Input fields: - **Angular Step** check-box turns on/off definition of the angle by which the object is rotated. By default (if the checkbox is not checked), **Angular Step** = 2 * PI / NbTimes; - **Nb. Copies** defines the number of rotated shape copies in the resulting compound. If **Nb. Copies** = 1, the result contains only the initial shape. -**TUI Command**: *model.addMultiRotation(Part_doc, [shape], axis, step, Nb)* +**TUI Command**: + +.. py:function:: model.addMultiRotation(Part_doc, [shape], axis, step, Nb)* -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ real (step value) + integer (Nb. Copies). + :param part: The current part object + :param list: A list of shapes in format *model.selection(TYPE, shape)* + :param object: An axis in format *model.selection(TYPE, shape)* + :param real: a step value + :param integer: A number of copies + :return: Created object Result """""" diff --git a/src/FeaturesPlugin/doc/commonFeature.rst b/src/FeaturesPlugin/doc/commonFeature.rst index e5bf0c425..52aa644af 100644 --- a/src/FeaturesPlugin/doc/commonFeature.rst +++ b/src/FeaturesPlugin/doc/commonFeature.rst @@ -1,3 +1,5 @@ +.. |bool_common.icon| image:: images/bool_common.png + Common ====== @@ -6,13 +8,7 @@ Common feature implements a Boolean operation for extraction of a common part fr To perform a Common operation in the active part: #. select in the Main Menu *Features - > Common* item or -#. click **Common** button in the toolbar - -.. image:: images/bool_common.png - :align: center - -.. centered:: - **Common** button +#. click |bool_common.icon| **Common** button in the toolbar There are 2 options for creation of a Common: @@ -38,9 +34,13 @@ Simple If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored. - **See preview** button shows a result of the operation. -**TUI Command**: *model.addCommon(Part_doc, objects)* +**TUI Command**: + +.. py:function:: model.addCommon(Part_doc, objects) -**Arguments**: Part + list of objects. + :param part: The current part object + :param list: A list of objects. + :return: Created object Result """""" @@ -71,9 +71,14 @@ Advanced If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored. - **See preview** button shows a result of the operation. -**TUI Command**: *model.addCommon(Part_doc, objects, tools)* +**TUI Command**: + +.. py:function:: model.addCommon(Part_doc, objects, tools) -**Arguments**: Part + list of objects + list of tools. + :param part: The current part object + :param list: A list of objects. + :param list: A list of tools. + :return: Created object Result """""" diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst index 514924dad..9a9922406 100644 --- a/src/FeaturesPlugin/doc/cutFeature.rst +++ b/src/FeaturesPlugin/doc/cutFeature.rst @@ -1,4 +1,5 @@ .. _featureCut: +.. |bool_cut.icon| image:: images/bool_cut.png Cut === @@ -8,13 +9,7 @@ Cut feature implements a Boolean operation to cut tool objects from main objects To perform a Cut operationin the active part: #. select in the Main Menu *Features - > Cut* item or -#. click **Cut** button in the toolbar - -.. image:: images/bool_cut.png - :align: center - -.. centered:: - **Cut** button +#. click |bool_cut.icon| **Cut** button in the toolbar The following property panel will be opened: @@ -32,9 +27,14 @@ The following property panel will be opened: Non-selected subshapes from compsolids/compounds will be ignored. - **See preview** button shows a result of the operation. -**TUI Command**: *model.addCut(Part_doc, mainObjects, toolObjects)* +**TUI Command**: + +.. py:function:: model.addCut(Part_doc, mainObjects, toolObjects) -**Arguments**: Part + list of main objects + list of tool objects. + :param part: The current part object + :param list: A list of main objects. + :param list: A list of tool objects. + :return: Created object Result """""" diff --git a/src/FeaturesPlugin/doc/extrusionCutFeature.rst b/src/FeaturesPlugin/doc/extrusionCutFeature.rst index 344e0a0d9..ca3499c2c 100644 --- a/src/FeaturesPlugin/doc/extrusionCutFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionCutFeature.rst @@ -1,3 +1,4 @@ +.. |extrusion_cut_btn.icon| image:: images/extrusion_cut_btn.png Extrusion Cut ============= @@ -7,13 +8,7 @@ Extrusion Cut feature extrudes selected objects along their normals or selected 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 +#. click |extrusion_cut_btn.icon| **Extrusion Cut** button in the toolbar The following property panel will be opened: @@ -49,21 +44,43 @@ By sizes - **From size** - size for extrusion in the opposite direction. - **Cut from** - contains a list of objects which will be cut from the result of extrusion. -**TUI Command**: *model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut);* +**TUI Commands**: + +.. py:function:: model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut) -**Arguments**: Part + list of objects for extrusion + size + list of objects to cut from. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: Size of extrucion. + :param list: A list of objects to cut from. + :return: Created object. -**TUI Command**: *model.addExtrusionCut(part, objects, direction, size, objectsToCut);* +.. py:function:: model.addExtrusionCut(part, objects, direction, size, objectsToCut) -**Arguments**: Part + list of objects for extrusion + direction + size + list of objects to cut from. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: Size of extrucion. + :param list: A list of objects to cut from. + :return: Created object. -**TUI Command**: *model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut);* +.. py:function:: model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut) -**Arguments**: Part + list of objects for extrusion + to size + from size + list of objects to cut from. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: "Size to" value. + :param number: "Size from" value. + :param list: A list of objects to cut from. + :return: Created object. -**TUI Command**: *model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut);* +.. py:function:: 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. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: "Size to" value. + :param number: "Size from" value. + :param list: A list of objects to cut from. + :return: Created object. Result """""" @@ -95,13 +112,30 @@ By bounding planes - **From offset** - offset for extrusion or for a bounding plane, if selected. - **Cut from** - contains a list of objects which will be cut from 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. +**TUI Commands**: + +.. py:function:: model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: "To object". + :param number: "Offset to" value. + :param object: "From object". + :param number: "Offset from" value. + :param list: A list of objects to cut from. + :return: Created object. + +.. py:function:: model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param object: "To object". + :param number: "Offset to" value. + :param object: "From object". + :param number: "Offset from" value. + :param list: A list of objects to cut from. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/extrusionFeature.rst b/src/FeaturesPlugin/doc/extrusionFeature.rst index 9bced660f..897279fbb 100644 --- a/src/FeaturesPlugin/doc/extrusionFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFeature.rst @@ -1,3 +1,4 @@ +.. |extrusion_btn.icon| image:: images/extrusion_btn.png Extrusion ========= @@ -7,13 +8,7 @@ Extrusion feature extrudes selected objects along their normals or the selected To perform Extrusion in the active part: #. select in the Main Menu *Features - > Extrusion* item or -#. click **Extrusion** button in the toolbar - -.. image:: images/extrusion_btn.png - :align: center - -.. centered:: - **Extrusion** button +#. click |extrusion_btn.icon| **Extrusion** button in the toolbar The following property panel will be opened: @@ -48,21 +43,39 @@ By sizes - **To size** - size for extrusion in the direction. - **From size** - size for extrusion in the opposite direction. -**TUI Command**: *model.addExtrusion(part, objects, size);* +**TUI Commands**: -**Arguments**: Part + list of objects + size. +.. py:function:: model.addExtrusion(part, objects, size) -**TUI Command**: *model.addExtrusion(part, objects, direction, size);* + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: Size of extrucion. + :return: Created object. -**Arguments**: Part + list of objects + direction + size. +.. py:function:: model.addExtrusion(part, objects, direction, size) -**TUI Command**: *model.addExtrusion(part, objects, toSize, fromSize);* + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: Size of extrucion. + :return: Created object. -**Arguments**: Part + list of objects + to size + from size. +.. py:function:: model.addExtrusion(part, objects, toSize, fromSize) -**TUI Command**: *model.addExtrusion(part, objects, direction, toSize, fromSize);* + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: "Size to" value. + :param number: "Size from" value. + :return: Created object. -**Arguments**: Part + list of objects + direction + to size + from size. +.. py:function:: model.addExtrusion(part, objects, direction, toSize, fromSize) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: "Size to" value. + :param number: "Size from" value. + :return: Created object. Result """""" @@ -96,13 +109,28 @@ By bounding faces Planar face selected as a boundary of extrusion will be enlarged infinitely. As a result, extrusion bounded only by planar faces will be completed always. On the other hand, if the boundary face is not planar, extrusion may fail, for example, in case of the base object cannot be projected to this face along given direction. -**TUI Command**: *model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset);* +**TUI Commands**: + +.. py:function:: model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset) -**Arguments**: Part + list of objects + to object + to offset + from object + from offset. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: "To object" + :param number: "To offset". + :param object: "From object" + :param number: "From offset". + :return: Created object. -**TUI Command**: *model.addExtrusion(part, objects, direction, toObject, toOffset, fromObject, fromOffset);* +.. py:function:: model.addExtrusion(part, objects, direction, toObject, toOffset, fromObject, fromOffset) -**Arguments**: Part + list of objects + direction + to object + to offset + from object + from offset. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param object: "To object" + :param number: "To offset". + :param object: "From object" + :param number: "From offset". + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst index bcb368698..65d971a87 100644 --- a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst @@ -1,3 +1,4 @@ +.. |extrusion_fuse_btn.icon| image:: images/extrusion_fuse_btn.png Extrusion Fuse ============= @@ -7,13 +8,7 @@ Extrusion Fuse feature extrudes selected objects along their normals or the sele 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 +#. click |extrusion_fuse_btn.icon| **Extrusion Fuse** button in the toolbar The following property panel will be opened: @@ -49,21 +44,43 @@ By sizes - **From size** - size for extrusion in the opposite direction. - **Fuse with** - contains a list of objects which will be fused with the result of extrusion. -**TUI Command**: *model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse);* +**TUI Commands**: + +.. py:function:: model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse) -**Arguments**: Part + list of objects for extrusion + size + list of objects to fuse with. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: Size of extrucion. + :param list: A list of objects to fuse with. + :return: Created object. -**TUI Command**: *model.addExtrusionFuse(part, objects, direction, size, objectsToFuse);* +.. py:function:: model.addExtrusionFuse(part, objects, direction, size, objectsToFuse) -**Arguments**: Part + list of objects for extrusion + direction + size + list of objects to fuse with. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: Size of extrucion. + :param list: A list of objects to fuse with. + :return: Created object. -**TUI Command**: *model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse);* +.. py:function:: model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse) -**Arguments**: Part + list of objects for extrusion + to size + from size + list of objects to fuse with. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param number: "Size to" value. + :param number: "Size from" value. + :param list: A list of objects to fuse with. + :return: Created object. -**TUI Command**: *model.addExtrusionFuse(part, objects, direction, toSize, fromSize, objectsToFuse);* +.. py:function:: 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. + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param number: "Size to" value. + :param number: "Size from" value. + :param list: A list of objects to fuse with. + :return: Created object. Result """""" @@ -95,13 +112,30 @@ By bounding planes - **From offset** - offset for extrusion or for bounding plane, if selected. - **Fuse with** - contains a list of objects which will be 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. +**TUI Commands**: + +.. py:function:: model.addExtrusionFuse(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToFuse) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: "To object". + :param number: "To offset". + :param object: "From object". + :param number: "From offset". + :param list: A list of objects to fuse with. + :return: Created object. + +.. py:function:: model.addExtrusionFuse(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToFuse) + + :param part: The current part object. + :param list: A list of objects for extrusion. + :param object: A direction of extrusion + :param object: "To object". + :param number: "To offset". + :param object: "From object". + :param number: "From offset". + :param list: A list of objects to fuse with. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/filletFeature.rst b/src/FeaturesPlugin/doc/filletFeature.rst index d2752e921..20a41847a 100644 --- a/src/FeaturesPlugin/doc/filletFeature.rst +++ b/src/FeaturesPlugin/doc/filletFeature.rst @@ -1,3 +1,4 @@ +.. |fillet.icon| image:: images/fillet.png .. _featureFillet: @@ -9,13 +10,7 @@ Fillet To create a Fillet in the active part: #. select in the Main Menu *Feature - > Fillet* item or -#. click **Fillet** button in the toolbar - -.. image:: images/fillet.png - :align: center - -.. centered:: - **Fillet** button +#. click |fillet.icon| **Fillet** button in the toolbar There are 2 types of fillet: @@ -43,9 +38,14 @@ Input fields: - **Faces or/and edges** panel contains filleted faces and edges. All edges of a face are subject to fillet operation. Faces and edges are selected in 3D OCC viewer; - **Radius** defines fillet radius. -**TUI Command**: *model.addFillet(Part_doc, [face,edge], radius)* +**TUI Command**: + +.. py:function:: model.addFillet(Part_doc, [face,edge], radius) -**Arguments**: 1 part + list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)* + real (radius value). + :param part: The current part object. + :param list: A list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)*. + :param number: Radius value. + :return: Created object. Result """""" @@ -77,9 +77,15 @@ Input fields: - **Start radius** defines the fillet radius at the start of the selected edge(s); - **End radius** defines the fillet radius at the end of the selected edge(s). -**TUI Command**: *model.addFillet(Part_doc, [face,edge], R1, R2)* +**TUI Command**: + +.. py:function:: model.addFillet(Part_doc, [face,edge], R1, R2) -**Arguments**: part + list of faces and edges subjected to fillet operation in format *model.selection(TYPE, shape)* + 2 reals (start and end radius values). + :param part: The current part object. + :param list: A list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)*. + :param number: Start radius value. + :param number: End radius value. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/fuseFeature.rst b/src/FeaturesPlugin/doc/fuseFeature.rst index c8c84cfdc..24295821e 100644 --- a/src/FeaturesPlugin/doc/fuseFeature.rst +++ b/src/FeaturesPlugin/doc/fuseFeature.rst @@ -1,3 +1,4 @@ +.. |bool_fuse.icon| image:: images/bool_fuse.png Fuse ==== @@ -7,13 +8,7 @@ Fuse feature implements a Boolean operation for fusion of a set of main objects To perform Fuse in the active part: #. select in the Main Menu *Features - > Fuse* item or -#. click **Fuse** button in the toolbar - -.. image:: images/bool_fuse.png - :align: center - -.. centered:: - **Fuse** button +#. click |bool_fuse.icon| **Fuse** button in the toolbar There are 2 options for creation of a Fuse: @@ -40,9 +35,14 @@ Simple - **Remove intersection edges** - if enabled, edges that lie on the same surface will be removed. - **See preview** - button shows a result of the operation. -**TUI Command**: *model.addFuse(Part_doc, objects, isRemoveEdges)* +**TUI Command**: + +.. py:function:: model.addFuse(Part_doc, objects, isRemoveEdges) -**Arguments**: Part + list of objects + remove edges flag (optional). + :param part: The current part object. + :param list: A list of objects. + :param boolean: Remove edges flag (optional). + :return: Created object. Result """""" @@ -74,9 +74,15 @@ Advanced - **Remove intersection edges** - if enabled, edges that lie on the same surface will be removed. - **See preview** - button shows a result of the operation. -**TUI Command**: *model.addFuse(Part_doc, objects, tools, isRemoveEdges)* +**TUI Command**: + +.. py:function:: model.addFuse(Part_doc, objects, tools, isRemoveEdges) -**Arguments**: Part + list of objects + list of tools + remove edges flag (optional). + :param part: The current part object. + :param list: A list of objects. + :param list: A list of tools. + :param boolean: Remove edges flag (optional). + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/fuseFeatureFaces.rst b/src/FeaturesPlugin/doc/fuseFeatureFaces.rst index 3e792761d..f74507821 100644 --- a/src/FeaturesPlugin/doc/fuseFeatureFaces.rst +++ b/src/FeaturesPlugin/doc/fuseFeatureFaces.rst @@ -1,3 +1,4 @@ +.. |fusion_faces.icon| image:: images/fusion_faces.png Fuse Faces ========== @@ -7,13 +8,7 @@ Fuse Faces To perform **Fuse Faces** in the active part: #. select in the Main Menu *Features - > Fuse Faces* item or -#. click **Fuse Faces** button in the toolbar - -.. image:: images/fusion_faces.png - :align: center - -.. centered:: - **Fuse Faces** button +#. click |fusion_faces.icon| **Fuse Faces** button in the toolbar The following property panel appears: @@ -27,9 +22,13 @@ Input fields: - **Shape** - contains object selected in the Object Browser or in the Viewer, on which faces will be fused. -**TUI Command**: *model.addFusionFaces(Part_doc, shape)* +**TUI Command**: + +.. py:function:: model.addFusionFaces(Part_doc, shape) -**Arguments**: Part + shape in format *model.selection(TYPE, shape)*. + :param part: The current part object. + :param list: A shape in format *model.selection(TYPE, shape)*. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/intersectionFeature.rst b/src/FeaturesPlugin/doc/intersectionFeature.rst index 2447fbaf3..9e2180615 100644 --- a/src/FeaturesPlugin/doc/intersectionFeature.rst +++ b/src/FeaturesPlugin/doc/intersectionFeature.rst @@ -1,3 +1,4 @@ +.. |intersection_btn.icon| image:: images/intersection_btn.png Intersection ============ @@ -7,13 +8,7 @@ Intersection feature a boolean operation for intersection of a set of main objec To perform a boolean operation Intersection in the active part: #. select in the Main Menu *Features - > Intersection* item or -#. click **Intersection** button in the toolbar - -.. image:: images/intersection_btn.png - :align: center - -.. centered:: - **Intersection** button +#. click |intersection_btn.icon| **Intersection** button in the toolbar The following property panel will be opened: @@ -25,9 +20,13 @@ The following property panel will be opened: **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be intersected. -**TUI Command**: *model.addIntersection(Part_doc, Objects)* +**TUI Command**: + +.. py:function:: model.addIntersection(Part_doc, Objects) -**Arguments**: Part + list of objects. + :param part: The current part object. + :param list: A list of objects. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/linearCopyFeature.rst b/src/FeaturesPlugin/doc/linearCopyFeature.rst index 028e7fe7a..a989daa7f 100644 --- a/src/FeaturesPlugin/doc/linearCopyFeature.rst +++ b/src/FeaturesPlugin/doc/linearCopyFeature.rst @@ -1,3 +1,4 @@ +.. |multitranslation.icon| image:: images/multitranslation.png Linear copy =========== @@ -7,13 +8,7 @@ Linear copy To create a Linear copy in the active part: #. select in the Main Menu *Part - > Linear copy* item or -#. click **Linear copy** button in the toolbar - -.. image:: images/multitranslation.png - :align: center - -.. centered:: - **Linear copy** button +#. click |multitranslation.icon| **Linear copy** button in the toolbar The following property panel appears. @@ -38,9 +33,19 @@ Input fields: - **Step** defines the distance between the shape copies; - **Nb. Copies** defines the number of shape copies. -**TUI Command**: *model.addMultiTranslation(Part_doc, [shape], axis1, step1, Nb1, axis2, step2, Nb2)* +**TUI Command**: + +.. py:function:: model.addMultiTranslation(Part_doc, [shape], axis1, step1, Nb1, axis2, step2, Nb2) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 2 axis in format *model.selection(TYPE, shape)*+ 2 real (step values) + 2 integers (Nb. Copies). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A first axis in format *model.selection(TYPE, shape)*. + :param real: The first step value. + :param integer: The first number of copies. + :param object: A second axis in format *model.selection(TYPE, shape)*. + :param real: The second step value. + :param integer: The second number of copies. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/measurementFeature.rst b/src/FeaturesPlugin/doc/measurementFeature.rst index 7fc7b9667..42a45fadf 100644 --- a/src/FeaturesPlugin/doc/measurementFeature.rst +++ b/src/FeaturesPlugin/doc/measurementFeature.rst @@ -1,3 +1,4 @@ +.. |measurement.icon| image:: images/measurement.png Measurement =========== @@ -13,13 +14,7 @@ The properties of dimension text and line, such as font, color, arrow size, etc To start Measurement in the active part: #. select in the Main Menu *Part - > Measurement* item or -#. click **Measurement** button in the toolbar - -.. image:: images/measurement.png - :align: center - -.. centered:: - **Measurement** button +#. click |measurement.icon| **Measurement** button in the toolbar The following dimensions can be calculated: @@ -60,9 +55,13 @@ Input fields: Note, that for curved edges length is displayed only in the property panel. -**TUI Command**: *length =model.measureLength(Part_doc, edge)* +**TUI Command**: + +.. py:function:: model.measureLength(Part_doc, edge) -**Arguments**: part + edge in format *model.selection("EDGE", edge)*. + :param part: The current part object. + :param object: An edge in format *model.selection("EDGE", edge)*. + :return: Calculated value. Distance between objects @@ -80,9 +79,14 @@ Input fields: - **From**, **To** contain shapes between which distance is measured. Shapes are selected in 3D OCC viewer or object browser. -**TUI Command**: *length =model.measureDistance(Part_doc, shape1, shape2)* +**TUI Command**: + +.. py:function:: model.measureDistance(Part_doc, shape1, shape2) -**Arguments**: part + 2 shapes in format *model.selection("TYPE", shape)*. + :param part: The current part object. + :param object: A first edge in format *model.selection("EDGE", edge)*. + :param object: A second edge in format *model.selection("EDGE", edge)*. + :return: Calculated value. Radius ------ @@ -100,9 +104,13 @@ Input fields: - **Object** contains shape to be measured selected in 3D OCC viewer or object browser. -**TUI Command**: *radius = model.measureRadius(Part_doc, shape)* +**TUI Command**: + +.. py:function:: model.measureRadius(Part_doc, shape) -**Arguments**: part + shape in format *model.selection("TYPE", shape)*. + :param part: The current part object. + :param object: An edge in format *model.selection("TYPE", shape)*. + :return: Calculated value. Angle between edges ------------------- @@ -119,9 +127,14 @@ Input fields: - **First Edge**, **Second edge** contain edges between which angle is measured. Edges are selected in 3D OCC viewer or object browser. -**TUI Command**: *angle = model.measureAngle(Part_doc, edge1, edge2)* +**TUI Command**: + +.. py:function:: model.measureAngle(Part_doc, edge1, edge2) -**Arguments**: part + 2 edges in format *model.selection("EDGE", edge)*. + :param part: The current part object. + :param object: A first edge in format *model.selection("TYPE", shape)*. + :param object: A second edge in format *model.selection("TYPE", shape)*. + :return: Calculated value. Angle by 3 points ----------------- @@ -138,7 +151,13 @@ Input fields: - **First point**, **Second point**, **Third point** contain point between which angle is measured. Points are selected in 3D OCC viewer or object browser. -**TUI Command**: *angle = model.measureAngle(Part_doc, vertex1, vertex2, vertex3)* +**TUI Command**: + +.. py:function:: model.measureAngle(Part_doc, vertex1, vertex2, vertex3) -**Arguments**: part + 3 vertices in format *model.selection("VERTEX", vertex)*. + :param part: The current part object. + :param object: A first vertex in format *model.selection("TYPE", shape)*. + :param object: A second vertex in format *model.selection("TYPE", shape)*. + :param object: A third vertex in format *model.selection("TYPE", shape)*. + :return: Calculated value. \ No newline at end of file diff --git a/src/FeaturesPlugin/doc/partitionFeature.rst b/src/FeaturesPlugin/doc/partitionFeature.rst index a0a262ef1..7b5047ed3 100644 --- a/src/FeaturesPlugin/doc/partitionFeature.rst +++ b/src/FeaturesPlugin/doc/partitionFeature.rst @@ -1,3 +1,4 @@ +.. |partition_btn.icon| image:: images/partition_btn.png Partition ========= @@ -7,13 +8,7 @@ Partition feature implements a boolean operation for partitioning of a set of se To perform a Partition in the active part: #. select in the Main Menu *Features - > Partition* item or -#. click **Partition** button in the toolbar - -.. image:: images/partition_btn.png - :align: center - -.. centered:: - **Partition** button +#. click |partition_btn.icon| **Partition** button in the toolbar The following property panel will be opened: @@ -25,9 +20,13 @@ The following property panel will be opened: **Base Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be partitioned. -**TUI Command**: *model.addPartition(Part_doc, objects)* +**TUI Command**: + +.. py:function:: model.addPartition(Part_doc, objects) -**Arguments**: Part + list of objects. + :param part: The current part object. + :param object: A list of objects. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/pipeFeature.rst b/src/FeaturesPlugin/doc/pipeFeature.rst index fd26614b9..40611a394 100644 --- a/src/FeaturesPlugin/doc/pipeFeature.rst +++ b/src/FeaturesPlugin/doc/pipeFeature.rst @@ -1,3 +1,4 @@ +.. |pipe.icon| image:: images/pipe.png Pipe ==== @@ -7,13 +8,7 @@ Pipe To create a Pipe in the active part: #. select in the Main Menu *Features - > Pipe* item or -#. click **Pipe** button in the toolbar - -.. image:: images/pipe.png - :align: center - -.. centered:: - **Pipe** button +#. click |pipe.icon| **Pipe** button in the toolbar Pipe can be created in three different ways: @@ -45,9 +40,14 @@ Input fields: - **Base objects** panel contains shapes to be extruded. Several Base Objects generate several pipes. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser; - **Path object** defines the path along which the Base Object will be extruded. **Path object** (edge or wire) is selected in 3D OCC viewer or object browser; -**TUI Command**: *model.addPipe(Part_doc, [shape], path)* +**TUI Command**: + +.. py:function:: model.addPipe(Part_doc, [shape], path) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)*. + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A path in format *model.selection(TYPE, shape)*. + :return: Created object. Result """""" @@ -79,9 +79,15 @@ Input fields: - **Path object** defines the path along which the Base Object will be extruded. **Path object** (edge or wire) is selected in 3D OCC viewer or object browser; - **Bi-Normal** defines the BiNormal Vector. **Bi-Normal** (edge or wire) is selected in 3D OCC viewer or object browser. -**TUI Command**: *model.addPipe(Part_doc, [shape], path, binormal)* +**TUI Command**: + +.. py:function:: model.addPipe(Part_doc, [shape], path, binormal) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)* + binormal in format *model.selection(TYPE, shape)*. + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A path in format *model.selection(TYPE, shape)*. + :param object: A binormal in format *model.selection(TYPE, shape)*. + :return: Created object. Result """""" @@ -113,9 +119,15 @@ Input fields: - **Path object** defines the path along which the Base Object will be extruded. **Path object** (edge or wire) is selected in 3D OCC viewer or object browser; - **Locations** define the list of vertices that specify the locations of extruded Base Objects on the resulting Path Object. The number of Base Objects should be equal to the number of Locations. -**TUI Command**: *model.addPipe(Part_doc, [shape], path, locations)* +**TUI Command**: + +.. py:function:: model.addPipe(Part_doc, [shape], path, locations) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)* + list of locations in format *model.selection(TYPE, shape)*. + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A path in format *model.selection(TYPE, shape)*. + :param list: A list of locations in format *model.selection(TYPE, shape)*. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/placementFeature.rst b/src/FeaturesPlugin/doc/placementFeature.rst index 91b7b38ab..6ce1e3ea7 100644 --- a/src/FeaturesPlugin/doc/placementFeature.rst +++ b/src/FeaturesPlugin/doc/placementFeature.rst @@ -1,3 +1,4 @@ +.. |placement_btn.icon| image:: images/placement_btn.png Placement ========= @@ -5,13 +6,7 @@ Placement Placement defines position of an object relatively to another object. To make a placement: #. select in the Main Menu *Part - > Placement* item or -#. click **Placement** button in the toolbar - -.. image:: images/placement_btn.png - :align: center - -.. centered:: - **Placement** button +#. click |placement_btn.icon| **Placement** button in the toolbar The following property panel will be opened: @@ -32,14 +27,21 @@ In this property panel, it is necessary to: - Define state of **Reverse** and **Centering** check boxes. - **Apply** button creates the placement. **Cancel** button cancels the operation. -**TUI Command**: *model.addPlacement(Part_doc, placeObjects, startShape, endShape, isReverse, isCentering)* +**TUI Command**: + +.. py:function:: model.addPlacement(Part_doc, placeObjects, startShape, endShape, isReverse, isCentering) -**Arguments**: Part + list of objects to move + start shape + end shape + is reverse flag + is centering flag. + :param part: The current part object. + :param list: A list of objects to move. + :param object: A start shape. + :param object: A end shape. + :param bool: Is reverse flag. + :param bool: Is centering flag. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/recoverFeature.rst b/src/FeaturesPlugin/doc/recoverFeature.rst index 18ae83f59..64b27ea59 100644 --- a/src/FeaturesPlugin/doc/recoverFeature.rst +++ b/src/FeaturesPlugin/doc/recoverFeature.rst @@ -1,3 +1,5 @@ +.. |recover.icon| image:: images/recover.png + Recover ======= @@ -6,13 +8,7 @@ Recover To recover in the active part: #. select in the Main Menu *Features - > Recover* item or -#. click **Recover** button in the toolbar - -.. image:: images/recover.png - :align: center - -.. centered:: - **Recover** button +#. click |recover.icon| **Recover** button in the toolbar The feature has the following options: @@ -37,9 +33,14 @@ Recover objects - **Feature** field contains one of the previous operations; - **List of recovered** objects contains all the shapes used in the operation. Need to enable checkbox to restore a shape. -**TUI Command**: *model.addRecover(Part_doc, feature, [recovering_results])* +**TUI Command**: + +.. py:function:: model.addRecover(Part_doc, feature, [recovering_results]) -**Arguments**: part + the name of the feature + list of results used in the feature. + :param part: The current part object. + :param string: The name of the feature. + :param list: A list of results used in the feature. + :return: Created object. Result """""" @@ -67,9 +68,15 @@ Recover top-level objects - **Feature** field contains one of the previous operations; - **List of recovered** objects contains all top-level shapes (compounds/compsolids) of the shapes used in the operation. Need to enable checkbox to restore a shape. -**TUI Command**: *model.addRecover(Part_doc, feature, [recovering_results], True)* +**TUI Command**: + +.. py:function:: model.addRecover(Part_doc, feature, [recovering_results], True) -**Arguments**: part + the name of the feature + list of results used in the feature + *True* to specify restoring compounds. + :param part: The current part object. + :param string: The name of the feature. + :param list: A list of results used in the feature. + :param boolean: *True* to specify restoring compounds. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst index ff7740ad0..d3e7fc9c0 100644 --- a/src/FeaturesPlugin/doc/removeSubShapesFeature.rst +++ b/src/FeaturesPlugin/doc/removeSubShapesFeature.rst @@ -1,3 +1,4 @@ +.. |remove_subshapes_btn.icon| image:: images/remove_subshapes_btn.png Remove Sub-Shapes ================= @@ -7,13 +8,7 @@ Remove Sub-Shapes allows removing sub shapes from wires, shells, compsolids and To 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 +#. click |remove_subshapes_btn.icon| **Remove Sub-Shapes** button in the toolbar The following property panel will be opened: @@ -34,10 +29,16 @@ There are 2 options for removing sub-shapes: - **Sub-Shapes to remove** the 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. +.. py:function:: model.addRemoveSubShapes(Part_1_doc, object) + + :param part: The current part object. + :param object: The object. + :return: Created object. + +.. py:function:: Remove_SubShapes_1.setSubShapesToRemove(subShapes) + + :param list: A list of objects. .. image:: images/keep_subshapes_32x32.png @@ -47,10 +48,16 @@ There are 2 options for removing sub-shapes: - **Sub-Shapes to keep** the 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. +.. py:function:: model.addRemoveSubShapes(Part_1_doc, object) + + :param part: The current part object. + :param object: The object. + :return: Created object. + +.. py:function:: Remove_SubShapes_1.setSubShapesToKeep(subShapes) + + :param list: A list of sub-shapes to keep. Result diff --git a/src/FeaturesPlugin/doc/revolutionCutFeature.rst b/src/FeaturesPlugin/doc/revolutionCutFeature.rst index 23fdaab92..b2f5d4704 100644 --- a/src/FeaturesPlugin/doc/revolutionCutFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionCutFeature.rst @@ -1,3 +1,4 @@ +.. |revolution_cut_btn.icon| image:: images/revolution_cut_btn.png Revolution Cut ============== @@ -7,13 +8,7 @@ Revolution Cut feature revolves the selected objects around the selected axis an To perform a 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 +#. click |revolution_cut_btn.icon| **Revolution Cut** button in the toolbar The following property panel will be opened: @@ -49,13 +44,26 @@ By angles - **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);* +**TUI Commands**: -**Arguments**: Part + list of objects for revolution + axis + angle + list of objects to cut from. +.. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, angle, objectToCut) -**TUI Command**: *model.addRevolutionCut(part, objectsToRevolve, axis, toAngle, fromAngle, objectToCut);* + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: An angle. + :param list: A list of objects to cut from. + :return: Created object. -**Arguments**: Part + list of objects for revolution + axis + to angle + from angle + list of objects to cut from. +.. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, toAngle, fromAngle, objectToCut) + + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: To angle. + :param real: From angle. + :param list: A list of objects to cut from. + :return: Created object. Result """""" @@ -87,9 +95,19 @@ By bounding planes - **From offset** - offset for revolution or for bounding plane, if selected. - **Cut from** - contains a list of objects from which the result of revolution will be cut. -**TUI Command**: *model.addRevolutionCut(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToCut);* +**TUI Command**: + +.. py:function:: 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. + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param object: To object. + :param real: To offset. + :param object: From object. + :param real: From offset. + :param list: A list of objects to cut from. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/revolutionFeature.rst b/src/FeaturesPlugin/doc/revolutionFeature.rst index eb492261c..cdf8790e3 100644 --- a/src/FeaturesPlugin/doc/revolutionFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFeature.rst @@ -1,3 +1,4 @@ +.. |revolution_btn.icon| image:: images/revolution_btn.png Revolution ========== @@ -7,13 +8,7 @@ Revolution feature revolves selected objects around selected axis. To perform a 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 +#. click |revolution_btn.icon| **Revolution** button in the toolbar The following property panel will be opened: @@ -48,13 +43,24 @@ By angles - **To angle** - end angle of revolution. - **From angle** - start angle of revolution. -**TUI Command**: *model.addRevolution(part, objects, axis, angle);* +**TUI Commands**: -**Arguments**: Part + list of objects + axis + angle. +.. py:function:: model.addRevolution(part, objects, axis, angle) -**TUI Command**: *model.addRevolution(part, objects, axis, toSize, fromSize);* + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: An angle. + :return: Created object. -**Arguments**: Part + list of objects + axis + to angle + from angle. +.. py:function:: model.addRevolution(part, objects, axis, toSize, fromSize) + + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: To angle. + :param real: From angle. + :return: Created object. Result """""" @@ -85,9 +91,18 @@ By bounding planes - **From plane** - a 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);* +**TUI Command**: + +.. py:function:: model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset) -**Arguments**: Part + list of objects + axis + to object + to offset + from object + from offset. + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param object: To object. + :param real: To offset. + :param object: From object. + :param real: From offset. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/revolutionFuseFeature.rst b/src/FeaturesPlugin/doc/revolutionFuseFeature.rst index e0e55a17a..3ef022a8a 100644 --- a/src/FeaturesPlugin/doc/revolutionFuseFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFuseFeature.rst @@ -1,3 +1,4 @@ +.. |revolution_fuse_btn.icon| image:: images/revolution_fuse_btn.png Revolution Fuse =============== @@ -7,13 +8,7 @@ Revolution Fuse feature revolves the selected objects around the selected axis a 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 +#. click |revolution_fuse_btn.icon| **Revolution Fuse** button in the toolbar The following property panel will be opened: @@ -49,13 +44,26 @@ By angles - **From angle**- start angle of revolution. - **Fuse with** contains a list of objects which will be fused with the result of revolution. -**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse);* +**TUI Command**: -**Arguments**: Part + list of objects for revolution + axis + angle + list of objects to fuse with. +.. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse) -**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse);* + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: Angle. + :param list: A list of objects to fuse with. + :return: Created object. -**Arguments**: Part + list of objects for revolution + axis + to angle + from angle + list of objects to fuse with. +.. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse) + + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: To angle. + :param real: From angle. + :param list: A list of objects to fuse with. + :return: Created object. Result """""" @@ -87,9 +95,19 @@ By bounding planes - **From offset** - offset for revolution or for bounding plane, if selected. - **Fuse with** - contains a list of objects which will be fused with the result of revolution. -**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToFuse);* +**TUI Command**: + +.. py:function:: 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. + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param object: To object. + :param real: To offset. + :param object: From object. + :param real: From offset. + :param list: A list of objects to fuse with. + :return: Created object. Result """""" diff --git a/src/FeaturesPlugin/doc/rotationFeature.rst b/src/FeaturesPlugin/doc/rotationFeature.rst index 1739cd919..548462619 100644 --- a/src/FeaturesPlugin/doc/rotationFeature.rst +++ b/src/FeaturesPlugin/doc/rotationFeature.rst @@ -1,4 +1,5 @@ .. _featureRotation: +.. |rotation.icon| image:: images/rotation.png Rotation ======== @@ -8,13 +9,7 @@ Rotation To create a Rotation in the active part: #. select in the Main Menu *Part - > Rotation* item or -#. click **Rotation** button in the toolbar - -.. image:: images/rotation.png - :align: center - -.. centered:: - **Rotation** button +#. click |rotation.icon| **Rotation** button in the toolbar Two rotation algorithms are: @@ -41,9 +36,15 @@ Input fields: - **Axis** defines the axis of rotation. The vector is an edge or axis selected in 3D OCC viewer or object browser; - **Angle** defines the angle by which the object is rotated. -**TUI Command**: *model.addRotation(Part_doc, [shape], axis, angle)* +**TUI Command**: + +.. py:function:: model.addRotation(Part_doc, [shape], axis, angle) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ real (angle value). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: An axis in format *model.selection(TYPE, shape)*. + :param real: An angle. + :return: Rotated object. Result """""" @@ -72,9 +73,17 @@ Input fields: - **Main objects** panel contains shapes to be rotated. Shapes are selected in 3D OCC viewer or object browser; - **Center point**, **Start point**, **End point** define 3 points or vertices selected in 3D OCC viewer or object browser. Rotation axis will pass through the **Center point** and will be orthogonal to a plane defined by three points. Rotation Angle is the angle between two vectors directed from the **Center point** to **Start point** and **End point**. -**TUI Command**: *model.addRotation(Part_doc, [shape], point1, point2, point3)* +**TUI Command**: + +.. py:function:: model.addRotation(Part_doc, [shape], point1, point2, point3)* -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 3 points in format *model.selection(TYPE, shape)*. + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: An axis in format *model.selection(TYPE, shape)*. + :param object: Center vertex. + :param object: Start vertex. + :param object: End vertex. + :return: Rotated object. Result """""" diff --git a/src/FeaturesPlugin/doc/smashFeature.rst b/src/FeaturesPlugin/doc/smashFeature.rst index 12556f3f0..48225b962 100644 --- a/src/FeaturesPlugin/doc/smashFeature.rst +++ b/src/FeaturesPlugin/doc/smashFeature.rst @@ -1,3 +1,4 @@ +.. |bool_smash.icon| image:: images/bool_smash.png Smash ===== @@ -7,13 +8,7 @@ Smash feature implements a boolean operation for smashing a set of main objects To create a Smash in the active part: #. select in the Main Menu *Features - > Smash* item or -#. click **Smash** button in the toolbar - -.. image:: images/bool_smash.png - :align: center - -.. centered:: - **Smash** button +#. click |bool_smash.icon| **Smash** button in the toolbar The following property panel will be opened: @@ -30,9 +25,14 @@ The following property panel will be opened: If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored. - **See preview** button shows a result of the operation. -**TUI Command**: *model.addSmash(Part_doc, mainObjects, toolObjects)* +**TUI Command**: + +.. py:function:: model.addSmash(Part_doc, mainObjects, toolObjects) -**Arguments**: Part + list of main objects + list of tool objects. + :param part: The current part object. + :param list: A list of main objects. + :param list: A list of tool objects. + :return: Rotated object. Result """""" diff --git a/src/FeaturesPlugin/doc/splitFeature.rst b/src/FeaturesPlugin/doc/splitFeature.rst index fe0458161..b8d4a2003 100644 --- a/src/FeaturesPlugin/doc/splitFeature.rst +++ b/src/FeaturesPlugin/doc/splitFeature.rst @@ -1,3 +1,4 @@ +.. |bool_split.icon| image:: images/bool_split.png Split ===== @@ -7,13 +8,7 @@ Split feature implements a Boolean operation splitting of main objects by parts To perform Split in the active part: #. select in the Main Menu *Features - > Split* item or -#. click **Split** button in the toolbar - -.. image:: images/bool_split.png - :align: center - -.. centered:: - **Split** button +#. click |bool_split.icon| **Split** button in the toolbar The following property panel will be opened: @@ -27,9 +22,14 @@ The following property panel will be opened: - **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut and split the main objects. - **See preview** button shows a result of the operation. -**TUI Command**: *model.addSplit(Part_doc, mainObjects, toolObjects)* +**TUI Command**: + +.. py:function:: model.addSplit(Part_doc, mainObjects, toolObjects) -**Arguments**: Part + list of main objects + list of tool objects. + :param part: The current part object. + :param list: A list of main objects. + :param list: A list of tool objects. + :return: Result object. Result """""" diff --git a/src/FeaturesPlugin/doc/symmetryFeature.rst b/src/FeaturesPlugin/doc/symmetryFeature.rst index 7a34a2381..7e815e425 100644 --- a/src/FeaturesPlugin/doc/symmetryFeature.rst +++ b/src/FeaturesPlugin/doc/symmetryFeature.rst @@ -1,3 +1,4 @@ +.. |symmetry.icon| image:: images/symmetry.png Symmetry ======== @@ -7,13 +8,7 @@ Symmetry To create a Symmetry in the active part: #. select in the Main Menu *Part - > Symmetry* item or -#. click **Symmetry** button in the toolbar - -.. image:: images/symmetry.png - :align: center - -.. centered:: - **Symmetry** button +#. click |symmetry.icon| **Symmetry** button in the toolbar Symmetrical copy of an Object can be mirrored in three different ways: @@ -44,9 +39,15 @@ Input fields: - **Point** defines a point of symmetry selected in 3D OCC viewer or object browser; - **Create a copy** checkbox preserves/removes the initial object. -**TUI Command**: *model.addSymmetry(Part_doc, [shape], point, copy)* +**TUI Command**: -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + point in format *model.selection(TYPE, shape)*+ boolean (Create a copy key). +.. py:function:: model.addSymmetry(Part_doc, [shape], point, copy) + + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A point in format *model.selection(TYPE, shape)*. + :param boolean: A flag to create a copy. + :return: Result object. Result """""" @@ -76,9 +77,15 @@ Input fields: - **Axis** defines an axis of symmetry selected in 3D OCC viewer or object browser; - **Create a copy** checkbox preserves/removes the initial object. -**TUI Command**: *model.addSymmetry(Part_doc, [shape], axis, copy)* +**TUI Command**: + +.. py:function:: model.addSymmetry(Part_doc, [shape], axis, copy) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ boolean (Create a copy key). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: An axis in format *model.selection(TYPE, shape)*. + :param boolean: A flag to create a copy. + :return: Result object. Result """""" @@ -108,9 +115,15 @@ Input fields: - **Plane** defines a plane of symmetry selected in 3D OCC viewer or object browser; - **Create a copy** checkbox preserves/removes the initial object. -**TUI Command**: *model.addSymmetry(Part_doc, [shape], plane, copy)* +**TUI Command**: + +.. py:function:: model.addSymmetry(Part_doc, [shape], plane, copy) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + plane in format *model.selection(TYPE, shape)*+ boolean (Create a copy key). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A plane in format *model.selection(TYPE, shape)*. + :param boolean: A flag to create a copy. + :return: Result object. Result """""" diff --git a/src/FeaturesPlugin/doc/transformationFeature.rst b/src/FeaturesPlugin/doc/transformationFeature.rst index 87d34f442..6e8594592 100644 --- a/src/FeaturesPlugin/doc/transformationFeature.rst +++ b/src/FeaturesPlugin/doc/transformationFeature.rst @@ -1,3 +1,4 @@ +.. |scale.icon| image:: images/scale.png Scale ===== @@ -7,13 +8,7 @@ Scale To create a Scale in the active part: #. select in the Main Menu *Features - > Scale* item or -#. click **Scale** button in the toolbar - -.. image:: images/scale.png - :align: center - -.. centered:: - **Scale** button +#. click |scale.icon| **Scale** button in the toolbar Two Scale algorithms are: @@ -42,9 +37,15 @@ Input fields: - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser; - **Scale factor** defines the multiplier of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point. -**TUI Command**: *model.addScale(Part_doc, [shape], center, factor)* +**TUI Command**: + +.. py:function:: model.addScale(Part_doc, [shape], center, factor) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + center point in format *model.selection(TYPE, shape)*+ real (scale factor value). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A center point in format *model.selection(TYPE, shape)*. + :param real: Scale factor. + :return: Result object. Result """""" @@ -76,9 +77,15 @@ Input fields: - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser; - **Scale factor in X**, **Scale factor in Y**, **Scale factor in Z** define the the multipliers of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point. -**TUI Command**: *model.addScale(Part_doc, [shape], center, factors)* +**TUI Command**: + +.. py:function:: model.addScale(Part_doc, [shape], center, factors) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + center point in format *model.selection(TYPE, shape)*+ 3 reals (scale factor values along X. Y, Z axes). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A center point in format *model.selection(TYPE, shape)*. + :param list: A list of three scale factor values along X. Y, Z axes. + :return: Result object. Result """""" diff --git a/src/FeaturesPlugin/doc/translationFeature.rst b/src/FeaturesPlugin/doc/translationFeature.rst index c71590b78..fddadf371 100644 --- a/src/FeaturesPlugin/doc/translationFeature.rst +++ b/src/FeaturesPlugin/doc/translationFeature.rst @@ -1,4 +1,5 @@ .. _featureTranslation: +.. |translation_vector_32x32.icon| image:: images/translation_vector_32x32.png Translation =========== @@ -8,7 +9,7 @@ Translation To create a Translation in the active part: #. select in the Main Menu *Part - > Translation* item or -#. click **Translation** button in the toolbar +#. click |translation_vector_32x32.icon| **Translation** button in the toolbar .. image:: images/translation_vector_32x32.png :align: center @@ -45,9 +46,15 @@ Input fields: - **Axis** defines a vector along which the object will be translated. The vector is an edge or axis selected in 3D OCC viewer or object browser; - **Distance** defines the distance along the **Vector of translation**. -**TUI Command**: *model.addTranslation(Part_doc, [shape], axis, dist)* +**TUI Command**: -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ real (distance value). +.. py:function:: model.addTranslation(Part_doc, [shape], axis, dist) + + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: axis in format *model.selection(TYPE, shape)*. + :param real: Distance value. + :return: Result object. Result """""" @@ -76,9 +83,16 @@ Input fields: - **Main objects** panel contains shapes to be translated. The shapes are selected in 3D OCC viewer or object browser; - **DX**, **DY**, **DZ** define vector using coordinates along the axis. -**TUI Command**: *model.addTranslation(Part_1_doc, [shape], DX, DY, DZ)* +**TUI Command**: + +.. py:function:: model.addTranslation(Part_1_doc, [shape], DX, DY, DZ) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 3 real (coordinate values). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param real: dX value. + :param real: dY value. + :param real: dZ value. + :return: Result object. Result """""" @@ -109,9 +123,15 @@ Input fields: - **Start point** defines start vector point as point or vertex selected in 3D OCC viewer or object browser; - **End point** defines end vector point as point or vertex selected in 3D OCC viewer or object browser; -**TUI Command**: *model.addTranslation(Part_doc, [shape], point1, point2)* +**TUI Command**: + +.. py:function:: model.addTranslation(Part_doc, [shape], point1, point2) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 2 points in format *model.selection(TYPE, shape)*. + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A point in format *model.selection(TYPE, shape)*. + :param object: A point in format *model.selection(TYPE, shape)*. + :return: Result object. Result """""" diff --git a/src/FeaturesPlugin/doc/unionFeature.rst b/src/FeaturesPlugin/doc/unionFeature.rst index 9a3cef4cd..3fbaf42c1 100644 --- a/src/FeaturesPlugin/doc/unionFeature.rst +++ b/src/FeaturesPlugin/doc/unionFeature.rst @@ -1,3 +1,4 @@ +.. |union_btn.icon| image:: images/union_btn.png Union ===== @@ -7,13 +8,7 @@ Union feature implements a Boolean operation for creation of a union of selected To create a Union in the active part: #. select in the Main Menu *Features - > Union* item or -#. click **Union** button in the toolbar - -.. image:: images/union_btn.png - :align: center - -.. centered:: - **Union** button +#. click |union_btn.icon| **Union** button in the toolbar The following property panel will be opened: @@ -29,9 +24,13 @@ Here it is necessary to select some objects. Only faces with shared edges or sol **Cancel** button cancels the operation. -**TUI Command**: *model.addUnion(Part_doc, objects)* +**TUI Command**: + +.. py:function:: model.addUnion(Part_doc, objects) -**Arguments**: Part + list of objects. + :param part: The current part object. + :param list: A list of objects. + :return: Result object. Result """""" diff --git a/src/ParametersPlugin/doc/managerFeature.rst b/src/ParametersPlugin/doc/managerFeature.rst index 1b6547903..c543c34d7 100644 --- a/src/ParametersPlugin/doc/managerFeature.rst +++ b/src/ParametersPlugin/doc/managerFeature.rst @@ -1,4 +1,5 @@ .. _parameters: +.. |paper_roll.icon| image:: images/paper_roll.png Parameters manager @@ -7,13 +8,7 @@ Parameters manager To create/edit simultaneously a set of parameters in the active partset or part instead of calling them one by one: #. select in the Main Menu *Part - > Parameters* item or -#. click **Parameters** button in the toolbar: - -.. image:: images/paper_roll.png - :align: center - -.. centered:: - **Parameters** button +#. click |paper_roll.icon| **Parameters** button in the toolbar: The following dialog box with parameter table appears: @@ -42,9 +37,15 @@ The following dialog box with parameter table appears: one string lower in the table. -**TUI Command**: *model.addParameter(Part_doc, Name, Value, Comment)* +**TUI Command**: + +.. py:function:: model.addParameter(Part_doc, Name, Value, Comment) -**Arguments**: 1 Part + 1 string + 1 value + 1 string + :param part: The current part object + :param string: The parameter name + :param number: The parameter value + :param string: The parameter comment + :return: Created object. **See Also** a sample TUI Script of :ref:`tui_parametersFeature` operation. diff --git a/src/ParametersPlugin/doc/parameterFeature.rst b/src/ParametersPlugin/doc/parameterFeature.rst index 02970c409..efd7849ba 100644 --- a/src/ParametersPlugin/doc/parameterFeature.rst +++ b/src/ParametersPlugin/doc/parameterFeature.rst @@ -1,4 +1,5 @@ .. _parameter: +.. |expression.icon| image:: images/expression.png Create parameter ================ @@ -8,13 +9,8 @@ The parameter can be defined in form *variable=expression*. To create a parameter in the active partset or part: #. select in the Main Menu *Part - > Parameter* item or -#. click **Parameter** button in the toolbar: +#. click |expression.icon| **Parameter** button in the toolbar: -.. image:: images/expression.png - :align: center - -.. centered:: - **Parameter** button The following property panel appears. @@ -26,9 +22,7 @@ The following property panel appears. **Input fields**: -- .. image:: images/expression.png - :align: left - defines parameter name following the naming rules of the python language for variables; +- |expression.icon| defines parameter name following the naming rules of the python language for variables; - panel **Expression** evaluates the expression input manually as a real number by python *eval()* function. In the simplest case an expression is a real number. Some standard python modules (like math) are imported by default before evaluation. @@ -37,9 +31,15 @@ The following property panel appears. The property panel checks validity of the expression. For an invalid expression **Apply** button is disabled and an error message generated by python interpreter during the evaluation is shown in the status bar and in pop-up of **Apply** button. -**TUI Command**: *model.addParameter(Part_doc, Name, Value, Comment)* +**TUI Command**: + +.. py:function:: model.addParameter(Part_doc, Name, Value, Comment) -**Arguments**: 1 Part + 1 string + 1 value + 1 string + :param part: The current part object + :param string: The parameter name + :param number: The parameter value + :param string: The parameter comment + :return: Created object. **See Also** a sample TUI Script of a :ref:`tui_parameterFeature` operation. diff --git a/src/PartSetPlugin/doc/PartSetPlugin.rst b/src/PartSetPlugin/doc/PartSetPlugin.rst index 887a33497..df635b9b2 100644 --- a/src/PartSetPlugin/doc/PartSetPlugin.rst +++ b/src/PartSetPlugin/doc/PartSetPlugin.rst @@ -1,3 +1,6 @@ +.. |new_part.icon| image:: images/new_part.png +.. |remove.icon| image:: images/remove.png +.. |duplicate.icon| image:: images/duplicate.png .. _partPlugin: @@ -12,17 +15,14 @@ New Part To create a New Part: #. select in the Main Menu *Part - > New part* item or -#. click **New part** button in Shaper toolbar: +#. click |new_part.icon| **New part** button in Shaper toolbar: -.. image:: images/new_part.png - :align: center +**TUI Command**: -.. centered:: - New part button +.. py:function:: model.addPart(partSet) -**TUI Command**: *model.addPart(partSet)* - -**Arguments**: 1 partset + :param part: The current part object. + :return: Result object. Result """""" @@ -37,13 +37,7 @@ Duplicate Part To duplicate an active Part: #. select in the Main Menu *Part - > Duplicate part* item or -#. click **Duplicate part** button in Shaper toolbar: - -.. image:: images/duplicate.png - :align: center - -.. centered:: - Duplicate part button +#. click |duplicate.icon| **Duplicate part** button in Shaper toolbar: Result """""" @@ -58,13 +52,7 @@ Remove Part To remove an active Part: #. select in the Main Menu *Part - > Remove part* item or -#. click **Remove part** button in Shaper toolbar: - -.. image:: images/remove.png - :align: center - -.. centered:: - Remove part button +#. click |remove.icon| **Remove part** button in Shaper toolbar: Result """""" diff --git a/src/PrimitivesPlugin/doc/boxFeature.rst b/src/PrimitivesPlugin/doc/boxFeature.rst index 307883cb9..a0809eba8 100644 --- a/src/PrimitivesPlugin/doc/boxFeature.rst +++ b/src/PrimitivesPlugin/doc/boxFeature.rst @@ -1,4 +1,5 @@ .. _box_feature: +.. |box.icon| image:: images/box.png Box === @@ -8,13 +9,7 @@ Box feature creates a box solid. To create a Box in the active part: #. select in the Main Menu *Primitives - > Box* item or -#. click **Box** button in the toolbar: - -.. image:: images/box.png - :align: center - -.. centered:: - **Box** button +#. click |box.icon| **Box** button in the toolbar: There are 2 algorithms for creation of a Box: @@ -39,9 +34,15 @@ Input fields: - **DX**, **DY**, **DZ** define dimensions of the box along the corresponding coordinate axes. -**TUI Command**: *model.addBox(Part_doc, DX, DY, DZ)* +**TUI Command**: + +.. py:function:: model.addBox(Part_doc, DX, DY, DZ) -**Arguments**: Part + 3 real values (dimensions at origin). + :param part: The current part object. + :param real: Size along X. + :param real: Size along Y. + :param real: Size along Z. + :return: Result object. Result """""" @@ -65,8 +66,14 @@ Input fields: - **Point 1** and **Point 2** define diagonal points of the box selected in 3D OCC viewer or object browser. -**TUI Command**: *model.addBox(Part_doc, point1, point2)* +**TUI Command**: + +.. py:function:: model.addBox(Part_doc, point1, point2) + :param part: The current part object. + :param object: First vertex of diagonal. + :param object: Second vertex of diagonal. + :return: Result object. **Arguments**: Part + 2 selected points (opposite vertices of the box) Result diff --git a/src/PrimitivesPlugin/doc/coneFeature.rst b/src/PrimitivesPlugin/doc/coneFeature.rst index beb1f612f..a2937f9df 100644 --- a/src/PrimitivesPlugin/doc/coneFeature.rst +++ b/src/PrimitivesPlugin/doc/coneFeature.rst @@ -1,3 +1,4 @@ +.. |Cone_button.icon| image:: images/Cone_button.png Cone ==== @@ -7,13 +8,7 @@ Cone feature creates a cone solid. To create a Cone in the active part: #. select in the Main Menu *Primitives - > Cone* item or -#. click **Cone** button in the toolbar - -.. image:: images/Cone_button.png - :align: center - -.. centered:: - **Cone** button +#. click |Cone_button.icon| **Cone** button in the toolbar The following property panel appears. @@ -32,9 +27,17 @@ Input fields: - **Top radius**; - **Height**. -**TUI Command**: *model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height)* +**TUI Command**: + +.. py:function:: model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height) -**Arguments**: Part + 1 vertex + 1 vector + 3 real values (base and top radii, heght). + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius 1. + :param real: Radius 2. + :param real: Height. + :return: Result object. Result """""" diff --git a/src/PrimitivesPlugin/doc/cylinderFeature.rst b/src/PrimitivesPlugin/doc/cylinderFeature.rst index 7a09ffd35..6cd120ab4 100644 --- a/src/PrimitivesPlugin/doc/cylinderFeature.rst +++ b/src/PrimitivesPlugin/doc/cylinderFeature.rst @@ -1,3 +1,4 @@ +.. |Cylinder_button.icon| image:: images/Cylinder_button.png Cylinder ======== @@ -7,13 +8,7 @@ Cylinder feature creates a cylinder solid. To create a Cylinder in the active part: #. select in the Main Menu *Primitives - > Cylinder* item or -#. click **Cylinder** button in the toolbar - -.. image:: images/Cylinder_button.png - :align: center - -.. centered:: - **Cylinder** button +#. click |Cylinder_button.icon| **Cylinder** button in the toolbar There are 2 algorithms for creation of a Cylinder: @@ -42,9 +37,16 @@ Input fields: - **Radius**; - **Height**. -**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height)* +**TUI Commands**: + +.. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height) -**Arguments**: Part + 1 vertex +1 vector + 2 real values (radius, height). + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius. + :param real: Height. + :return: Result object. Result """""" @@ -70,9 +72,17 @@ Portion of cylinder Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder. -**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)* +**TUI Commands**: + +.. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle) -**Arguments**: 1 Part + 1 vertex +1 vector + 3 real values (radius, height and angle). + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius. + :param real: Height. + :param real: Angle. + :return: Result object. Result """""" diff --git a/src/PrimitivesPlugin/doc/sphereFeature.rst b/src/PrimitivesPlugin/doc/sphereFeature.rst index d7e1067a3..0050ffb7d 100644 --- a/src/PrimitivesPlugin/doc/sphereFeature.rst +++ b/src/PrimitivesPlugin/doc/sphereFeature.rst @@ -1,3 +1,4 @@ +.. |Sphere_button.icon| image:: images/Sphere_button.png Sphere ====== @@ -7,13 +8,7 @@ Sphere feature creates a sphere solid. To create a Sphere in the active part: #. select in the Main Menu *Primitives - > Sphere* item or -#. click **Sphere** button in the toolbar - -.. image:: images/Sphere_button.png - :align: center - -.. centered:: - **Sphere** button +#. click |Sphere_button.icon| **Sphere** button in the toolbar The following property panel appears. @@ -28,9 +23,14 @@ Input fields: - **Point** defines the center of the sphere selected in 3D OCC viewer or object browser; - **Radius** defines the radius. -**TUI Command**: *model.addSphere(Part_doc, Point, Radius)*. +**TUI Command**: + +.. py:function:: model.addSphere(Part_doc, Point, Radius) -**Arguments**: Part + 1 vertex + 1 real value (radius). + :param part: The current part object. + :param object: Vertex. + :param real: Radius. + :return: Result object. Result """""" diff --git a/src/PrimitivesPlugin/doc/torusFeature.rst b/src/PrimitivesPlugin/doc/torusFeature.rst index e9579981b..31f59fc6a 100644 --- a/src/PrimitivesPlugin/doc/torusFeature.rst +++ b/src/PrimitivesPlugin/doc/torusFeature.rst @@ -1,3 +1,4 @@ +.. |Torus_button.icon| image:: images/Torus_button.png Torus ===== @@ -7,13 +8,7 @@ Torus feature creates a torus solid. To create a Torus in the active part: #. select in the Main Menu *Primitives - > Torus* item or -#. click **Torus** button in the toolbar - -.. image:: images/Torus_button.png - :align: center - -.. centered:: - **Torus** button +#. click |Torus_button.icon| **Torus** button in the toolbar The following property panel appears. @@ -31,9 +26,16 @@ Input fields: - **Radius**; - **Ring radius**. -**TUI Command**: *model.addTorus(Part_doc, Point, Axis, Radius1, Radius2)* +**TUI Command**: + +.. py:function:: model.addTorus(Part_doc, Point, Axis, Radius1, Radius2) -**Arguments**: Part + 1 vertex + 1 vector + 2 real values (first and second radii). + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius 1. + :param real: Radius 2. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/SketchPlugin.rst b/src/SketchPlugin/doc/SketchPlugin.rst index 627ca479a..ce7b6fd19 100644 --- a/src/SketchPlugin/doc/SketchPlugin.rst +++ b/src/SketchPlugin/doc/SketchPlugin.rst @@ -1,5 +1,6 @@ .. _sketchPlugin: +.. |SketchButton.icon| image:: images/SketchButton.png Sketch plug-in @@ -19,13 +20,7 @@ Sketch can be created in the active part or in a partset (if there is no active To create a Sketch: #. select in the Main Menu *Sketch - > Sketch* item or -#. click **Sketch** button in Sketch toolbar: - -.. image:: images/SketchButton.png - :align: center - -.. centered:: - **Sketch** button +#. click |SketchButton.icon| **Sketch** button in Sketch toolbar: First define a plane for the sketch: @@ -68,9 +63,13 @@ The Result of operation will be a COMPOUND. In the object tree, Result node is l The Name is assigned automatically: **Sketch_1**, **Sketch_2**, ... both for Feature and Result. -**TUI Command**: *Sketch_1 = model.addSketch(PartOrPartSet, plane)* +**TUI Command**: + +.. py:function:: model.addSketch(PartOrPartSet, plane) -**Arguments**: Part or PartSet + plane. + :param part: The current part object. + :param object: A plane. + :return: Result object. .. _sketch_objects: diff --git a/src/SketchPlugin/doc/angleFeature.rst b/src/SketchPlugin/doc/angleFeature.rst index 6db160c07..0847e2006 100644 --- a/src/SketchPlugin/doc/angleFeature.rst +++ b/src/SketchPlugin/doc/angleFeature.rst @@ -1,3 +1,4 @@ +.. |angle_constr.icon| image:: images/angle_constr.png Angle constraint ================ @@ -10,13 +11,7 @@ Angle constraint fixes the angle between two lines. To create an 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 +#. click |angle_constr.icon| **Angle** button in Sketch toolbar: Property panel: @@ -66,13 +61,16 @@ When creating the constraint, after selection of two lines at the first time: .. centered:: Angle input in the view -**TUI Command**: +**TUI Commands**: -- *Sketch_1.setAngle(Line1, Line2, Value)* -- *Sketch_1.setAngleComplementary(Line1, Line2, Value)* -- *Sketch_1.setAngleBackward(Line1, Line2, Value)* +.. py:function:: Sketch_1.setAngle(Line1, Line2, Value) +.. py:function:: Sketch_1.setAngleComplementary(Line1, Line2, Value) +.. py:function:: Sketch_1.setAngleBackward(Line1, Line2, Value) -**Arguments**: 2 lines + angle value + :param object: Line 1. + :param object: Line 2. + :param real: Value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/arcFeature.rst b/src/SketchPlugin/doc/arcFeature.rst index c63955cc9..9139ea4db 100644 --- a/src/SketchPlugin/doc/arcFeature.rst +++ b/src/SketchPlugin/doc/arcFeature.rst @@ -1,3 +1,4 @@ +.. |arc.icon| image:: images/arc.png Arc === @@ -7,13 +8,7 @@ Arc feature creates an arc segment in the current Sketch. To add a new Arc to the Sketch: #. select in the Main Menu *Sketch - > Arc* item or -#. click **Arc** button in Sketch toolbar: - -.. image:: images/arc.png - :align: center - -.. centered:: - **Arc** button +#. click |arc.icon| **Arc** button in Sketch toolbar: There are 3 algorithms for creation of an Arc: @@ -42,9 +37,18 @@ and finally move the mouse and click a third time to set the last passed point. - When entering an end point by selecting a segment, a Coincident constraint is created. - When entering an end point, only segments are selectable. -**TUI Command**: *Sketch_1.addArc(CenterX, CenterY, StartX, StartY, EndX, EndY, Inversed)* +**TUI Command**: -**Arguments**: 7 values (coordinates of the center, the start, the end, inversed flag (if true - build arc from end to start)). +.. py:function:: Sketch_1.addArc(CenterX, CenterY, StartX, StartY, EndX, EndY, Inversed) + + :param real: Center X. + :param real: Center Y. + :param real: Start X. + :param real: Start Y. + :param real: End X. + :param real: End Y. + :param boolean: Is inversed. + :return: Result object. By three points """"""""""""""" @@ -59,9 +63,17 @@ and finally move the mouse and click a third time to set the passed point. - When entering a passing point by selecting a point, a Coincident constraint is created. - When entering a passing point by selecting a segment, a Tangent constraint is created. -**TUI Command**: *Sketch_1.addArc(StartX, StartY, EndX, EndY, PassedX, PassedY)* +**TUI Command**: + +.. py:function:: Sketch_1.addArc(StartX, StartY, EndX, EndY, PassedX, PassedY) -**Arguments**: 6 values (coordinates of the start, end and passed points). + :param real: Start X. + :param real: Start Y. + :param real: End X. + :param real: End Y. + :param real: Passed X. + :param real: Passed Y. + :return: Result object. By tangent point and point """""""""""""""""""""""""" @@ -76,9 +88,15 @@ The tangent point by itself is a start point. The edge on which it lies will be - When entering an end point by selecting a segment, a Coincident constraint is created. - When entering an end point, only segments are selectable. -**TUI Command**: *Sketch_1.addArc(TangetPoint, EndX, EndY, Inversed)* +**TUI Command**: + +.. py:function:: Sketch_1.addArc(TangetPoint, EndX, EndY, Inversed) -**Arguments**: 4 values (reference to tangent point, coordinates of end point, inversed flag (if true - build arc from end to start)). + :param object: Tanget Point. + :param real: End X. + :param real: End Y. + :param boolean: Is inversed. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/circleFeature.rst b/src/SketchPlugin/doc/circleFeature.rst index 8752d00a6..1db829331 100644 --- a/src/SketchPlugin/doc/circleFeature.rst +++ b/src/SketchPlugin/doc/circleFeature.rst @@ -1,3 +1,4 @@ +.. |circle.icon| image:: images/circle.png Circle ====== @@ -7,13 +8,7 @@ The feature Circle creates a circle in the current Sketch. To add a new Circle to the Sketch: #. select in the Main Menu *Sketch - > Circle* item or -#. click **Circle** button in Sketch toolbar: - -.. image:: images/circle.png - :align: center - -.. centered:: - **Circle** button +#. click |circle.icon| **Circle** button in Sketch toolbar: There are 2 algorithms for creation of a Circle: @@ -37,9 +32,15 @@ Click in the view once to set the center point, then move the mouse and click a - When entering a passing point by selecting a point, a Coincident constraint is also created. - When entering a passing point by selecting a segment, a Tangent constraint is created. -**TUI Command**: *Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY)* +**TUI Command**: + +.. py:function:: Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY) -**Arguments**: 4 values (coordinates of the center and the passed point). + :param real: Start X. + :param real: Start Y. + :param real: Passed X. + :param real: Passed Y. + :return: Result object. By three points """"""""""""""" @@ -53,9 +54,17 @@ and finally move the mouse and click a third time to set the last passed point. - When entering a passing point by selecting a point, a Coincident constraint is created. - When entering a passing point by selecting a segment, a Tangent constraint is created. -**TUI Command**: *Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3)* +**TUI Command**: + +.. py:function:: Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3) -**Arguments**: 6 values (coordinates of three points). + :param real: Start X. + :param real: Start Y. + :param real: Passed X. + :param real: Passed Y. + :param real: End X. + :param real: End Y. + :return: Result object. Property panel in edition context """"""""""""""""""""""""""""""""" diff --git a/src/SketchPlugin/doc/coincedentFeature.rst b/src/SketchPlugin/doc/coincedentFeature.rst index 48aaf291e..467bea9e9 100644 --- a/src/SketchPlugin/doc/coincedentFeature.rst +++ b/src/SketchPlugin/doc/coincedentFeature.rst @@ -1,4 +1,5 @@ .. _sketchCoincident: +.. |coincedence.icon| image:: images/coincedence.png Coincident constraint ===================== @@ -8,13 +9,7 @@ Coincident constraint forces two points to be coincident, or one point to lie on To create a Coincident constraint 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 +#. click |coincedence.icon| **Coincident** button in Sketch toolbar: Property panel: @@ -30,9 +25,13 @@ Note that one of two objects should be a point (i.e. a point, a line or an arc e After the objects are selected, the point is highlighted in yellow in the view. -**TUI Command**: *Sketch_1.setCoincident(Object1, Object2)* +**TUI Command**: + +.. py:function:: 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) + :param object: First object. + :param object: Second object. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/collinearFeature.rst b/src/SketchPlugin/doc/collinearFeature.rst index 91be05197..9e4962fea 100644 --- a/src/SketchPlugin/doc/collinearFeature.rst +++ b/src/SketchPlugin/doc/collinearFeature.rst @@ -1,3 +1,4 @@ +.. |collinear.icon| image:: images/collinear.png Collinear constraint ==================== @@ -7,13 +8,7 @@ Collinear constraint forces lines to be collinear. To create a Collinear constraint 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:: - **Collinear** button +#. click |collinear.icon| **Collinear** button in Sketch toolbar: Property panel: @@ -28,9 +23,13 @@ Input fields: | After the lines are selected, they are translated to become collinear. | The lines are marked with a special sign. -**TUI Command**: *Sketch_1.setCollinear(Line1, Line2)* +**TUI Command**: + +.. py:function:: Sketch_1.setCollinear(Line1, Line2) -**Arguments**: 2 line objects + :param object: First object. + :param object: Second object. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/distanceFeature.rst b/src/SketchPlugin/doc/distanceFeature.rst index 9f5515528..72e655ff0 100644 --- a/src/SketchPlugin/doc/distanceFeature.rst +++ b/src/SketchPlugin/doc/distanceFeature.rst @@ -1,3 +1,4 @@ +.. |distance.icon| image:: images/distance.png Distance constraint =================== @@ -9,13 +10,7 @@ The constraint can be defined between such objects as point, line, line or arc e To create a Distance constraint in the active Sketch: #. select in the Main Menu *Sketch - > Distance* item or -#. click **Distance** button in Sketch toolbar: - -.. image:: images/distance.png - :align: center - -.. centered:: - **Distance** button +#. click |distance.icon| **Distance** button in Sketch toolbar: Property panel: @@ -54,9 +49,15 @@ When creating a constraint after selection of two objects for the first time: .. centered:: Distance input in the view -**TUI Command**: *Sketch_1.setDistance(FirstObject, SecondObject, Value, KeepOrientation)* +**TUI Command**: + +.. py:function:: Sketch_1.setDistance(FirstObject, SecondObject, Value, KeepOrientation) -**Arguments**: 2 objects + distance value + keep orientation flag + :param object: First object. + :param object: Second object. + :param real: Value. + :param boolean: Keep orientation flag. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/equalFeature.rst b/src/SketchPlugin/doc/equalFeature.rst index 222672d45..a0305cb97 100644 --- a/src/SketchPlugin/doc/equalFeature.rst +++ b/src/SketchPlugin/doc/equalFeature.rst @@ -1,4 +1,5 @@ .. _sketchEqual: +.. |equal.icon| image:: images/equal.png Equal constraint ================ @@ -9,13 +10,7 @@ Equal constraint To create an Equal constraint 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 +#. click |equal.icon| **Equal** button in Sketch toolbar: Property panel: @@ -32,9 +27,13 @@ Note that a line can 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)* +**TUI Command**: + +.. py:function:: Sketch_1.setEqual(Object1, Object2) -**Arguments**: 2 objects (2 lines, 2 arcs, 2 circles or circle and arc) + :param object: First object. + :param object: Second object. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/filletFeature.rst b/src/SketchPlugin/doc/filletFeature.rst index 75640e2ad..8067285c5 100644 --- a/src/SketchPlugin/doc/filletFeature.rst +++ b/src/SketchPlugin/doc/filletFeature.rst @@ -1,3 +1,4 @@ +.. |fillet.icon| image:: images/fillet.png Fillet ====== @@ -8,13 +9,7 @@ Fillet To create a Fillet in the active Sketch: #. select in the Main Menu *Sketch - > Fillet* item or -#. click **Fillet** button in Sketch toolbar: - -.. image:: images/fillet.png - :align: center - -.. centered:: - **Fillet** button +#. click |fillet.icon| **Fillet** button in Sketch toolbar: Property panel: @@ -32,13 +27,16 @@ After the point is selected, Fillet preview appears in the view. **TUI Command**: -- *Sketch_1.setFillet(Point)* +.. py:function:: Sketch_1.setFillet(Point) - **Arguments**: coincident point + :param object: Coincident point. + :return: Result object. -- *Sketch_1.setFilletWithRadius(Point, Radius)* +.. py:function:: Sketch_1.setFilletWithRadius(Point, Radius) - **Arguments**: coincident point and fillet radius + :param object: Coincident point. + :param real: Radius. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/fixedFeature.rst b/src/SketchPlugin/doc/fixedFeature.rst index 894cae019..2b238d0dc 100644 --- a/src/SketchPlugin/doc/fixedFeature.rst +++ b/src/SketchPlugin/doc/fixedFeature.rst @@ -1,3 +1,4 @@ +.. |fixed.icon| image:: images/fixed.png Fixed constraint ================ @@ -9,13 +10,7 @@ The constraint can be defined for such objects as point, line, line or arc end p To create a 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 +#. click |fixed.icon| **Fixed** button in Sketch toolbar: Property panel: @@ -34,9 +29,12 @@ Selection rules: - 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)* +**TUI Command**: + +.. py:function:: Sketch_1.setFixed(Object) -**Arguments**: 1 object + :param object: An object. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/horizontalDistFeature.rst b/src/SketchPlugin/doc/horizontalDistFeature.rst index a62cc065f..68bc3b811 100644 --- a/src/SketchPlugin/doc/horizontalDistFeature.rst +++ b/src/SketchPlugin/doc/horizontalDistFeature.rst @@ -1,3 +1,4 @@ +.. |distance_h.icon| image:: images/distance_h.png Horizontal distance constraint ============================== @@ -9,13 +10,7 @@ The constraint can be defined between two points such as point object, line or a To create a Horizontal Distance constraint in the active Sketch: #. select in the Main Menu *Sketch - > Horizontal Distance* item or -#. click **Horizontal Distance** button in Sketch toolbar: - -.. image:: images/distance_h.png - :align: center - -.. centered:: - **Horizontal Distance** button +#. click |distance_h.icon| **Horizontal Distance** button in Sketch toolbar: Property panel: @@ -53,9 +48,14 @@ When creating the constraint, after selection of two objects for the first time: .. centered:: Horizontal Distance input in the view -**TUI Command**: *Sketch_1.setHorizontalDistance(FirstObject, SecondObject, Value)* +**TUI Command**: + +.. py:function:: Sketch_1.setHorizontalDistance(FirstObject, SecondObject, Value) -**Arguments**: 2 objects + horizontal distance value + :param object: An object 1. + :param object: An object 2. + :param real: Value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/horizontalFeature.rst b/src/SketchPlugin/doc/horizontalFeature.rst index dfab517bb..4974c939a 100644 --- a/src/SketchPlugin/doc/horizontalFeature.rst +++ b/src/SketchPlugin/doc/horizontalFeature.rst @@ -1,3 +1,4 @@ +.. |horisontal.icon| image:: images/horisontal.png Horizontal constraint ===================== @@ -7,13 +8,7 @@ Horizontal constraint fixes lines as parallel to the horizontal axis. To create a 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:: - **Horizontal** button +#. click |horisontal.icon| **Horizontal** button in Sketch toolbar: Property panel: @@ -27,9 +22,12 @@ Input fields: | After the line is selected it becomes parallel to the horizontal axis in the view. | **H** sign is added above the line. -**TUI Command**: *Sketch_1.setHorizontal(LineObject)* +**TUI Command**: + +.. py:function:: Sketch_1.setHorizontal(LineObject) -**Arguments**: 1 line object + :param object: A line. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/intersectionFeature.rst b/src/SketchPlugin/doc/intersectionFeature.rst index 41abaeb42..4361975d0 100644 --- a/src/SketchPlugin/doc/intersectionFeature.rst +++ b/src/SketchPlugin/doc/intersectionFeature.rst @@ -1,3 +1,4 @@ +.. |intersection.icon| image:: images/intersection.png Intersection ============ @@ -8,13 +9,7 @@ Intersection To create an Intersection in the active Sketch: #. select in the Main Menu *Sketch - > Intersection* item or -#. click **Intersection** button in Sketch toolbar: - -.. image:: images/intersection.png - :align: center - -.. centered:: - **Intersection** button +#. click |intersection.icon| **Intersection** button in Sketch toolbar: Property panel: @@ -29,15 +24,19 @@ Input fields: - **Object** is the 3D edge to intersect with the sketch plane. - **Include into the sketch result** option defines whether to include the intersection point into the sketch result. -**TUI Command**: +**TUI Commands**: -- *Sketch_1.addIntersectionPoint(Edge, IncludeIntoResult)* +.. py:function:: Sketch_1.addIntersectionPoint(Edge, IncludeIntoResult)* - **Arguments**: Edge and include into the result flag + :param object: An edge. + :param boolean: Include into the result flag. + :return: Result object. -- *Sketch_1.addIntersectionPoint(EdgeName, IncludeIntoResult)* +.. py:function:: Sketch_1.addIntersectionPoint(EdgeName, IncludeIntoResult)* - **Arguments**: Edge name and include into the result flag + :param object: An edge name. + :param boolean: Include into the result flag. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/lengthFeature.rst b/src/SketchPlugin/doc/lengthFeature.rst index 5c654f2a5..939a98ee1 100644 --- a/src/SketchPlugin/doc/lengthFeature.rst +++ b/src/SketchPlugin/doc/lengthFeature.rst @@ -1,4 +1,5 @@ .. _sketchLength: +.. |length.icon| image:: images/length.png Length constraint ================= @@ -8,13 +9,7 @@ Length constraint fixes the length of lines, such as standalone line or rectangl To create a 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 +#. click |length.icon| **Length** button in Sketch toolbar: Property panel: @@ -51,9 +46,13 @@ When creating the constraint, after selection of a line for the first time: .. centered:: Length input in the view -**TUI Command**: *Sketch_1.setLength(LineObject, Value)* +**TUI Command**: + +.. py:function:: Sketch_1.setLength(LineObject, Value) -**Arguments**: line + length value + :param object: A line. + :param real: Length value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/lineFeature.rst b/src/SketchPlugin/doc/lineFeature.rst index 1f927a35c..a45094e76 100644 --- a/src/SketchPlugin/doc/lineFeature.rst +++ b/src/SketchPlugin/doc/lineFeature.rst @@ -1,4 +1,5 @@ .. _sketchLine: +.. |line.icon| image:: images/line.png Line ==== @@ -8,13 +9,7 @@ Line feature creates a line segment by two points in the current Sketch. To add a new Line to the Sketch: #. select in the Main Menu *Sketch - > Line* item or -#. click **Line** button in Sketch toolbar: - -.. image:: images/line.png - :align: center - -.. centered:: - **Line** button +#. click |line.icon| **Line** button in Sketch toolbar: The following property panel appears: @@ -28,9 +23,15 @@ Pick 2 points (start and end) in the view to create a Line. If an existing objec Start and end points coordinates are displayed in the property panel. -**TUI Command**: *Sketch_1.addLine(X1, Y1, X2, Y2)* +**TUI Command**: + +.. py:function:: Sketch_1.addLine(X1, Y1, X2, Y2)* -**Arguments**: 4 values (coordinates of the start and end points). + :param real: X1 value. + :param real: Y1 value. + :param real: X2 value. + :param real: Y2 value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/middleFeature.rst b/src/SketchPlugin/doc/middleFeature.rst index a18747179..01a536a9c 100644 --- a/src/SketchPlugin/doc/middleFeature.rst +++ b/src/SketchPlugin/doc/middleFeature.rst @@ -1,3 +1,4 @@ +.. |middlepoint.icon| image:: images/middlepoint.png Middle point constraint ======================= @@ -7,13 +8,7 @@ Middle point constraint forces a point to middle of a line. To create a 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 +#. click |middlepoint.icon| **Middle point** button in Sketch toolbar: Property panel: @@ -30,9 +25,13 @@ Note that one of two objects should be a line and the other a point (i.e. a poin | After the objects are selected, the point is moved to the middle of the line. | The middle points are marked with a special sign. -**TUI Command**: *Sketch_1.setMiddlePoint(Point, Line)* +**TUI Command**: + +.. py:function:: Sketch_1.setMiddlePoint(Point, Line) -**Arguments**: 2 objects (the first is a point, the second one is a line) + :param object: A point. + :param object: A line. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/mirrorFeature.rst b/src/SketchPlugin/doc/mirrorFeature.rst index da5ec12f3..872c5ab1f 100644 --- a/src/SketchPlugin/doc/mirrorFeature.rst +++ b/src/SketchPlugin/doc/mirrorFeature.rst @@ -1,3 +1,4 @@ +.. |mirror.icon| image:: images/mirror.png Mirror copy =========== @@ -7,13 +8,7 @@ Mirror copy operation mirrors sketch entities across a line. To create a Mirror copy in the active Sketch: #. select in the Main Menu *Sketch - > Mirror copy* item or -#. click **Mirror copy** button in Sketch toolbar: - -.. image:: images/mirror.png - :align: center - -.. centered:: - **Mirror copy** button +#. click |mirror.icon| **Mirror copy** button in Sketch toolbar: Property panel: @@ -28,9 +23,13 @@ Input fields: - **Mirror line** is the mirror line selected in the view. - **Segments** is the list of segments (lines, circles, arcs) selected in the view. -**TUI Command**: *Sketch_1.addMirror(MirrorLine, Objects)* +**TUI Command**: + +.. py:function:: Sketch_1.addMirror(MirrorLine, Objects) -**Arguments**: Mirror line and a list of objects + :param object: A mirror line. + :param listg: A list of objects. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/parallelFeature.rst b/src/SketchPlugin/doc/parallelFeature.rst index 8e952dedb..556df5676 100644 --- a/src/SketchPlugin/doc/parallelFeature.rst +++ b/src/SketchPlugin/doc/parallelFeature.rst @@ -1,3 +1,4 @@ +.. |parallel.icon| image:: images/parallel.png Parallel constraint =================== @@ -7,13 +8,7 @@ Parallel constraint fixes two lines as parallel to one another. To create a Parallel constraint 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:: - **Parallel** button +#. click |parallel.icon| **Parallel** button in Sketch toolbar: Property panel: @@ -27,9 +22,13 @@ Input fields: After the lines are selected **||** sign will be added to each of them in the view. -**TUI Command**: *Sketch_1.setParallel(Line1, Line2)* +**TUI Command**: + +.. py:function:: Sketch_1.setParallel(Line1, Line2) -**Arguments**: 2 line objects + :param object: Line 1. + :param object: Line 2. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/perpendicularFeature.rst b/src/SketchPlugin/doc/perpendicularFeature.rst index c46e8b084..0cf532283 100644 --- a/src/SketchPlugin/doc/perpendicularFeature.rst +++ b/src/SketchPlugin/doc/perpendicularFeature.rst @@ -1,4 +1,5 @@ .. _sketchPerpendicular: +.. |perpendicular.icon| image:: images/perpendicular.png Perpendicular constraint ======================== @@ -8,13 +9,7 @@ Perpendicular constraint fixes two lines at 90 degrees to one another. To create a Perpendicular constraint 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:: - **Perpendicular** button +#. click |perpendicular.icon| **Perpendicular** button in Sketch toolbar: Property panel: @@ -28,9 +23,13 @@ Input fields: After the lines are selected, a special sign will be added to each of them in the view. -**TUI Command**: *Sketch_1.setPerpendicular(Line1, Line2)* +**TUI Command**: + +.. py:function:: Sketch_1.setPerpendicular(Line1, Line2) -**Arguments**: 2 line objects + :param object: Line 1. + :param object: Line 2. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/pointFeature.rst b/src/SketchPlugin/doc/pointFeature.rst index fa46c2096..d8865b9c7 100644 --- a/src/SketchPlugin/doc/pointFeature.rst +++ b/src/SketchPlugin/doc/pointFeature.rst @@ -1,3 +1,4 @@ +.. |point.icon| image:: images/point.png Point ===== @@ -7,13 +8,7 @@ Point feature creates a point in the current Sketch. To add a new Point to the Sketch: #. select in the Main Menu *Sketch - > Point* item or -#. click **Point** button in Sketch toolbar: - -.. image:: images/point.png - :align: center - -.. centered:: - **Point** button +#. click |point.icon| **Point** button in Sketch toolbar: The following property panel appears: @@ -28,9 +23,13 @@ the point will be created automatically. The point coordinates are displayed in the property panel. -**TUI Command**: *Sketch_1.addPoint(X, Y)* +**TUI Command**: + +.. py:function:: Sketch_1.addPoint(X, Y) -**Arguments**: 2 values (coordinates on the Sketch plane). + :param real: X value. + :param real: Y value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/projectionFeature.rst b/src/SketchPlugin/doc/projectionFeature.rst index a1802206f..587e05ab5 100644 --- a/src/SketchPlugin/doc/projectionFeature.rst +++ b/src/SketchPlugin/doc/projectionFeature.rst @@ -1,3 +1,4 @@ +.. |projection.icon| image:: images/projection.png Projection ========== @@ -8,13 +9,7 @@ Projection To create a Projection in the active Sketch: #. select in the Main Menu *Sketch - > Projection* item or -#. click **Projection** button in Sketch toolbar: - -.. image:: images/projection.png - :align: center - -.. centered:: - **Projection** button +#. click |projection.icon| **Projection** button in Sketch toolbar: Property panel: @@ -29,15 +24,19 @@ Input fields: - **Object** is the 3D object (edge or vertex) to project onto the sketch plane. - **Include into the sketch result** option defines whether to include the projection line into the sketch result. -**TUI Command**: +**TUI Commands**: -- *Sketch_1.addProjection(EdgeOrVertex, IncludeIntoResult)* +.. py:function:: Sketch_1.addProjection(EdgeOrVertex, IncludeIntoResult) - **Arguments**: edge or vertex and include into the result flag + :param object: Edge or vertex. + :param boolean: Include into the result flag. + :return: Result object. -- *Sketch_1.addProjection(EdgeOrVertexName, IncludeIntoResult)* +.. py:function:: Sketch_1.addProjection(EdgeOrVertexName, IncludeIntoResult) - **Arguments**: edge or vertex name and include into the result flag + :param object: Edge or vertex name. + :param boolean: Include into the result flag. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/radiusFeature.rst b/src/SketchPlugin/doc/radiusFeature.rst index 561a597e2..2b8840a44 100644 --- a/src/SketchPlugin/doc/radiusFeature.rst +++ b/src/SketchPlugin/doc/radiusFeature.rst @@ -1,3 +1,4 @@ +.. |radius_constr.icon| image:: images/radius_constr.png Radius constraint ================= @@ -7,13 +8,7 @@ Radius constraint fixes the radius of circle or arc. To create a 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 +#. click |radius_constr.icon| **Radius** button in Sketch toolbar: Property panel: @@ -50,9 +45,13 @@ When creating the constraint, after selection of the circle or arc at the first .. centered:: Radius input in the view -**TUI Command**: *Sketch_1.setRadius(CircleOrArc, Value)* +**TUI Command**: + +.. py:function:: Sketch_1.setRadius(CircleOrArc, Value) -**Arguments**: circle or arc circumference object + radius value + :param object: Circle or arc. + :param real: Radius. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/rectangleFeature.rst b/src/SketchPlugin/doc/rectangleFeature.rst index 8181e58b4..963c04bd0 100644 --- a/src/SketchPlugin/doc/rectangleFeature.rst +++ b/src/SketchPlugin/doc/rectangleFeature.rst @@ -1,4 +1,5 @@ - .. _create_sketch_rectangle: +.. _create_sketch_rectangle: +.. |rectangle.icon| image:: images/rectangle.png Rectangle ========= @@ -11,13 +12,7 @@ Two lines have Vertical constraint and two others have Horizontal constraint. To add a new Rectangle to the Sketch: #. select in the Main Menu *Sketch - > Rectangle* item or -#. click **Rectangle** button in Sketch toolbar: - -.. image:: images/rectangle.png - :align: center - -.. centered:: - **Rectangle** button +#. click |rectangle.icon| **Rectangle** button in Sketch toolbar: The following property panel appears: @@ -32,9 +27,15 @@ If an existing object is clicked, a constraint for the point will be created aut Start and end points coordinates are displayed in the property panel. -**TUI Command**: *Sketch_1.addRectangle(X1, Y1, X2, Y2)* +**TUI Command**: + +.. py:function:: Sketch_1.addRectangle(X1, Y1, X2, Y2) -**Arguments**: 4 values (coordinates of the start and end points). + :param real: X1 value. + :param real: Y1 value. + :param real: X2 value. + :param real: Y2 value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/rotationFeature.rst b/src/SketchPlugin/doc/rotationFeature.rst index 095b9a777..14f59eaea 100644 --- a/src/SketchPlugin/doc/rotationFeature.rst +++ b/src/SketchPlugin/doc/rotationFeature.rst @@ -1,4 +1,5 @@ .. _sketchAngularCopy: +.. |rotate.icon| image:: images/rotate.png Angular copy ============ @@ -8,13 +9,7 @@ Angular copy operation creates one or multiple copies of the sketch entities by To create an Angular copy in the active Sketch: #. select in the Main Menu *Sketch - > Angular copy* item or -#. click **Angular copy** button in Sketch toolbar: - -.. image:: images/rotate.png - :align: center - -.. centered:: - **Angular copy** button +#. click |rotate.icon| **Angular copy** button in Sketch toolbar: Property panel: @@ -43,9 +38,17 @@ Input fields: - **Total number of objects** is the total number of objects including the original one. -**TUI Command**: *Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed)* +**TUI Command**: + +.. py:function:: Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed) -**Arguments**: list of objects + center point + angle + number of objects + full value flag + reversed flag + :param list: A list of objects. + :param object: Center point. + :param real: Angle. + :param integer: Number of objects. + :param boolean: Full value flag. + :param boolean: Reversed flag. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/sketchDrawer.rst b/src/SketchPlugin/doc/sketchDrawer.rst index f019f472d..5bd56bc94 100644 --- a/src/SketchPlugin/doc/sketchDrawer.rst +++ b/src/SketchPlugin/doc/sketchDrawer.rst @@ -1,4 +1,5 @@ - .. _create_sketch_drawer: +.. _create_sketch_drawer: +.. |SketchDrawer.icon| image:: images/SketchDrawer.png Sketch Drawer ========= @@ -14,13 +15,7 @@ able to remove the initial model, there are no references created by this featur To add a new Sketch Drawing: #. select in the Main Menu *Macros - > Sketch drawer* item or -#. click **Sketch drawer** button in Macros toolbar: - -.. image:: images/SketchDrawer.png - :align: center - -.. centered:: - **Sketch drawer** button +#. click |SketchDrawer.icon| **Sketch drawer** button in Macros toolbar: The following property panel appears: diff --git a/src/SketchPlugin/doc/splitFeature.rst b/src/SketchPlugin/doc/splitFeature.rst index d47cebba7..24d532c05 100644 --- a/src/SketchPlugin/doc/splitFeature.rst +++ b/src/SketchPlugin/doc/splitFeature.rst @@ -1,3 +1,4 @@ +.. |split.icon| image:: images/split.png Split ===== @@ -9,13 +10,7 @@ Split To create a Split in the active Sketch: #. select in the Main Menu *Sketch - > Split* item or -#. click **Split** button in Sketch toolbar: - -.. image:: images/split.png - :align: center - -.. centered:: - **Split** button +#. click |split.icon| **Split** button in Sketch toolbar: Property panel: @@ -37,9 +32,13 @@ The selected segment is highlighted in the view: .. centered:: The segment to split off -**TUI Command**: *Sketch_1.addSplit(Feature, PositionPoint)* +**TUI Command**: + +.. py:function:: Sketch_1.addSplit(Feature, PositionPoint) -**Arguments**: feature (line, arc or circle) and position point (a point on the segment to split off or closest to it) + :param object: Line, arc or circle. + :param object: Position point (a point on the segment to split off or closest to it). + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/tangentFeature.rst b/src/SketchPlugin/doc/tangentFeature.rst index 0c461b554..b4ca71dd5 100644 --- a/src/SketchPlugin/doc/tangentFeature.rst +++ b/src/SketchPlugin/doc/tangentFeature.rst @@ -1,3 +1,4 @@ +.. |tangent.icon| image:: images/tangent.png Tangent constraint ================== @@ -7,13 +8,7 @@ Tangent constraint fixes a circle (or an arc) and a line so that a line is tange To create a 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 +#. click |tangent.icon| **Tangent** button in Sketch toolbar: Property panel: @@ -29,9 +24,13 @@ Note that one of two objects should be a line. After the objects are selected, a special sign will be added close to the tangency point in the view. -**TUI Command**: *Sketch_1.setTangent(Line, CircleOrArc)* +**TUI Command**: + +.. py:function:: Sketch_1.setTangent(Line, CircleOrArc) -**Arguments**: 2 objects (the first is a line, the second one is a circle or an arc) + :param object: A line. + :param object: A circle or an arc. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/translationFeature.rst b/src/SketchPlugin/doc/translationFeature.rst index 23e376ed9..db2478fbd 100644 --- a/src/SketchPlugin/doc/translationFeature.rst +++ b/src/SketchPlugin/doc/translationFeature.rst @@ -1,3 +1,4 @@ +.. |translate.icon| image:: images/translate.png Linear copy =========== @@ -7,13 +8,7 @@ Linear copy operation creates one or multiple copies of the sketch entities alon To create a Linear copy in the active Sketch: #. select in the Main Menu *Sketch - > Linear copy* item or -#. click **Linear copy** button in Sketch toolbar: - -.. image:: images/translate.png - :align: center - -.. centered:: - **Linear copy** button +#. click |translate.icon| **Linear copy** button in Sketch toolbar: Property panel: @@ -40,9 +35,16 @@ Input fields: - **Total number of objects** is the total number of objects including the original one. -**TUI Command**: *Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue)* +**TUI Command**: + +.. py:function:: Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue) -**Arguments**: list of objects + start and end points + number of objects + full value flag + :param list: A list of objects. + :param object: Start point. + :param object: End point. + :param integer: Number of objects. + :param boolean: Full value flag. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/trimFeature.rst b/src/SketchPlugin/doc/trimFeature.rst index ee096cca4..cdb69caa5 100644 --- a/src/SketchPlugin/doc/trimFeature.rst +++ b/src/SketchPlugin/doc/trimFeature.rst @@ -1,3 +1,4 @@ +.. |trim.icon| image:: images/trim.png Trim ==== @@ -9,13 +10,7 @@ Trim To create a Trim in the active Sketch: #. select in the Main Menu *Sketch - > Trim* item or -#. click **Trim** button in Sketch toolbar: - -.. image:: images/trim.png - :align: center - -.. centered:: - **Trim** button +#. click |trim.icon| **Trim** button in Sketch toolbar: Property panel: @@ -37,8 +32,13 @@ The selected segment is highlighted in the view: .. centered:: The segment to remove -**TUI Command**: *Sketch_1.addTrim(Feature, PositionPoint)* +**TUI Command**: + +.. py:function:: Sketch_1.addTrim(Feature, PositionPoint) + :param object: Line, arc or circle. + :param object: Position point. + :return: Result object. **Arguments**: feature (line, arc or circle) and position point (a point on or closest to the segment to remove) Result diff --git a/src/SketchPlugin/doc/verticalDistFeature.rst b/src/SketchPlugin/doc/verticalDistFeature.rst index 7b978510b..dac116da2 100644 --- a/src/SketchPlugin/doc/verticalDistFeature.rst +++ b/src/SketchPlugin/doc/verticalDistFeature.rst @@ -1,3 +1,4 @@ +.. |distance_v.icon| image:: images/distance_v.png Vertical distance constraint ============================ @@ -9,13 +10,7 @@ The constraint can be defined between two points such as point object, line or a To create a Vertical Distance constraint in the active Sketch: #. select in the Main Menu *Sketch - > Vertical Distance* item or -#. click **Vertical Distance** button in Sketch toolbar: - -.. image:: images/distance_v.png - :align: center - -.. centered:: - **Vertical Distance** button +#. click |distance_v.icon| **Vertical Distance** button in Sketch toolbar: Property panel: @@ -53,9 +48,14 @@ When creating the constraint, after selection of two objects for the first time: .. centered:: Vertical Distance input in the view -**TUI Command**: *Sketch_1.setVerticalDistance(FirstObject, SecondObject, Value)* +**TUI Command**: + +.. py:function:: Sketch_1.setVerticalDistance(FirstObject, SecondObject, Value) -**Arguments**: 2 objects + vertical distance value + :param object: First object. + :param object: Second object. + :param real: Value. + :return: Result object. Result """""" diff --git a/src/SketchPlugin/doc/verticalFeature.rst b/src/SketchPlugin/doc/verticalFeature.rst index 29f0db1b5..69ad936ce 100644 --- a/src/SketchPlugin/doc/verticalFeature.rst +++ b/src/SketchPlugin/doc/verticalFeature.rst @@ -1,3 +1,4 @@ +.. |vertical.icon| image:: images/vertical.png Vertical constraint =================== @@ -7,13 +8,7 @@ Vertical constraint fixes lines as parallel to the vertical axis. To create a 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:: - **Vertical** button +#. click |vertical.icon| **Vertical** button in Sketch toolbar: Property panel: @@ -27,9 +22,12 @@ Input fields: | After the line is selected it becomes parallel to the vertical axis in the view. | **V** sign is added above the line. -**TUI Command**: *Sketch_1.setVertical(LineObject)* +**TUI Command**: + +.. py:function:: Sketch_1.setVertical(LineObject) -**Arguments**: 1 line object + :param object: A line. + :return: Result object. Result """"""