+.. |feature_compound.icon| image:: images/feature_compound.png
Compound
========
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:
**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
""""""
+.. |feature_compsolid.icon| image:: images/feature_compsolid.png
CompSolid
=========
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:
**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
""""""
+.. |feature_edge.icon| image:: images/feature_edge.png
Edge
====
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:
**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
""""""
**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
""""""
.. _buildFace:
+.. |feature_face.icon| image:: images/feature_face.png
Face
====
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:
**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
""""""
+.. |feature_filling.icon| image:: images/feature_filling.png
Filling
=======
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:
**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
""""""
+.. |feature_interpolation.icon| image:: images/feature_interpolation.png
Interpolation
=============
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:
**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
""""""
.. _buildPolyline:
+.. |feature_polyline.icon| image:: images/feature_polyline.png
Polyline
========
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.
- **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
""""""
+.. |feature_shell.icon| image:: images/feature_shell.png
Shell
=====
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:
**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
""""""
+.. |feature_solid.icon| image:: images/feature_solid.png
Solid
=====
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:
**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
""""""
+.. |feature_subshapes.icon| image:: images/feature_subshapes.png
Sub-shapes
==========
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.
- **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
""""""
+.. |feature_vertex.icon| image:: images/feature_vertex.png
Vertex
======
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:
**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
""""""
+.. |feature_wire.icon| image:: images/feature_wire.png
Wire
====
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:
**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
""""""
+.. |field.icon| image:: images/field.png
Field
=====
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.
- **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.
+.. |shape_group.icon| image:: images/shape_group.png
Group
=====
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.
- 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
""""""
+.. |geom_export.icon| image:: images/geom_export.png
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
+.. |axis_button.icon| image:: images/axis_button.png
Axis
====
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:
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
""""""
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.
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
""""""
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
""""""
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
""""""
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
""""""
+.. |plane_button.icon| image:: images/plane_button.png
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:
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
""""""
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
""""""
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
""""""
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
""""""
.. _constructionPoint:
+.. |point_button.icon| image:: images/point_button.png
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:
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
""""""
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
""""""
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
""""""
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
""""""
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
""""""
+.. |dump.icon| image:: images/dump.png
Dump
====
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:
+.. |export.icon| image:: images/export.png
Export
======
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:
**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
""""""
+.. |import.icon| image:: images/import.png
Import
======
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:
**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
""""""
.. _featureAngularCopy:
+.. |multirotation.icon| image:: images/multirotation.png
Angular copy
============
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.
- **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
""""""
+.. |bool_common.icon| image:: images/bool_common.png
+
Common
======
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:
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
""""""
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
""""""
.. _featureCut:
+.. |bool_cut.icon| image:: images/bool_cut.png
Cut
===
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:
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
""""""
+.. |extrusion_cut_btn.icon| image:: images/extrusion_cut_btn.png
Extrusion Cut
=============
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:
- **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
""""""
- **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
""""""
+.. |extrusion_btn.icon| image:: images/extrusion_btn.png
Extrusion
=========
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:
- **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
""""""
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
""""""
+.. |extrusion_fuse_btn.icon| image:: images/extrusion_fuse_btn.png
Extrusion Fuse
=============
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:
- **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
""""""
- **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
""""""
+.. |fillet.icon| image:: images/fillet.png
.. _featureFillet:
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:
- **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
""""""
- **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
""""""
+.. |bool_fuse.icon| image:: images/bool_fuse.png
Fuse
====
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:
- **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
""""""
- **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
""""""
+.. |fusion_faces.icon| image:: images/fusion_faces.png
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:
- **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
""""""
+.. |intersection_btn.icon| image:: images/intersection_btn.png
Intersection
============
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:
**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
""""""
+.. |multitranslation.icon| image:: images/multitranslation.png
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.
- **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
""""""
+.. |measurement.icon| image:: images/measurement.png
Measurement
===========
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:
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
- **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
------
- **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
-------------------
- **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
-----------------
- **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
+.. |partition_btn.icon| image:: images/partition_btn.png
Partition
=========
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:
**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
""""""
+.. |pipe.icon| image:: images/pipe.png
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:
- **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
""""""
- **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
""""""
- **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
""""""
+.. |placement_btn.icon| image:: images/placement_btn.png
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:
- 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
""""""
+.. |recover.icon| image:: images/recover.png
+
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:
- **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
""""""
- **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
""""""
+.. |remove_subshapes_btn.icon| image:: images/remove_subshapes_btn.png
Remove Sub-Shapes
=================
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:
- **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
- **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
+.. |revolution_cut_btn.icon| image:: images/revolution_cut_btn.png
Revolution Cut
==============
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:
- **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
""""""
- **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
""""""
+.. |revolution_btn.icon| image:: images/revolution_btn.png
Revolution
==========
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:
- **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
""""""
- **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
""""""
+.. |revolution_fuse_btn.icon| image:: images/revolution_fuse_btn.png
Revolution Fuse
===============
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:
- **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
""""""
- **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
""""""
.. _featureRotation:
+.. |rotation.icon| image:: images/rotation.png
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:
- **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
""""""
- **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
""""""
+.. |bool_smash.icon| image:: images/bool_smash.png
Smash
=====
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:
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
""""""
+.. |bool_split.icon| image:: images/bool_split.png
Split
=====
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:
- **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
""""""
+.. |symmetry.icon| image:: images/symmetry.png
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:
- **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
""""""
- **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
""""""
- **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
""""""
+.. |scale.icon| image:: images/scale.png
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:
- **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
""""""
- **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
""""""
.. _featureTranslation:
+.. |translation_vector_32x32.icon| image:: images/translation_vector_32x32.png
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
- **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
""""""
- **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
""""""
- **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
""""""
+.. |union_btn.icon| image:: images/union_btn.png
Union
=====
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:
**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
""""""
.. _parameters:
+.. |paper_roll.icon| image:: images/paper_roll.png
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:
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.
.. _parameter:
+.. |expression.icon| image:: images/expression.png
Create parameter
================
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.
**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.
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.
+.. |new_part.icon| image:: images/new_part.png
+.. |remove.icon| image:: images/remove.png
+.. |duplicate.icon| image:: images/duplicate.png
.. _partPlugin:
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
""""""
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
""""""
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
""""""
.. _box_feature:
+.. |box.icon| image:: images/box.png
Box
===
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:
- **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
""""""
- **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
+.. |Cone_button.icon| image:: images/Cone_button.png
Cone
====
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.
- **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
""""""
+.. |Cylinder_button.icon| image:: images/Cylinder_button.png
Cylinder
========
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:
- **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
""""""
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
""""""
+.. |Sphere_button.icon| image:: images/Sphere_button.png
Sphere
======
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.
- **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
""""""
+.. |Torus_button.icon| image:: images/Torus_button.png
Torus
=====
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.
- **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
""""""
.. _sketchPlugin:
+.. |SketchButton.icon| image:: images/SketchButton.png
Sketch plug-in
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:
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:
+.. |angle_constr.icon| image:: images/angle_constr.png
Angle constraint
================
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:
.. 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
""""""
+.. |arc.icon| image:: images/arc.png
Arc
===
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:
- 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
"""""""""""""""
- 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
""""""""""""""""""""""""""
- 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
""""""
+.. |circle.icon| image:: images/circle.png
Circle
======
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:
- 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
"""""""""""""""
- 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
"""""""""""""""""""""""""""""""""
.. _sketchCoincident:
+.. |coincedence.icon| image:: images/coincedence.png
Coincident constraint
=====================
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:
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
""""""
+.. |collinear.icon| image:: images/collinear.png
Collinear constraint
====================
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:
| 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
""""""
+.. |distance.icon| image:: images/distance.png
Distance constraint
===================
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:
.. 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
""""""
.. _sketchEqual:
+.. |equal.icon| image:: images/equal.png
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:
| 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
""""""
+.. |fillet.icon| image:: images/fillet.png
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:
**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
""""""
+.. |fixed.icon| image:: images/fixed.png
Fixed constraint
================
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:
- 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
""""""
+.. |distance_h.icon| image:: images/distance_h.png
Horizontal distance constraint
==============================
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:
.. 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
""""""
+.. |horisontal.icon| image:: images/horisontal.png
Horizontal constraint
=====================
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:
| 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
""""""
+.. |intersection.icon| image:: images/intersection.png
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:
- **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
""""""
.. _sketchLength:
+.. |length.icon| image:: images/length.png
Length constraint
=================
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:
.. 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
""""""
.. _sketchLine:
+.. |line.icon| image:: images/line.png
Line
====
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:
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
""""""
+.. |middlepoint.icon| image:: images/middlepoint.png
Middle point constraint
=======================
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:
| 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
""""""
+.. |mirror.icon| image:: images/mirror.png
Mirror copy
===========
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:
- **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
""""""
+.. |parallel.icon| image:: images/parallel.png
Parallel constraint
===================
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:
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
""""""
.. _sketchPerpendicular:
+.. |perpendicular.icon| image:: images/perpendicular.png
Perpendicular constraint
========================
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:
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
""""""
+.. |point.icon| image:: images/point.png
Point
=====
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:
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
""""""
+.. |projection.icon| image:: images/projection.png
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:
- **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
""""""
+.. |radius_constr.icon| image:: images/radius_constr.png
Radius constraint
=================
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:
.. 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
""""""
- .. _create_sketch_rectangle:
+.. _create_sketch_rectangle:
+.. |rectangle.icon| image:: images/rectangle.png
Rectangle
=========
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:
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
""""""
.. _sketchAngularCopy:
+.. |rotate.icon| image:: images/rotate.png
Angular copy
============
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:
- **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
""""""
- .. _create_sketch_drawer:
+.. _create_sketch_drawer:
+.. |SketchDrawer.icon| image:: images/SketchDrawer.png
Sketch Drawer
=========
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:
+.. |split.icon| image:: images/split.png
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:
.. 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
""""""
+.. |tangent.icon| image:: images/tangent.png
Tangent constraint
==================
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:
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
""""""
+.. |translate.icon| image:: images/translate.png
Linear copy
===========
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:
- **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
""""""
+.. |trim.icon| image:: images/trim.png
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:
.. 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
+.. |distance_v.icon| image:: images/distance_v.png
Vertical distance constraint
============================
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:
.. 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
""""""
+.. |vertical.icon| image:: images/vertical.png
Vertical constraint
===================
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:
| 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
""""""
