SHAPER module of SALOME is destined for:\r
\r
- import and export of geometrical models in IGES, BREP, STEP and XAO formats;\r
-- parametric construction of geometrical objects using a wide range of functions;\r
+- parametric construction of geometrical objects using a wide range of functions:\r
\r
- creation of complex 2D sections using :ref:`sketchPlugin` with consequent extrusion or revolution (see :ref:`featuresPlugin`);\r
- construction of model using primitives defined in :ref:`primitivesPlugin`;\r
\r
Only one document can be active.\r
\r
-New study contains only partset with 7 default constructions which cannot be deleted:\r
+A new study contains only a partset with 7 default constructions, which cannot be deleted:\r
\r
-- one point **Origin** coinciding with origin of coordinate system;\r
+- one point **Origin** coinciding with the origin of the coordinate system;\r
- three axes **OX**, **OY**, **OZ** coinciding with coordinate axes;\r
- three planes **YOZ**, **XOZ**, **XOY** coinciding with coordinate planes. \r
\r
-Only points, axis and planes (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added into Partset to be used in any part later.\r
+Only points, axis, planes (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added into Partset to be used in any part later.\r
:ref:`parameter_usage` can be used both in Partset and any Part.\r
\r
\r
-New Part can be created as described in :ref:`partPlugin`.\r
+A new Part can be created as described in :ref:`partPlugin`.\r
\r
Double click or pop-up menu can be used to activate existing document.\r
\r
.. centered::\r
Toolbars\r
\r
-SHAPER toolbar duplicates main menu and provides access to all commands of the application.\r
+SHAPER toolbar duplicates the main menu and provides access to all commands of the application.\r
\r
SHAPER toolbar is separated into sections:\r
\r
- :ref:`python console`\r
- :ref:`property_panel`\r
\r
-Dock windows can be placed in three dock areas using drag-and -drop:\r
+Dock windows can be placed in three dock areas using drag-and-drop:\r
\r
- left, \r
- right, \r
- bottom.\r
\r
-By default object browser window is placed at the left dock area, Inspection panel at the right dock area and Python console at the bottom dock area of the main window.\r
+By default Object browser window is placed at the left dock area, Inspection panel at the right dock area and Python console at the bottom dock area of the main window.\r
\r
Property Panel is hidden.\r
\r
-The Property Panel is shown on operation start at left dock area of the main window by default.\r
+Property Panel is shown on operation start in left dock area of the main window by default.\r
\r
-If Object Browser is shown at the same side then they will be tabbed.\r
+If Object browser is shown at the same side then they will be tabbed.\r
\r
Each dock window can be closed using **Cross** window button and opened again using a corresponding command from *View - Windows* :ref:`main_menu` or alternatively using pop-up menu.\r
\r
\r
Features are placed one after another in the active document with default names and their results are placed into the corresponding branch.\r
\r
-Example of default names assigned automatically for :ref:`box_feature` are:\r
+Examples of default names assigned automatically for :ref:`box_feature` are:\r
\r
-* **Box_1**, **Box_2**, ... to Feature;\r
-* **Box_1_1**, **Box_2_1**, ... to Result.\r
+* **Box_1**, **Box_2**, ... for Feature;\r
+* **Box_1_1**, **Box_2_1**, ... for Result.\r
\r
-Not default branch is added into Tree View when the first feature of this type is created.\r
+Note, that a default branch is added into Tree View when the first feature of this type is created.\r
\r
-Note, that result used in feature as argument is removed.\r
+Note, that the result used in feature as argument is removed.\r
\r
This child result can be restored using **Recover** feature.\r
\r
.. centered::\r
Construction pop-up menu\r
\r
-Order of features can be changed using *Move to the end* pop-up menu command. Selected feature will be moved to the end of feature list.\r
+The order of features can be changed using *Move to the end* pop-up menu command. The selected feature will be moved to the end of feature list.\r
\r
Folders can be used to arrange long Tree View for features.\r
\r
.. centered::\r
Object browser with folder Dome. Part_1 active\r
\r
-*Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. Folder can be renamed.\r
+*Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. The folder can be renamed.\r
\r
Features placed after/before the created folder can be moved into the folder using *Move into the previous folder* / *Move into the next folder* pop-up menu command.\r
\r
-This allows to decrease length of feature list.\r
+This allows to decrease the length of feature list.\r
\r
-Features can be removed from folder back using *Move out before the folder* / *Move out after the folder* pop-up menu command.\r
+Features can be removed from the folder using *Move out before the folder* / *Move out after the folder* pop-up menu command.\r
\r
*Clean history* pop-up menu command looks for features that do not participate in other features.\r
\r
-**Clean history** dialog box shows list of unused features. After confirmation by click **Yes** button unused features are removed.\r
+**Clean history** dialog box shows a list of unused features. After confirmation by click **Yes** button unused features are removed.\r
\r
.. image:: images/clean_history.png\r
:align: center\r
*Select result* and *Select parent feature* pop-up menu commands help to navigate along Tree View.\r
\r
\r
-Feature together with its result can be deleted using *Delete* pop-up menu command.\r
+A feature and its result can be deleted using *Delete* pop-up menu command.\r
\r
-Note that all features using removed feature and their results will be removed simultaneously.\r
+Note that all features using the removed feature and their results will be removed simultaneously.\r
\r
-**Delete feature** dialog box shows list of features to be removed. After confirmation by click **Yes** button all these features are removed.\r
+**Delete feature** dialog box shows the list of features to be removed. After confirmation by click **Yes** button all these features are removed.\r
\r
\r
.. image:: images/delete_feature.png\r
\r
Property panel consists of two parts:\r
\r
-- controls container for input of parameters for the current operation;\r
+- controls a container for input of parameters for the current operation;\r
- buttons panel containing standard buttons:\r
\r
.. image:: images/button_ok.png\r
\r
Python console interpreters Python commands entered manually.\r
\r
-In particular, it is possible to load python script:\r
+In particular, it is possible to load the python script:\r
\r
*execfile(r"/dn48/newgeom/data/example.py")*\r
\r
-Pop-up menu allows:\r
+Pop-up menu gives the possibility to:\r
\r
-- Copy selected text to clipboard;\r
-- Paste text from clipboard to Python console ;\r
+- Copy the selected text to clipboard;\r
+- Paste the text from clipboard to Python console ;\r
- Clear Python console;\r
- Dump commands from console into the specified file;\r
- Start/Stop writing log into the specified file. \r
Viewer\r
------\r
\r
-The application supports one OCC 3D viewer and is able to show only one 3D space.\r
+The application supports one instance of OCC 3D viewer and is able to show only one 3D space.\r
\r
This 3D space can be represented in several view windows. New view window can be created using **Clone view** button in viewer toolbar.\r
\r
-Each of view windows represents its own point of view on the 3D scene.\r
+Each view windows shows its own point of view on the 3D scene.\r
\r
-This point of view can be modified by user with help of viewer commands like **Panning**, **Zooming**, **Scaling** and so on.\r
+This point of view can be modified using viewer commands: **Panning**, **Zooming**, **Scaling**, etc.\r
\r
\r
.. image:: images/2_viewers.png\r
.. centered::\r
Two view windows\r
\r
-Description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
+The description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
\r
\r
.. _parameter_usage:\r
\r
Model parametrization can be done using parameters.\r
\r
-Parameter can be created in the active partset or part by:\r
-\r
+A parameter can be created in the active partset or part by:\r
- :ref:`parameter`;\r
- :ref:`parameters`;\r
- :ref:`parameter_expression`.\r
\r
Any argument in features can be defined as parameter or expression containing parameters.\r
\r
-List of features using parameters is given in **Parameters** dialog box:\r
+The list of features using parameters is given in **Parameters** dialog box:\r
\r
.. image:: images/parameters_feature.png\r
:align: center\r
.. centered::\r
Parameters dialog box\r
\r
-If parameter value is changed, then all features where it is used are rebuilt.\r
+If a parameter value is changed, then all features where it is used are rebuilt.\r
\r
-Parameter name should be unique in the active document.\r
+A parameter name should be unique in the active document.\r
\r
-However, partset and part can have parameters with the same name. If parameter name in Partset and Part are identical, then Part parameter has higher priority and its value will be used in the features of this part.\r
+However, partset and part can have parameters with the same name. If parameter names in Partset and Part are identical, then Part parameter has a higher priority and its value will be used in the features of this part.\r
\r
-In contrast to features (see :ref:`object_browser`), there is an additional option when Delete parameters. \r
+In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted. \r
\r
.. image:: images/delete_parameter.png\r
:align: center\r
.. centered::\r
Delete parameter\r
\r
-After click **Replace** button. selected parameter is removed but parent parameters and features are not removed. Deleted parameter is replaced by its value.\r
+After clicking **Replace** button, the selected parameter is removed but its parent parameters and features are not removed. The deleted parameter is replaced by its value.\r
\r
.. _parameter_expression:\r
\r
Create parameter on fly\r
^^^^^^^^^^^^^^^^^^^^^^^\r
\r
-Parameter can be created during feature creation simply writing *variable=expression* in any editbox.\r
+Parameter can be created during feature creation simply by writing *variable=expression* in any editbox.\r
\r
-After validation of feature a new parameter with given name **variable** and value equal to evaluated expression appears in object browser under **Parameters** in the active partset or part.\r
+After feature validation a new parameter with the given name **variable** and value equal to the evaluated expression appears in object browser under **Parameters** in the active partset or part.\r
\r
.. _preferences:\r
\r
- :ref:`sketch_preferences`;\r
- :ref:`viewer_preferences`.\r
\r
-Visualization tab is activated by default when **Preferences** dialog box is opened in active SHAPER module.\r
+Visualization tab is activated by default when **Preferences** dialog box is opened in the active SHAPER module.\r
\r
Other tabs are activated by click on tab header.\r
\r
- **Sketch entity color** selects default color for sketch objects;\r
- **Sketch external entity color** selects default color for external objects selected as reference during sketch creation/edition;\r
- **Sketch auxiliary entity color** selects default color for sketch auxiliary objects;\r
-- **Sketch overconsrtaint color** selects default color for sketch with redundant constraints;\r
-- **Sketch fully constraint color** selects default color for sketch with zero degrees of freedom.\r
+- **Sketch overconstraint color** selects default color for a sketch with redundant constraints;\r
+- **Sketch fully constraint color** selects default color for a sketch with zero degrees of freedom.\r
\r
To redefine any color click on the corresponding line to access **Select color** dialog box\r
\r
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to SHAPER's documentation!
+Welcome to SHAPER documentation!
==================================
- :ref:`introduction`
.. toctree::
:titlesonly:
- :maxdepth: 1
+ :maxdepth: 3
Build plug-in
=============
+Build plug-in includes features for creation of various topological entities. It provides the following features:
+
.. toctree::
:titlesonly:
:maxdepth: 1
Compound
========
-The Compound feature creates a compound using already existing shapes in other objects.
+Compound feature creates a compound using shapes already existing in other objects.
-To create compound in the active part:
+To create a compound in the active part:
#. select in the Main Menu *Build - > Compound* item or
#. click **Compound** button in the toolbar
.. centered::
Create a compound
-Select one or several shapes in a viewer. Selected shapes can be of any type (vertex, edge, face and so on).
+Select one or several shapes in the viewer. The selected shapes can be of any type (vertex, edge, face, etc.)
-**Apply** button creates compound.
+**Apply** button creates a compound.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addCompound(Part_doc, Shapes)*
-**Arguments**: Part document + list of shapes.
+**Arguments**: Part document + a list of shapes.
Result
""""""
-The result of the operation will be a compound created from selected shapes:
+The result of the operation will be a compound created from the selected shapes:
.. image:: images/CreateCompound.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_compound` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_compound` operation.
CompSolid
=========
-The Compsolid feature creates a compsolid using already existing shapes in other objects.
+Compsolid feature creates a compsolid using shapes already existing in other objects.
-To create compsolid in the active part:
+To create a compsolid in the active part:
#. select in the Main Menu *Build - > CompSolid* item or
#. click **CompSolid** button in the toolbar
.. centered::
Create a compsolid
-Select one or several shapes in a viewer.
+Select one or several shapes in the viewer.
-**Apply** button creates compsolid.
+**Apply** button creates a compsolid.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addCompSolid(Part_doc, Shapes)*
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_compsolid` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_compsolid` operation.
Edge
====
-The Edge feature creates one or several edges using already existing edges in other objects.
+Edge feature creates one or several edges using shapes already existing in other objects.
To create edges in the active part:
.. centered::
Create edges
-Select one or several edges in viewer.
+Select one or several edges in the viewer.
**Apply** button creates edges.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addEdge(Part_doc, Shapes)*
Result
""""""
-The result of the operation will be set of edges created from selected shapes:
+The result of the operation will be a set of edges created from the selected shapes:
.. image:: images/CreateEdge.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_edge` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_edge` operation.
Face
====
-The Face feature creates one or several faces using already existing faces in other objects.
+Face feature creates one or several faces using shapes already existing in other objects.
-To create face in the active part:
+To create a face in the active part:
#. select in the Main Menu *Build - > Face* item or
#. click **Face** button in the toolbar
**Apply** button creates faces.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addFace(Part_doc, Shapes)*
Result
""""""
-The result of the operation will be set of faces created from selected shapes:
+The result of the operation will be a set of faces created from the selected shapes:
.. image:: images/CreateFace.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_face` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_face` operation.
Filling
=======
-The Filling feature creates one or several faces using already existing edges or wires in other objects.
+Filling feature creates one or several faces using shapes already existing in other objects.
-To create filling in the active part:
+To create a filling in the active part:
#. select in the Main Menu *Build - > Filling* item or
#. click **Filling** button in the toolbar
.. centered::
Create a filling
-Select two or more edges in a viewer.
+Select two or more edges in the viewer.
-**Advanced options** lets to manage filling process.
+**Advanced options** manage filling process.
**Apply** button creates a filling.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addFilling(Part_doc, Edges)*
Result
""""""
-The result of the operation will be set of faces created from selected shapes:
+The result of the operation will be a set of faces created from the selected shapes:
.. image:: images/CreateFilling.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_filling` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_filling` operation.
Interpolation
=============
-The Interpolation feature creates curve (wire) using already existing vertices in other objects.
+Interpolation feature creates a curve (wire) using vertices already existing in other objects.
-To create interpolation in the active part:
+To create an interpolation in the active part:
#. select in the Main Menu *Build - > Interpolation* item or
#. click **Interpolation** button in the toolbar
.. centered::
Create an interpolation
-Select one or several vertices or points in a viewer.
+Select one or several vertices or points in the viewer.
- **Closed** makes the interpolation curve closed.
-- **Reorder** reorders selected points to minimize length of the curve.
+- **Reorder** reorders the selected points to minimize the length of curve.
-- **Tangents** makes start and end of the curve tangent to selected edges. User has to select edges for start and end in corresponded fields.
+- **Tangents** makes start and end of the curve tangent to the selected edges. The user has to select start and end edges in the corresponding fields.
**Apply** button creates an interpolation.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**:
Result
""""""
-The result of the operation will be a curve created from selected shapes:
+The result of the operation will be a curve created from the selected shapes:
.. image:: images/CreateInterpolation.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_interpolation` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_interpolation` operation.
Polyline
========
-The feature **Polyline** creates a wire.
+Polyline feature creates a wire.
To create a Polyline in the active part:
Input fields:
-- **Points and vertices** panel contains list of points and vertices selected in 3D OCC viewer. Polyline consequently connects points;
+- **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)*
-**Arguments**: 1 part+ list of vertices selected in format *model.selection("VERTEX", "Point")* + boolean key defining presence of connection between the start and end points.
+**Arguments**: 1 part+ list of vertices selected in format *model.selection("VERTEX", "Point")* + Boolean key defining connection between the start and end points.
Result
""""""
-Result of operation is closed or open Polyline.
+The result of the operation is a closed or open Polyline.
.. image:: images/CreatePolyline.png
:align: center
.. centered::
Polyline
-**See Also** a sample TUI Script of a :ref:`tui_create_polyline` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_polyline` operation.
\ No newline at end of file
Shell
=====
-The Shell feature creates a shell using already existing faces in other objects.
+Shell feature creates a shell using faces already existing in other objects.
-To create shell in the active part:
+To create a shell in the active part:
#. select in the Main Menu *Build - > Shell* item or
#. click **Shell** button in the toolbar
.. centered::
Create a shell
-Select one or several faces in viewer.
+Select one or several faces in the viewer.
**Apply** button creates a shell.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addShell(Part_doc, Objects)*
Result
""""""
-The result of the operation will be shell created from selected shapes:
+The result of the operation will be a shell created from the selected shapes:
.. image:: images/CreateShell.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_shell` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_shell` operation.
Solid
=====
-The Solid feature creates a solid using already existing faces in other objects.
+Solid feature creates a solid using faces already existing in other objects.
-To create solid in the active part:
+To create a solid in the active part:
#. select in the Main Menu *Build - > Solid* item or
#. click **Solid** button in the toolbar
.. centered::
Create a solid
-Select one or several faces in viewer. Selected faces have to define a closed volume
+Select one or several faces in the viewer. The selected faces have to define a closed volume.
-**Apply** button creates solid.
+**Apply** button creates a solid.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addSolid(Part_doc, Shapes)*
Result
""""""
-The result of the operation will be a solid created from selected shapes:
+The result of the operation will be a solid created from the selected shapes:
.. image:: images/CreateSolid.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_solid` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_solid` operation.
Sub-shapes
==========
-The feature **Sub-shapes** lets to modify selected entity creating a non-manifold topology. It provides:
+The feature **Sub-shapes** modifies the selected entity by creating a non-manifold topology. It gives the possibility to:
-* add/remove vertices laying on edges of a wire;
-* add/remove edges and vertices laying on a face.
+* add/remove vertices lying on edges of a wire;
+* add/remove edges and vertices lying on a face.
To create Sub-shapes in the active part:
Input fields:
-- **Shape** panel contains a shape to be modified. Shape is selected in 3D OCC viewer or object browser. For today it has to be wire or face;
-- **Sub-shapes** panel contains 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.
+- **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)*
Result
""""""
-Result replaces original shape with the same one with added/removed sub-shapes.
+The result replaces the original shape with its copy with added/removed sub-shapes.
.. image:: images/CreateSubShapes.png
:align: center
.. centered::
Sub-shapes
-**See Also** a sample TUI Script of a :ref:`tui_create_subshape` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_subshape` operation.
Vertex
======
-The Vertex feature creates one or several vertices using already existing vertices in other objects.
+Vertex feature creates one or several vertices using vertices already existing in other objects.
To create vertices in the active part:
.. centered::
Create vertices
-Select one or several vertices in viewer.
+Select one or several vertices in the viewer.
**Apply** button creates vertices.
Result
""""""
-The result of the operation will be set of vertices created from selected shapes:
+The result of the operation will be a set of vertices created from the selected shapes:
.. image:: images/CreateVertex.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_vertex` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_vertex` operation.
Wire
====
-The Wire feature creates a wire using already existing edges in other objects.
+Wire feature creates a wire using edges already existing in other objects.
-To create wire in the active part:
+To create a wire in the active part:
#. select in the Main Menu *Build - > Wire* item or
#. click **Wire** button in the toolbar
.. centered::
Create a wire
-Select one or several edges in viewer. For automatic selection of closed contour starting from a selected edge it is necessary to press **Add contour** button.
+Select one or several edges in the viewer. For automatic selection of a closed contour starting from the selected edge it is necessary to press **Add contour** button.
-**Apply** button creates wire.
+**Apply** button creates a wire.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addWire(Part_doc, Shapes)*
Result
""""""
-The result of the operation will be a wire created from selected shapes:
+The result of the operation will be a wire created from the selected shapes:
.. image:: images/CreateWire.png
:align: center
.. centered::
Result of the operation.
-**See Also** a sample TUI Script of a :ref:`tui_create_wire` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_wire` operation.
Collection plug-in
==================
+Collection plug-in deals with groups of geometrical entities created by selection and fields used to assign values to geometrical entities.
+
.. toctree::
:titlesonly:
A field object assigns some values to geometrical entities. These values can be later transferred to mesh entities generated on the geometrical entities during export to MED file in Mesh module. Geometrical fields can be stored in/restored from XAO format files. Note that only integer and double values can be exported into the MED file.
-The field can hold several named values (components) per a geometrical entity.
+The field can hold several named values (components) per geometrical entity.
The field can include several sets of data called steps, each dedicated to a certain time moment.
-To create Field in the active part:
+To create a Field in the active part:
#. select in the Main Menu *Features - > Field* item or
#. click **Field** button in Shaper toolbar:
Input fields:
-- **Type of shapes** selects geometrical entities on which field values will be assigned from drop-down list:
+- **Type of shapes** selects geometrical entities to which field values will be assigned from drop-down list:
- Vertices;
- Edges;
- **Nb. Components** defines number of named values (components) assigned to each geometrical entity;
- **Stamp** sets time stamp for the current time step;
- **Current step** slider navigates through added steps;
-- table of values for each step:
+- table of values for each step contains:
- - number of rows depends on number of entities selected in OCC 3D viewer;
- - **Default value** row contains values assigned to not selected entities of parent shape with given type;
- - number of columns depends on **Nb. Components**;
- - to rename component double-click a column header;
+ - rows whose number depends on the number of entities selected in OCC 3D viewer;
+ - **Default value** row contains values assigned to non-selected entities of the parent shape with given type;
+ - columns whose number depends on **Nb. Components**;
+ - to rename a component double-click a column header;
- **Add Step** button adds a new time step;
- **Remove Step** button deletes the current time step.
**Arguments**: 2 integers + list of lists of values with Type of field
-**See Also** a sample TUI Script of a :ref:`tui_create_field` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_field` operation.
Group
=====
-To create Group in the active part:
+A groups is a set of geometrical entities created by selection.
+To create a Group in the active part:
#. select in the Main Menu *Features - > Group* item or
#. click **Group** button in Shaper toolbar:
:align: left
Solids;
-- List of selected entities of given type. Multiply selection can be done manually in OCC 3D Viewer by mouse click with Shift button pressed or by rectangle selection.
+- The list of selected entities of the given type. Multiple selection can be done manually in OCC 3D Viewer by mouse click with Shift button pressed or by rectangle selection.
To delete entities from the list, select them and call pop-up menu *Delete* item.
:align: center
.. centered::
- Group created
+ Created group
-**See Also** a sample TUI Script of a :ref:`tui_create_group` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_group` operation.
Connector plug-in
=================
-To export Results, Groups, Fields created in active part into GEOM module:
+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:
**Arguments**: 1 part
-Result can be checked in GEOM module.
\ No newline at end of file
+The result can be checked in GEOM module.
\ No newline at end of file
Construction plug-in
====================
-Construction plug-in includes features for creation of different constructive objects. It provides following features:
+Construction plug-in includes features for creation of various constructive objects. It provides the following features:
.. toctree::
:titlesonly:
Axis
====
-The feature Axis creates a new constructive axis line.
+Axis feature creates a new constructive axis line.
-Axis is a construction object and it can be created as in a part as in part set. To create an 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_by_line_32x32.png
:align: left
-**As an axis of cilindrical face** creates an axis using a cilindrical face.
+**As an axis of cylindrical face** creates an axis using a cylindrical face.
.. image:: images/axis_by_line_32x32.png
:align: left
.. image:: images/axis_by_line_32x32.png
:align: left
-**By two planes** creates an axis as intersection of two planes.
+**By two planes** creates an axis as the intersection of two planes.
By three dimensions
-------------------
.. centered::
**By dX, dY, dZ values**
-In this case user has to define dX, dY, dZ values of a vector.
+An axis is defined by dX, dY and dZ values of a vector.
**TUI Commands**: *model.addAxis(Part_doc, 10, 10, 10)*
.. centered::
**Axis by three dimensions**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_xyz` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_xyz` operation.
By two points
.. centered::
**By two points**
-In this case user has to select two points or vertices.
+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"))*
**Arguments**: Part + 2 vertices.
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_points` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
Result
""""""
.. centered::
**Axis by two points**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_points` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_points` operation.
By line
.. centered::
**By a line**
-In this case user has to select a linear edge.
+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"))*
Result
""""""
-The Result of the operation will be an axis based on selected line:
+The Result of the operation will be an axis based on the selected line:
.. image:: images/CreatedAxis3.png
:align: center
.. centered::
**Axis by line**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_line` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_line` operation.
-As an axis of cilindrical face
+As an axis of cylindrical face
------------------------------
.. image:: images/Axis4.png
.. centered::
**By a cylinder**
-In this case user has to select a cylindrical face. Axis of the cylinder will define an axis object.
+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"))*
Result
""""""
-The Result of the operation will be an axis by selected cylinder:
+The Result of the operation will be an axis of the selected cylinder:
.. image:: images/CreatedAxis4.png
:align: center
.. centered::
**Axis cylindrical face**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_cylinder` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_cylinder` operation.
By plane and point
.. centered::
**By a plane and point**
-In this case user has to select a point or vertex and plane (or planar face). Axis will be defined as a normal from the point to the plane.
+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"))*
.. centered::
**Axis by plane and point**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_plane` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_plane` operation.
By two planes
.. centered::
**By two planes**
-In this case user has to select two planes. Intersection of that planes defines an axis. User can define offset for axis definition from both planes.
+An axis is defined by two planes. The intersection of the planes defines an axis. It is possible to define offset for axis definition from both planes.
**TUI Commands**: *model.addAxis(Part_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False)*
-**Arguments**: Part + plane + offcet value + is reversed flag + plane + offcet value + is reversed flag.
+**Arguments**: Part + plane + offset value + is reversed flag + plane + offset value + is reversed flag.
Result
""""""
.. centered::
**Axis by two planes**
-**See Also** a sample TUI Script of a :ref:`tui_create_axis_twoplanes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_axis_twoplanes` operation.
Plane
=====
-The feature Plane creates a new constructive plane.
+Plane feature creates a new constructive plane.
-Plane is a construction object and it can be created as in a part as in a part set. To create a 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
.. centered::
**By three points**
-In this case user has to select three points in a viewer to define a new 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"))*
.. centered::
**A plane by three points**
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_points` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_points` operation.
By line and point
.. centered::
**Line and point**
-In this case user has to select a linear edge and point to define a plane. It is possible to make the new plane perpendicular to the selected edge.
+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)*
.. centered::
Plane created
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_line` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_line` operation.
By other plane
.. centered::
**By other plane**
-In this case user has to select an already existing plane (planar face). There are following possibilities to define a new plane:
+A plane is created by selecting an already existing plane (planar face). There are following possibilities to define a new plane:
.. image:: images/plane_by_distance_from_other_24x24.png
:align: left
.. image:: images/plane_by_coincident_to_point_24x24.png
:align: left
-By coincidence to a point.
+By coincidence with a point.
.. image:: images/plane_by_rotation_24x24.png
:align: left
-By rotation around an edge on a specified angle.
+By rotation around an edge by a specified angle.
**TUI Commands**: *model.addPlane(Part_doc, model.selection("FACE", "Box_1_1/Front"), 10, False)*
.. centered::
**Plane parallel to a planar face**
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_plane` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_plane` operation.
By two parallel planes
.. centered::
**By two parallel planes**
-In this case user has to select two parallel planes. A new plane will be defined between them.
+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"))*
.. centered::
**Plane created between others**
-**See Also** a sample TUI Script of a :ref:`tui_create_plane_parallel` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_plane_parallel` operation.
Point
=====
-The feature Point creates a new construction point.
+Point feature creates a new construction point.
-Point is a construction object and it can be created as in a part as in part set. To create a 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_by_projection_32x32.png
:align: left
-**By projection on edge or plane** creates a point projecting of existing point on an edge or plane.
+**By projection on edge or plane** creates a point by projecting an existing point on an edge or plane.
.. image:: images/point_by_intersection_32x32.png
:align: left
.. centered::
**By X,Y,Z coordinates**
-In this case user has to input X, Y, and Z coordinates.
+A point is created by X, Y, and Z coordinates.
**TUI Commands**: *model.addPoint(Part_doc, 50, 50, 50)*
.. centered::
**Point by coordinates**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_xyz` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_xyz` operation.
By distance on edge
-------------------
.. centered::
**Along an edge**
-In this case user has to select an edge in a viewer and to define a distance along the edge where point will be defined. This distance can be defined as by an absolute value as by relative as a ratio to the edge length. The direction of the edge can be reverced by the corresponded check box.
+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)*
-**Arguments**: Part + edge + value + is by ratio flag + to reverce flag.
+**Arguments**: Part + edge + value + is by ratio flag + to reverse flag.
Result
""""""
-The Result of the operation will be a construction point create on edge:
+The Result of the operation will be a construction point created on edge:
.. image:: images/CreatePoint2.png
:align: center
.. centered::
**Point created on edge**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_edge` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_edge` operation.
By projection on edge or plane
------------------------------
.. centered::
**By projection**
-In this case user has to 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.
+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"))*
.. centered::
**Point created by projection on a plane**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_projection` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_projection` operation.
By intersection of objects
--------------------------
.. centered::
**Intersection of objects**
-In this case user has to select:
+To create a point, select:
#. two edges,
#. edge and plane,
#. three planes
-The new point will be defined by intersection of selected objects.
+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)*
-**Arguments**: Part + edge + plane (planar face) + offset value + is offcet reversed.
+**Arguments**: Part + edge + plane (planar face) + offset value + is offset reversed.
Result
""""""
.. centered::
**Point created by intersection of axis**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_intersection` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_intersection` operation.
By geometrical property of object
---------------------------------
.. centered::
**By geometrical property**
-In this case the new point can be defined as a center of gravity of selected object or as a center of a circle. User has to select desirable object.
+In this case the new point can be defined as a center of gravity of the selected object or as a center of a circle. To create a point, select the desirable object.
**TUI Commands**: *model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1"))*
.. centered::
**Point created in COG of a cylinder**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_object` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_object` operation.
Exchange plug-in
================
-Exchange plug-in implements features for data exchange. It provides following:
+Exchange plug-in implements features for data exchange. It provides the following features:
.. toctree::
:titlesonly:
Dump
====
-The feature Dump allows to export a current study to a Python script wich dumps process of creation of the study as a sequence of Python commands.
+The Dump feature allows exporting a current study to a Python script which dumps the study creation process as a sequence of Python commands.
-It is possible to dump current study state into a Python script. To dump a study:
+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.
.. centered::
**Dump property panel**
-In this panel it is necessary to enter a file name directly into input field or press **'...'** button and browse it with help of dump file dialog box:
+In this panel it is necessary to enter a file name directly or press **'...'** button and browse it with help of dump file dialog box:
.. image:: images/DumpFileDlg.png
:align: center
**Apply** button writes the dump file.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: Is not supported.
Export
======
-The feature export allows to export objects from the current study to an external file.
+The export feature allows exporting objects from the current study to an external file.
-It is possible to export objects into files in following formats: BREP, STEP, IGES, XAO. To export objects to a file:
+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.
.. centered::
**Export property panel**
-In this panel it is necessary to select desirable format of export file. It can be **'BREP, STEP, IGES'** or **'XAO'**. In case of first choice the format of exported file will be defined according to file extension. File name and path can be defined in **Export file** field. It can be typed or browsed with help of **'...'** button which opens **Export file** dialog box:
+In this panel, it is necessary to select desirable format of export file. It can be **'BREP, STEP, IGES'** or **'XAO'**. In case of first choice the format of exported file will be defined according to file extension. The file name and path can be defined in **Export file** field by direct input or browsing with **'...'** button, which opens **Export file** dialog box:
.. image:: images/ExportFileDlg.png
:align: center
.. centered::
**Export file dialog box**
-Selection list in property panel should contain a list of exporting objects which can be selected in a viewer or objects browser.
+Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
**Apply** button exports the file.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.exportToFile(Part_doc, FileNameString, ObjectsList)*
Result
""""""
-The Result of operation is exported file. There are no any changes in object browser or viewer.
+The Result of operation is an exported file.
-**See Also** a sample TUI Script of a :ref:`tui_export_file` operation.
+**See Also** a sample TUI Script of :ref:`tui_export_file` operation.
Import
======
-The feature Import allows to import an external file into a current study.
+The Import feature allows importing an external file into a current study.
-It is possible to import files in following formats: BREP, STEP, IGES, XAO. To import a file into active part:
+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.
.. centered::
**Import property panel**
-In this panel it is possible to enter a file name directly into input field or press **'...'** button and browse it with help of import file dialog box:
+In this panel it is possible to enter a file name directly or press **'...'** button and browse it with help of import file dialog box:
.. image:: images/OpenFileDlg.png
:align: center
**Apply** button imports the file.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addImport(Part_doc, FileNameString)*
Result
""""""
-The Result of the operation depends on content of imported file.
+The Result of the operation depends on the imported file content.
.. image:: images/FileImported.png
:align: center
.. centered::
Import of BREP file.
-**See Also** a sample TUI Script of a :ref:`tui_import_file` operation.
+**See Also** a sample TUI Script of :ref:`tui_import_file` operation.
Features plug-in
================
-Features plug-in implements a set of common topological operations. It implements following features:
+Features plug-in provides a set of common topological operations. It implements the following features:
.. toctree::
:titlesonly:
The feature **Angular copy** makes a compound of several rotated shapes basing on the initial shape.
-To create Angular copy in the active part:
+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
Input fields:
-- **Main objects** panel contains shapes to be rotated. Shapes are selected in 3D OCC viewer or object browser;
-- **Vector of rotation** defines the axis of rotation. Vector is edge, axis selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be rotated. The shapes are selected in 3D OCC viewer or object browser;
+- **Vector of rotation** defines the axis of rotation. The vector of rotation is an edge, axis selected in 3D OCC viewer or object browser;
- **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.
Result
""""""
-Result of cylinder rotation is compound.
+Result of cylinder rotation is a compound.
.. image:: images/angularcopycyl.png
:align: center
.. centered::
Angular copy
-**See Also** a sample TUI Script of a :ref:`tui_create_angularcopy` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_angularcopy` operation.
Common
======
-The feature Common implements a boolean operation for extraction of a common part from a set of selected shapes.
+Common feature implements a Boolean operation for extraction of a common part from a set of selected shapes.
-To perform a boolean operation Common in the active part:
+To perform a Common operation in the active part:
#. select in the Main Menu *Features - > Common* item or
#. click **Common** button in the toolbar
**Simple**
- **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be ignored.
+ 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)*
.. centered::
**Common created**
-**See Also** a sample TUI Script of a :ref:`tui_create_common` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_common` operation.
Advanced
--------
**Advanced**
- **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be cut from
- other objects (to avoid self intersection) and added to the result.
+ If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
+ other objects (to avoid self-intersection) and added to the result.
- **Tools** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be ignored.
+ 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)*
Result
""""""
-For each selected object result will be produced, which are common part between this object and all tools:
+For each selected object, the common part between this object and all tools will be found:
.. image:: images/boolean_common_result.png
:align: center
.. centered::
- **Common created**
+ **Created common**
-**See Also** a sample TUI Script of a :ref:`tui_create_common` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_common` operation.
Cut
===
-The feature Cut implements a boolean operation to cut tool objects from a main objects.
+Cut feature implements a Boolean operation to cut tool objects from main objects.
-To perform a boolean operation Cut in the active part:
+To perform a Cut operationin the active part:
#. select in the Main Menu *Features - > Cut* item or
#. click **Cut** button in the toolbar
**Cut operation**
- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut by tool objects.
- Any kind of shape can be selected. Also allows selection of compsolids/compound subshapes.
- In this case only selected subshapes will be cut, other will stay untoched (as much as possible).
-- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut main objects.
- Any kind of shape can be selected. Also allows selection of compsolids/compounds subshapes.
+ Any kind of shape can be selected, including subshapes of compsolids/compounds.
+ In this case only selected subshapes will be cut, others will stay untouched (as much as possible).
+- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut main objects.
+ Any kind of shape can be selected, including subshapes of compsolids/compounds.
Non-selected subshapes from compsolids/compounds will be ignored.
- **See preview** button shows a result of the operation.
Result
""""""
-For each selected object will be produced a result shape which is a cut of tool objects from main object:
+A result shape which is a cut by tool objects from main object, will be produced for each selected object:
.. image:: images/CreatedCut.png
:align: center
.. centered::
- **Cut created**
+ **Created cut**
-In case if subsolid (yellow wireframe) of compsolid was selected:
+If a subsolid (yellow wireframe) of a compsolid was selected:
.. image:: images/boolean_cut_subsolids_arguments.png
:align: center
.. centered::
**Cut arguments**
-then it will be cut in result and not selected subsolids will be added to it:
+it will be cut in the result and not selected subsolids will be added to it:
.. image:: images/boolean_cut_subsolids_result.png
:align: center
**Cut subsolid result**
-**See Also** a sample TUI Script of a :ref:`tui_create_cut` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_cut` operation.
Extrusion Cut
=============
-Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts result from other objects.
+Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts the result from other objects.
To perform Extrusion Cut in the active part:
.. centered::
Start sketch
-After selecting one of the options property panel for Extrusion Cut will be opened with two variants:
+There are two variants of the property panel for Extrusion Cut depending on the chosen option:
.. image:: images/extrusion_by_sizes.png
:align: left
.. centered::
Extrusion Cut: definition by sizes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To size** size for extrusion along direction.
-- **From size** size for extrusion in opposite direction.
-- **Cut from** contains a list of objects which will but cut with the result of extrusion.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To size** - size for extrusion in the direction.
+- **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);*
:align: center
.. centered::
- **Extrusion Cut created**
+ **Created Extrusion Cut**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_cut_by_sizes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_sizes` operation.
By bounding planes
------------------
.. centered::
Extrusion Cut: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To plane** planar face can be selected to bound extrusion from one side.
-- **To offset** offset for extrusion or for bounding plane if selected.
-- **From plane** planar face can be selected to bound extrusion from other side.
-- **From offset** offset for extrusion or for bounding plane if selected.
-- **Cut from** contains a list of objects which will but cut with the result of extrusion.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To plane** - a planar face can be selected to bound extrusion from one side.
+- **To offset** - offset for extrusion or for a bounding plane, if selected.
+- **From plane** - a planar face can be selected to bound extrusion from the other side.
+- **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);*
:align: center
.. centered::
- **Extrusion Cut created**
+ **Created Extrusion Cut**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.
Extrusion
=========
-Extrusion feature extrudes selected objects along their normals or selected axis.
+Extrusion feature extrudes selected objects along their normals or the selected axis.
To perform Extrusion in the active part:
.. centered::
Start sketch
-After selecting one of the options property panel for Extrusion will be opened with two variants:
+There are two variants of the property panel for Extrusion depending on the chosen option:
.. image:: images/extrusion_by_sizes.png
:align: left
.. centered::
Extrusion: definition by sizes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To size** size for extrusion along direction.
-- **From size** size for extrusion in opposite direction.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To size** - size for extrusion in the direction.
+- **From size** - size for extrusion in the opposite direction.
**TUI Command**: *model.addExtrusion(part, objects, size);*
:align: center
.. centered::
- **Extrusion created**
+ **Created Extrusion**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_by_sizes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_sizes` operation.
By bounding planes
------------------
.. centered::
Extrusion: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To plane** planar face can be selected to bound extrusion from one side.
-- **To offset** offset for extrusion or for bounding plane if selected.
-- **From plane** planar face can be selected to bound extrusion from other side.
-- **From offset** offset for extrusion or for bounding plane if selected.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** if selected, it will be direction of extrusion, otherwise objects normals will be used.
+- **To plane** - a planar face can be selected to bound extrusion from one side.
+- **To offset** - offset for extrusion or for bounding plane, if selected.
+- **From plane** - a planar face can be selected to bound extrusion from the other side.
+- **From offset** - offset for extrusion or for bounding plane, if selected.
**TUI Command**: *model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset);*
:align: center
.. centered::
- **Extrusion created**
+ **Created Extrusion**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_by_bounding_planes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_bounding_planes` operation.
Extrusion Fuse
=============
-Extrusion Fuse feature extrudes selected objects along their normals or selected axis and fuses result with other objects.
+Extrusion Fuse feature extrudes selected objects along their normals or the selected axis and fuses the result with other objects.
To perform Extrusion Fuse in the active part:
.. centered::
Start sketch
-After selecting one of the options property panel for Extrusion Fuse will be opened with two variants:
+There are two variants of the property panel for Extrusion Fuse depending on the chosen option:
.. image:: images/extrusion_by_sizes.png
:align: left
.. centered::
Extrusion Fuse: definition by sizes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To size** size for extrusion along direction.
-- **From size** size for extrusion in opposite direction.
-- **Fuse with** contains a list of objects which will but fused with the result of extrusion.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To size** - size for extrusion in the direction.
+- **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);*
.. centered::
**Extrusion Fuse created**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_fuse_by_sizes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_sizes` operation.
By bounding planes
------------------
.. centered::
Extrusion Fuse: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To plane** planar face can be selected to bound extrusion from one side.
-- **To offset** offset for extrusion or for bounding plane if selected.
-- **From plane** planar face can be selected to bound extrusion from other side.
-- **From offset** offset for extrusion or for bounding plane if selected.
-- **Fuse with** contains a list of objects which will but fused with the result of extrusion.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To plane** - a planar face can be selected to bound extrusion from one side.
+- **To offset** - offset for extrusion or for bounding plane, if selected.
+- **From plane** - a planar face can be selected to bound extrusion from the other side.
+- **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);*
.. centered::
**Extrusion Fuse created**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_fuse_by_bounding_planes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_bounding_planes` operation.
Fill
====
-The feature Fill implements a boolean operation for filling of main objects by parts of tool objects.
+Fill feature implements a Boolean operation filling of main objects by parts of tool objects.
-To perform a boolean operation Fill in the active part:
+To perform Fill in the active part:
#. select in the Main Menu *Features - > Fill* item or
#. click **Fill** button in the toolbar
**Fill operation**
- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut and filled by tool objects.
-- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut and filled the main objects.
+- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut and fill the main objects.
- **See preview** button shows a result of the operation.
**TUI Command**: *model.addFill(Part_doc, mainObjects, toolObjects)*
Result
""""""
-The Result of the operation will be a shape which is a fill of tool objects with main objects:
+The Result of the operation will be a shape, which is a fill of tool objects with main objects:
.. image:: images/CreatedFill.png
:align: center
.. centered::
**Fill created**
-**See Also** a sample TUI Script of a :ref:`tui_create_fill` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fill` operation.
Fillet
======
-The feature **Fillet** creates fillets on the edges of a shape.
+**Fillet** feature creates fillets on the edges of a shape.
-To create Fillet in the active part:
+To create a Fillet in the active part:
#. select in the Main Menu *Feature - > Fillet* item or
#. click **Fillet** button in the toolbar
Input fields:
-- **Faces or/and edges** panel contains faces and edges on which fillet is done. All edges of face are subjected to fillet operation. Faces and edges are selected in 3D OCC viewer;
+- **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)*
-**Arguments**: 1 part + list of faces and edges subjected to fillet operation in format *model.selection(TYPE, shape)* + real (radius value).
+**Arguments**: 1 part + list of faces and edges subject to fillet operation in format *model.selection(TYPE, shape)* + real (radius value).
Result
""""""
.. centered::
Fillet by fixed radius
-**See Also** a sample TUI Script of a :ref:`tui_create_fillet1` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fillet1` operation.
Fillet by variable radius
-------------------------
Input fields:
-- **Faces or/and edges** panel contains faces and edges on which fillet is done. All edges of face are subjected to fillet operation. Faces and edges are selected in 3D OCC viewer;
+- **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;
- **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).
.. centered::
Fillet by variable radius
-**See Also** a sample TUI Script of a :ref:`tui_create_fillet2` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fillet2` operation.
Fuse
====
-The feature Fuse implements a boolean operation for fusion of a set of main objects with a set of tool objects.
+Fuse feature implements a Boolean operation for fusion of a set of main objects with a set of tool objects.
-To perform a boolean operation Fuse in the active part:
+To perform Fuse in the active part:
#. select in the Main Menu *Features - > Fuse* item or
#. click **Fuse** button in the toolbar
.. centered::
**Simple**
-- **Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be ignored.
-- **Remove intersection edges** if enabled edges that lie on the same surface will be removed.
-- **See preview** button shows a result of the operation.
+- **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
+ If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
+- **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)*
.. centered::
**Fuse created**
-**See Also** a sample TUI Script of a :ref:`tui_create_fuse` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.
Advanced
--------
.. centered::
**Advanced**
-- **Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be cut from
+- **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
+ If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
other objects (to avoid self intersection) and added to the result.
-- **Tools** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be ignored.
-- **Remove intersection edges** if enabled edges that lie on the same surface will be removed.
-- **See preview** button shows a result of the operation.
+- **Tools** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
+ If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
+- **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)*
.. centered::
**Fuse created**
-**See Also** a sample TUI Script of a :ref:`tui_create_fuse` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.
Fuse Faces
==========
-The feature **Fuse Faces** eliminates the edges between adjacent same-domain faces lying on the same geometrical surface. This feature is useful for processing the results of **Fuse**, **Union** or **Partition** operations.
+**Fuse Faces** feature eliminates the edges between adjacent same-domain faces lying on the same geometrical surface. This feature is useful for processing the results of **Fuse**, **Union** or **Partition** operations.
-To perform operation **Fuse Faces** in the active part:
+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
Input fields:
-- **Shape** contains object selected in the Object Browser or in the Viewer, on which faces will be fused.
+- **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)*
.. centered::
Shape before and after operation **Fuse Faces**
-**See Also** a sample TUI Script of a :ref:`tui_create_fuse_faces` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fuse_faces` operation.
Intersection
============
-The feature Intersection implements a boolean operation for intersection of a set of main objects with a set of tool objects.
+Intersection feature a boolean operation for intersection of a set of main objects with a set of tool objects.
To perform a boolean operation Intersection in the active part:
.. centered::
**Intersection operation**
-**Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be intersected.
+**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)*
.. centered::
**Intersection created**
-**See Also** a sample TUI Script of a :ref:`tui_create_intersection` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_intersection` operation.
Linear copy
===========
-The feature **Linear copy** makes several translations of a selected shape in one or two directions.
+**Linear copy** feature makes several translations of a selected shape in one or two directions.
-To create Linear copy in the active part:
+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
Result
""""""
-Result of operation is compound.
+Result of operation is a compound.
.. image:: images/linearcopyres.png
:align: center
.. centered::
Linear copy
-**See Also** a sample TUI Script of a :ref:`tui_create_linearcopy` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_linearcopy` operation.
\ No newline at end of file
Partition
=========
-The feature Partition implements a boolean operation for partitioning of a set of selected objects.
+Partition feature implements a boolean operation for partitioning of a set of selected objects.
-To perform a boolean operation Partition in the active part:
+To perform a Partition in the active part:
#. select in the Main Menu *Features - > Partition* item or
#. click **Partition** button in the toolbar
.. centered::
**Partition created**
-**See Also** a sample TUI Script of a :ref:`tui_create_partition` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_partition` operation.
Pipe
====
-The feature **Pipe** makes an extruded Pipe shape.
+**Pipe** feature makes an extruded Pipe shape.
-To create Pipe in the active part:
+To create a Pipe in the active part:
#. select in the Main Menu *Features - > Pipe* item or
#. click **Pipe** button in the toolbar
Input fields:
- **Base objects** panel contains shapes to be extruded. Several Base Objects generate several pipes. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
-- **Path object** defines path along which the Base Object will be extruded. **Path object** (edge or wire) is 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)*
Result
""""""
-Result of extrusion of arc along another arc.
+Result of extrusion of an arc along another arc.
.. image:: images/simplePipe.png
:align: center
.. centered::
Pipe by object and path
-**See Also** a sample TUI Script of a :ref:`tui_simple_pipe` operation.
+**See Also** a sample TUI Script of ref:`tui_simple_pipe` operation.
Pipe by object, path and Bi-normal
----------------------------------
Input fields:
- **Base objects** panel contains shapes to be extruded. Several Base Objects generate several pipes. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
-- **Path object** defines path along which the Base Object will be extruded. **Path object** (edge or wire) is 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;
- **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)*
Result
""""""
-Result of extrusion of rectangular face along arc.
+Result of extrusion of a rectangular face along arc.
.. image:: images/binormalPipe.png
:align: center
.. centered::
Pipe by object, path and Bi-normal
-**See Also** a sample TUI Script of a :ref:`tui_binormal_pipe` operation.
+**See Also** a sample TUI Script of :ref:`tui_binormal_pipe` operation.
Pipe by object, path and locations
----------------------------------
-The pipe is generated to preserve selected profiles at the specified locations along path.
+The pipe is generated to preserve selected profiles at the specified locations along the path.
.. image:: images/Pipe3.png
:align: center
Input fields:
- **Base objects** panel contains shapes to be extruded. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
-- **Path object** defines 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 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.
+- **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)*
.. centered::
Pipe by object, path and locations
-**See Also** a sample TUI Script of a :ref:`tui_locations_pipe` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.
\ No newline at end of file
Placement
=========
-Placement lets to place a one object relatively to another object. To make a 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
.. centered::
**Placement operation**
-In this property panel it is necessary:
+In this property panel, it is necessary to:
-- Select objects which will be moved.
+- Select objects which will be moved;
-- Select a face, edge or vertex as a start for moving
+- Select a face, edge or vertex as a start for moving;
-- Select a face, edge or vertex as an end of moving
+- Select a face, edge or vertex as an end of moving;
- Define state of **Reverse** and **Centering** check boxes.
.. centered::
**Placement created**
-**See Also** a sample TUI Script of a :ref:`tui_create_placement` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_placement` operation.
Remove Sub-Shapes
=================
-Remove Sub-Shapes allows to remove sub shapes from wires, shells, compsolids, compounds.
+Remove Sub-Shapes allows removing sub shapes from wires, shells, compsolids and compounds.
-To perform Remove Sub-Shapes in the active part:
+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
.. centered::
Remove Sub-Shapes
-- **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids, compounds allowed for selection.
+- **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids or compounds are allowed for selection.
There are 2 options for removing sub-shapes:
.. image:: images/remove_subshapes_32x32.png
:align: left
-**By removing** allows to select which sub-shapes will be removed.
+**By removing** allows selecting sub-shapes to be removed.
-- **Sub-Shapes to remove** list of sub-shapes which should be removed.
+- **Sub-Shapes to remove** the list of sub-shapes which should be removed.
**TUI Command**:
| *Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, object)*
.. image:: images/keep_subshapes_32x32.png
:align: left
-**By keeping** allows to select which sub-shapes will be kept.
+**By keeping** allows select sub-shapes to be kept.
-- **Sub-Shapes to keep** list of sub-shapes which should be kept.
+- **Sub-Shapes to keep** the list of sub-shapes which should be kept.
**TUI Command**:
| *Remove_SubShapes_1 = model.addRemoveSubShapes(Part_1_doc, object)*
:align: center
.. centered::
- **Remove Sub-Shapes created**
+ **Remove Sub-Shapes**
-**See Also** a sample TUI Script of a :ref:`tui_create_remove_subshapes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_remove_subshapes` operation.
Revolution Cut
==============
-Revolution Cut feature revolves selected objects around selected axis and cuts result from other objects.
+Revolution Cut feature revolves the selected objects around the selected axis and cuts the result from other objects.
-To perform Revolution Cut in the active part:
+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
.. centered::
Start sketch
-After selecting one of the options property panel for Revolution Cut will be opened with two variants:
+There are two variants of the property panel for Revolution Cut depending on the chosen option:
.. image:: images/revolution_by_angles.png
:align: left
.. centered::
Revolution Cut: definition by angles
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
-- **Axis** axis of revolution.
-- **To angle** end angle of revolution.
-- **From angle** start angle of revolution.
-- **Cut from** contains a list of objects which will but cut with the result of revolution.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To angle** - end angle of revolution.
+- **From angle** - start angle of revolution.
+- **Cut from** - contains a list of objects which will but cut with the result of revolution.
**TUI Command**: *model.addRevolutionCut(part, objectsToRevolve, axis, angle, objectToCut);*
Result
""""""
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
.. image:: images/revolution_cut_by_angles_result.png
:align: center
.. centered::
**Revolution Cut created**
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_cut_by_angles` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_angles` operation.
By bounding planes
------------------
.. centered::
Revolution Cut: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
-- **Axis** axis of revolution.
-- **To plane** planar face can be selected to bound revolution from one side.
-- **To offset** offset for revolution or for bounding plane if selected.
-- **From plane** planar face can be selected to bound revolution from other side.
-- **From offset** offset for revolution or for bounding plane if selected.
-- **Cut from** contains a list of objects which will but cut with the result of revolution.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To plane** - a planar face can be selected to bound revolution from one side.
+- **To offset** - offset for revolution or for bounding plane, if selected.
+- **From plane** - a planar face can be selected to bound revolution from the other side.
+- **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);*
Result
""""""
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
.. image:: images/revolution_cut_by_bounding_planes_result.png
:align: center
.. centered::
**Revolution Cut created**
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_cut_by_bounding_planes` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_bounding_planes` operation.
\ No newline at end of file
Revolution feature revolves selected objects around selected axis.
-To perform Revolution in the active part:
+To perform a Revolution in the active part:
#. select in the Main Menu *Features - > Revolution* item or
#. click **Revolution** button in the toolbar
.. centered::
Start sketch
-After selecting one of the options property panel for Revolution will be opened with two variants:
+There are two variants of the property panel for Revolution depending on the chosen option:
.. image:: images/revolution_by_angles.png
:align: left
.. centered::
Revolution: definition by angles
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
-- **Axis** axis of revolution.
-- **To angle** end angle of revolution.
-- **From angle** start angle of revolution.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To angle** - end angle of revolution.
+- **From angle** - start angle of revolution.
**TUI Command**: *model.addRevolution(part, objects, axis, angle);*
Result
""""""
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
.. image:: images/revolution_by_angles_result.png
:align: center
.. centered::
**Revolution created**
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_by_angles` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_angles` operation.
By bounding planes
------------------
.. centered::
Revolution: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
-- **Axis** axis of revolution.
-- **To plane** planar face can be selected to bound revolution from one side.
-- **To offset** offset for revolution or for bounding plane if selected.
-- **From plane** planar face can be selected to bound revolution from other side.
-- **From offset** offset for revolution or for bounding plane if selected.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To plane** - a planar face can be selected to bound revolution from one side.
+- **To offset** - offset for revolution or for bounding plane, if selected.
+- **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);*
Result
""""""
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
.. image:: images/revolution_by_bounding_planes_result.png
:align: center
.. centered::
**Revolution created**
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_by_bounding_planes` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation.
\ No newline at end of file
Revolution Fuse
===============
-Revolution Fuse feature revolves selected objects around selected axis and fuses result from other objects.
+Revolution Fuse feature revolves the selected objects around the selected axis and fuses the result with other objects.
To perform Revolution Fuse in the active part:
.. centered::
Start sketch
-
-After selecting one of the options property panel for Revolution Fuse will be opened with two variants:
+
+There are two variants of the property panel for Revolution Fuse depending on the chosen option:
.. image:: images/revolution_by_angles.png
:align: left
.. centered::
Revolution Fuse: definition by angles
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
-- **Axis** axis of revolution.
-- **To angle** end angle of revolution.
-- **From angle** start angle of revolution.
-- **Fuse with** contains a list of objects which will but fuse with the result of revolution.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To angle** - end angle of revolution.
+- **From angle**- start angle of revolution.
+- **Fuse with** contains a list of objects which will be fused with the result of revolution.
**TUI Command**: *model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse);*
Result
""""""
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
.. image:: images/revolution_fuse_by_angles_result.png
:align: center
.. centered::
**Revolution Fuse created**
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_fuse_by_angles` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_angles` operation.
By bounding planes
------------------
.. centered::
Revolution Fuse: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
-- **Axis** axis of revolution.
-- **To plane** planar face can be selected to bound revolution from one side.
-- **To offset** offset for revolution or for bounding plane if selected.
-- **From plane** planar face can be selected to bound revolution from other side.
-- **From offset** offset for revolution or for bounding plane if selected.
-- **Fuse with** contains a list of objects which will but fuse with the result of revolution.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To plane** - a planar face can be selected to bound revolution from one side.
+- **To offset** - offset for revolution or for bounding plane, if selected.
+- **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.
+- **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);*
Result
""""""
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
.. image:: images/revolution_fuse_by_bounding_planes_result.png
:align: center
.. centered::
**Revolution Fuse created**
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_fuse_by_bounding_planes` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_bounding_planes` operation.
\ No newline at end of file
Rotation
========
-The feature **Rotation** makes rotation of a selected shape.
+**Rotation** feature makes rotation of a selected shape.
-To create Rotation in the active part:
+To create a Rotation in the active part:
#. select in the Main Menu *Part - > Rotation* item or
#. click **Rotation** button in the toolbar
Input fields:
- **Main objects** panel contains shapes to be rotated. Shapes are selected in 3D OCC viewer or object browser;
-- **Axis** defines the axis of rotation. Vector is edge, axis selected in 3D OCC viewer or object browser;
+- **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)*
Result
""""""
-Result of operation is rotated initial shape.
+Result of operation is a rotated initial shape.
.. image:: images/rotation_axis.png
:align: center
.. centered::
Rotation by axis and angle
-**See Also** a sample TUI Script of a :ref:`tui_rotation_axis` operation.
+**See Also** a sample TUI Script of :ref:`tui_rotation_axis` operation.
Rotation by center and points
-----------------------------
Input fields:
- **Main objects** panel contains shapes to be rotated. Shapes are selected in 3D OCC viewer or object browser;
-- **Center point**, **Start point**, **End point** define 3 points or vertices selected in 3D OCC viewer or object browser. Rotation axis will pass through the **Center point** and will be 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**.
+- **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)*
Result
""""""
-Result of operation is rotated initial shape.
+Result of operation is a rotated initial shape.
.. image:: images/rotation_3points.png
:align: center
.. centered::
Rotation by center and 2 points
-**See Also** a sample TUI Script of a :ref:`tui_rotation_3points` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_rotation_3points` operation.
\ No newline at end of file
Smash
=====
-The feature Smash implements a boolean operation for smashing a set of main objects by a set of tool objects.
+Smash feature implements a boolean operation for smashing a set of main objects by a set of tool objects.
-To a create boolean operation Smash in the active part:
+To create a Smash in the active part:
#. select in the Main Menu *Features - > Smash* item or
#. click **Smash** button in the toolbar
**Smash operation**
- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed by tool objects.
- In case if subshape from compsolid was selected then other shapes from this compsolid/compound will be cut from
+ If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
other objects (to avoid self intersection) and added to the result.
- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed into main objects.
- In case if subshape from compsolid/compound was selected then other shapes from this compsolid/compound will be ignored.
+ 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)*
.. centered::
**Smash created**
-**See Also** a sample TUI Script of a :ref:`tui_create_smash` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_smash` operation.
Symmetry
========
-The feature **Symmetry** makes symmetrical copy of a selected shape.
+**Symmetry** feature makes a symmetrical copy of the selected shape.
-To create Symmetry in the active part:
+To create a Symmetry in the active part:
#. select in the Main Menu *Part - > Symmetry* item or
#. click **Symmetry** button in the toolbar
Input fields:
- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
-- **Point** defines point of symmetry selected in 3D OCC viewer or object browser;
-- **Create a copy** checkbox turns on/off preservation of the initial object.
+- **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)*
Result
""""""
-Result of operation is mirrored initial shape with **Create a copy** = *True*.
+The result of operation is a mirrored initial shape with **Create a copy** = *True*.
.. image:: images/symmetryPointres.png
:align: center
.. centered::
Symmetry through a Point of symmetry
-**See Also** a sample TUI Script of a :ref:`tui_symmetry_point` operation.
+**See Also** a sample TUI Script of :ref:`tui_symmetry_point` operation.
Symmetry through an Axis of symmetry
------------------------------------
Input fields:
- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
-- **Axis** defines axis of symmetry selected in 3D OCC viewer or object browser;
-- **Create a copy** checkbox turns on/off preservation of the initial object.
+- **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)*
Result
""""""
-Result of operation is mirrored initial shape with **Create a copy** = *False*.
+The result of operation is a mirrored initial shape with **Create a copy** = *False*.
.. image:: images/symmetryAxisres.png
:align: center
.. centered::
Symmetry through an Axis of symmetry
-**See Also** a sample TUI Script of a :ref:`tui_symmetry_axis` operation.
+**See Also** a sample TUI Script of :ref:`tui_symmetry_axis` operation.
Symmetry through a Plane of symmetry
------------------------------------
Input fields:
- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
-- **Plane** defines plane of symmetry selected in 3D OCC viewer or object browser;
-- **Create a copy** checkbox turns on/off preservation of the initial object.
+- **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)*
Result
""""""
-Result of operation is mirrored initial shape with **Create a copy** = *False*.
+The result of operation is a mirrored initial shape with **Create a copy** = *False*.
.. image:: images/symmetryPlaneres.png
:align: center
.. centered::
Symmetry through a Plane of symmetry
-**See Also** a sample TUI Script of a :ref:`tui_symmetry_plane` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation.
\ No newline at end of file
Scale
=====
-The feature **Scale** makes a scaled shape basing on the initial shape.
+**Scale** feature makes a scaled shape basing on the initial shape.
-To create Scale in the active part:
+To create a Scale in the active part:
#. select in the Main Menu *Features - > Scale* item or
#. click **Scale** button in the toolbar
.. centered::
Scale by one common factor
-**See Also** a sample TUI Script of a :ref:`tui_Scale_common_factor` operation.
+**See Also** a sample TUI Script of :ref:`tui_Scale_common_factor` operation.
Scale by different factors along axes
-------------------------------------
.. centered::
Scale by different factors
-**See Also** a sample TUI Script of a :ref:`tui_Scale_XYZ` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation.
\ No newline at end of file
Translation
===========
-The feature **Translation** makes translation of a selected shape.
+**Translation** feature translates a selected shape.
-To create Translation in the active part:
+To create a Translation in the active part:
#. select in the Main Menu *Part - > Translation* item or
#. click **Translation** button in the toolbar
Input fields:
-- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
-- **Axis** defines vector along which the object will be translated. Vector is edge, axis selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be translated. The shapes are selected in 3D OCC viewer or object browser;
+- **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)*
Result
""""""
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
.. image:: images/translation_XYZ.png
:align: center
Input fields:
-- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
+- **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)*
Result
""""""
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
.. image:: images/translation_vector.png
:align: center
.. centered::
Translation by vector
-**See Also** a sample TUI Script of a :ref:`tui_translation_DXDYDZ` operation.
+**See Also** a sample TUI Script of :ref:`tui_translation_DXDYDZ` operation.
Translation by two points
Result
""""""
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
.. image:: images/translation_2points.png
:align: center
.. centered::
Translation by two points
-**See Also** a sample TUI Script of a :ref:`tui_translation_2points` operation.
+**See Also** a sample TUI Script of :ref:`tui_translation_2points` operation.
Union
=====
-The feature Union implements a boolean operation for creation of a union of selected objects.
+Union feature implements a Boolean operation for creation of a union of selected objects.
-To a create boolean operation Union in the active part:
+To create a Union in the active part:
#. select in the Main Menu *Features - > Union* item or
#. click **Union** button in the toolbar
Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection.
-**Apply** button creates the union shape.
+**Apply** button creates a union shape.
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
**TUI Command**: *model.addUnion(Part_doc, objects)*
.. centered::
**Union created**
-**See Also** a sample TUI Script of a :ref:`tui_create_union` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_union` operation.
GDML plug-in
=============
-GDML plug-in provides a set of features for creation of geometry primitives using GDML language. It implements following features:
+GDML plug-in provides a set of features for creation of geometry primitives using GDML language. It implements the following features:
.. toctree::
:titlesonly:
Cone segment
============
-The feature Cone segment creates a cone or its segment using GDML language.
+Cone segment feature creates a cone or its segment using GDML language.
To create a Cone segment in the active part:
.. centered::
**Cone property panel**
-The property panel contains image which explains meaning of input values:
+The property panel contains an image which explains the meaning of input values:
-- **rmin1, rmax1** - minimal and maximal radiuses of a base of the cone.
-- **rmin2, rmax2** - minimal and maximal rediuses of a top of the cone.
-- **z** is a heighth of the cone.
-- **startphi** is a starting angle of the cone segment.
-- **deltaphi** is an angle to end of the cone segment.
+- **rmin1, rmax1** - minimal and maximal radii of the cone base.
+- **rmin2, rmax2** - minimal and maximal radii of the cone top.
+- **z** - height of the cone.
+- **startphi** - angle from the axis to the start of the cone segment.
+- **deltaphi** - arc angle of the cone segment.
**TUI Command**: *model.addConeSegment(Part_doc, rmin1, rmax1, rmin2, rmax2, z, startphi, deltaphi)*
-**Arguments**: Part + Rmin of base + Rmax of base + Rmin of top + Rmax of top + height + start angle + end angle.
+**Arguments**: Part + Rmin of base + Rmax of base + Rmin of top + Rmax of top + height + start angle + arc angle.
Result
""""""
.. centered::
Cone created
-**See Also** a sample TUI Script of a :ref:`tui_create_conesegment` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_conesegment` operation.
Ellipsoid
=========
-The feature Ellipsoid creates a 3d ellipsoid or its part using GDML language.
+Ellipsoid feature creates a 3d ellipsoid or its part using GDML language.
-To create a Ellipsoid in the active part:
+To create an Ellipsoid in the active part:
#. select in the Main Menu *GDML - > Ellipsoid* item or
#. click **Ellipsoid** button in the toolbar.
.. centered::
**Ellipsoid property panel**
-The property panel contains image which explains meaning of input values:
+The property panel contains an image, which explains the meaning of input values:
-- **ax** is a size of the ellipsoind along X axis.
-- **by** is a size of the ellipsoind along Y axis.
-- **cz** is a size of the ellipsoind along Z axis.
-- **zcut1** is a z coordinate of a lower cut plane.
-- **zcut2** is a z coordinate of a upper cut plane.
+- **ax** - ellipsoid size along X axis.
+- **by** - ellipsoid size along Y axis.
+- **cz** - ellipsoid size along Z axis.
+- **zcut1** - z-coordinate of a lower cut plane.
+- **zcut2** - z-coordinate of an upper cut plane.
**TUI Command**: *model.addEllipsoid(Part_doc, ax, by, cz)*
.. centered::
Ellipsoid created
-**See Also** a sample TUI Script of a :ref:`tui_create_ellipsoid` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_ellipsoid` operation.
Parameters manager
==================
-To create/edit a set of parameters in the active partset or part instead of multiply call:
+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:
**Input fields**:
-- **Name** defines parameter name. Name follows the naming rules of the python language for variables;
-- **Expression** inputs manually python expression;
+- **Name** defines parameter name. Name follows the naming rules of the python language for variables;
+- **Expression** allows manual input of python expression;
- **Result** evaluates expression as real number by python *eval()* function;
- **Comment** contains any text. This field is optional;
- **Add** button adds a new empty string in the end of table. Default **Name** is *<NoName>*, **Expression** is *<NoValue>*
- **Modify parameter position** button moves the selected parameter
.. image:: images/parameters_up.png
:align: left
- up on 1 string in the table,
+ one string higher in the table,
.. image:: images/parameters_down.png
:align: left
- down on 1 string in the table.
+ one string lower in the table.
**TUI Command**: *model.addParameter(Part_doc, Name, Value, Comment)*
**Arguments**: 1 Part + 1 string + 1 value + 1 string
-**See Also** a sample TUI Script of a :ref:`tui_parametersFeature` operation.
+**See Also** a sample TUI Script of :ref:`tui_parametersFeature` operation.
Result
------
Create parameter
================
-The parameter definition has form *variable=expression*.
+The parameter can be defined in form *variable=expression*.
-To create parameter in the active partset or part:
+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:
- .. image:: images/expression.png
:align: left
- defines parameter name. Name follows the naming rules of the python language for variables;
+ defines parameter name following the naming rules of the python language for variables;
-- panel **Expression** evaluates inputted manually expression as 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.
+- 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.
- **Comment** contains any text. This field is optional.
-The property panel checks validity of the expression. For invalid expression **Apply** button is disabled and error message generated by python interpreter during the evaluation is shown in status bar and in popup of **Apply** button.
+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)*
Result
------
-Created parameter and its current value are displayed in the Object Browser, in a special section **Parameters**.
+The created parameter and its current value are displayed in the Object Browser, in a special section **Parameters**.
.. image:: images/object_browser_parameter.png
:align: center
Created empty part is activated and appears in the object browser.
-**See Also** a sample TUI Script of a :ref:`tui_create_part` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_part` operation.
Duplicate Part
--------------
-To duplicate active Part:
+To duplicate an active Part:
#. select in the Main Menu *Part - > Duplicate part* item or
#. click **Duplicate part** button in Shaper toolbar:
Remove Part
-----------
-To remove active Part:
+To remove an active Part:
#. select in the Main Menu *Part - > Remove part* item or
#. click **Remove part** button in Shaper toolbar:
Primitives plug-in
==================
-The Primitives plug-in contains features dedicated to creation of geometrical primitives. Result of each feature is a solid. The plug-in includes the following features:
+The Primitives plug-in contains features for creation of geometrical primitives. Result of each feature is a solid. The plug-in includes the following features:
.. toctree::
:titlesonly:
Box
===
-The feature Box creates a box solid.
+Box feature creates a box solid.
To create a Box in the active part:
Input fields:
-- **DX**, **DY**, **DZ** define sizes of the box along corresponding coordinate axes.
+- **DX**, **DY**, **DZ** define dimensions of the box along the corresponding coordinate axes.
**TUI Command**: *model.addBox(Part_doc, DX, DY, DZ)*
Result
""""""
-A solid box based on origin and with edges parallel to the coordinate axes.
+A solid box based on the origin of coordinates and with edges parallel to the coordinate axes.
.. image:: images/Box1.png
:align: center
Input fields:
-- **Point 1** and **Point 2** define diagonal points of the box selected in 3D OCC viewer or object browser.
+- **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)*
:align: center
.. centered::
- Boxes created
+ Created boxes
-**See Also** a sample TUI Script of a :ref:`tui_create_boxpnt` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_boxpnt` operation.
Cone
====
-The feature Cone creates a cone solid.
+Cone feature creates a cone solid.
To create a Cone in the active part:
Input fields:
-- **Point** defines center of the cone base selected in 3D OCC viewer or object browser;
+- **Point** defines the center of the cone base selected in 3D OCC viewer or object browser;
- **Vector** defines the axis of the cone selected in 3D OCC viewer or object browser;
- Dimensions:
- **Base Radius**;
.. centered::
Cone created
-**See Also** a sample TUI Script of a :ref:`tui_create_cone` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_cone` operation.
Cylinder
========
-The feature Cylinder creates a cylinder solid.
+Cylinder feature creates a cylinder solid.
To create a Cylinder in the active part:
.. image:: images/cylinder_portion_32x32.png
:align: left
-**Portion of cylinder** creates one segment of cylinder.
+**Portion of cylinder** creates one segment of a cylinder.
Cylinder
--------
Input fields:
-- **Point** defines center of the cylinder base selected in 3D OCC viewer or object browser;
+- **Point** defines the center of the cylinder base selected in 3D OCC viewer or object browser;
- **Vector** defines the axis of the cylinder selected in 3D OCC viewer or object browser;
- Dimensions:
- **Radius**;
Result
""""""
-Example is shown below.
+An example is shown below.
.. image:: images/Cylinder1.png
:align: center
.. centered::
Cylinder
-**See Also** a sample TUI Script of a :ref:`tui_create_cylinder` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_cylinder` operation.
Portion of cylinder
-------------------
.. centered::
**Portion of cylinder** property panel
-Input fields for ***Portion of cylinder** tab includes in addition **Angle** to create a portion of cylinder.
+Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder.
**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)*
Result
""""""
-Example is shown below.
+An example is shown below.
.. image:: images/Cylinder2.png
:align: center
.. centered::
Portion of cylinder
-**See Also** a sample TUI Script of a :ref:`tui_create_cylportion` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_cylportion` operation.
Sphere
======
-The feature Sphere creates a sphere solid.
+Sphere feature creates a sphere solid.
To create a Sphere in the active part:
Input fields:
-- **Point** defines center of the sphere selected in 3D OCC viewer or object browser;
+- **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)*.
Result
""""""
-Example is shown below.
+An example is shown below.
.. image:: images/Sphere_res.png
:align: center
.. centered::
Sphere created
-**See Also** a sample TUI Script of a :ref:`tui_create_sphere` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_sphere` operation.
Torus
=====
-The feature Torus creates a torus solid.
+Torus feature creates a torus solid.
To create a Torus in the active part:
Input fields:
-- **Point** defines center of the torus base selected in 3D OCC viewer or object browser;
+- **Point** defines the center of the torus base selected in 3D OCC viewer or object browser;
- **Vector** defines the axis of the torus selected in 3D OCC viewer or object browser;
- Dimensions:
- **Radius**;
Result
""""""
-Example is shown below.
+An example is shown below.
.. image:: images/Torus_res.png
:align: center
.. centered::
Torus created
-**See Also** a sample TUI Script of a :ref:`tui_create_torus` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_torus` operation.
Python addons
=============
-User can create his own custom features.
+It is possible to create custom features.
-Corresponding folder should be created for each feature at *../sources/src/PythonAddons/macros*.
+The corresponding folder should be created for each feature at *../sources/src/PythonAddons/macros*.
-Feature description includes 4 files:
+A feature description includes 4 files:
-- widget.xml with description of property panel,
+- widget.xml with a description of the property panel,
- __init__.py,
- feature.py with python commands,
-- icon.png with image of button in toolbar (file is located at sub-folder /icons).
+- icon.png with image of button in the toolbar (the file is located at sub-folder /icons).
-Two examples of custom features already created are:
+Two examples of already created custom features are:
.. toctree::
:titlesonly:
Box
===
-Custom files for feature **Box** are:
+Custom files for **Box** feature are:
- empty __init__.py,
- :ref:`create_custom_box_py`,
.. centered::
File icon.png
-The custom feature **Box** creates a box solid by extrusion of rectangle.
+The custom **Box** feature creates a box solid by extrusion of rectangle.
To create a Box in the active part:
Input fields:
-- **Width**, **Length**, **Height** are sizes of the box along corresponding coordinate axes. The box will be created starting from the origin.
+- **Width**, **Length**, **Height** are sizes of the box along the corresponding coordinate axes. The box will be created starting from the origin.
Result
""""""
:align: center
.. centered::
- Box created
\ No newline at end of file
+ Created box
\ No newline at end of file
Rectangle
=========
-Custom files for feature **Rectangle** are:
+Custom files for **Rectangle** feature are:
- empty __init__.py,
- :ref:`create_custom_rectangle_py`,
.. centered::
File icon.png
-Description of custom feature :ref:`create_sketch_rectangle` is given in Sketch plug-in.
\ No newline at end of file
+The description of custom feature :ref:`create_sketch_rectangle` is given in Sketch plug-in.
\ No newline at end of file
Sketch plug-in includes features for creation of 2D shapes.
-The process of sketch creation is comprised of:
+The sketch creation takes the following steps:
-- definition of sketch plane
-- creation of sketch objects from scratch
-- generation of sketch objects via operations on the existing operations
-- definition of constraints
+- definition of sketch plane;
+- creation of sketch objects from scratch;
+- generation of sketch objects via operations on the existing operations;
+- definition of constraints.
-Sketch could be created both in active part and a part set (if there is no active part).
+Sketch can be created in the active part or in a partset (if there is no active part).
To create a Sketch:
.. centered::
**Sketch** button
-First define a plane on which to create a sketch:
+First define a plane for the sketch:
.. image:: images/PlaneDefinition.png
:align: center
-- specify plane size (equal to 25 in the example above)
-- then select the appropriate plane in the viewer
+- specify plane size (equal to 25 in the example above);
+- select the appropriate plane in the viewer.
-Note that in case if there are no convenient objects for plane selection are
-displayed in the viewer - coordinate planes will be suggested for selection:
+Note that coordinate planes will be suggested for selection if no convenient objects for plane selection are displayed in the viewer:
.. image:: images/CoordinatePlanes.png
:align: center
-After the plane for sketch is selected the following property panel will be opened:
+After the plane for sketch is selected, the following property panel will be opened:
.. image:: images/SketchPanel.png
:align: center
.. centered::
Sketch general panel
-- **Reversed** check box - allows reversing the sketch plane normal
-- **Set plane view** button - switches the viewer to the top view for the sketch plane
-- **Show geometrical constraints** check box - turns on/off geometrical constraints displaying
-- **Show dimensional constraints** check box - turns on/off dimensional constraints displaying
-- **Show existing expressions** check box - turns on/off expressions displaying
+- **Reversed** check box - allows reversing the sketch plane normal;
+- **Set plane view** button - switches the viewer to the top view for the sketch plane;
+- **Show geometrical constraints** check box - displays/hides geometrical constraints:
+- **Show dimensional constraints** check box - displays/hides dimensional constraints;
+- **Show existing expressions** check box - displays/hides expressions.
-Now it is possible:
+Now it is possible to:
- create :ref:`sketch objects <sketch_objects>`
- create :ref:`constraints <sketch_constraints>`
- perform :ref:`sketch operations <sketch_operations>`
-To apply or cancel sketch creation use apply and cancel buttons from the
+To apply or cancel sketch creation use Apply and Cancel buttons from the
Sketch panel as well as equivalent buttons from Sketch toolbar.
-The Result of operation will be a COMPOUND. Result node in the object tree is located in
+The Result of operation will be a COMPOUND. In the object tree, Result node is located in
**Constructions** folder.
-Name is assigned automatically: **Sketch_1**, **Sketch_2**, ... both for Feature and Result.
+The Name is assigned automatically: **Sketch_1**, **Sketch_2**, ... both for Feature and Result.
**TUI Command**: *Sketch_1 = model.addSketch(PartOrPartSet, plane)*
Constraints are available and viewable during sketch creation or editing.
-The goal of constrains creation is to fix a sketch geometry, i.e. set degrees of freedom to zero.
+The goal of constraints creation is to fix sketch geometry, i.e. set degrees of freedom to zero.
If all degrees of freedom are eliminated, the sketch is fixed and displayed with green color.
Operations
----------
+Operations modify existing features of the sketch or create new ones by copying them.
The plug-in includes the following operations:
Angle constraint
================
-Angle constraint fixes angle between two lines.
+Angle constraint fixes the angle between two lines.
-| Angle between two lines is thought of as an angle between two vectors.
-| So each line is treated as a vector with starting point equal to the line start point
-and terminal point equal to the line end point.
+| Angle between two lines is seen as an angle between two vectors.
+| Each line is treated as a vector with start and end points equal to those of the line.
-To create Angle constraint in the active Sketch:
+To create an Angle constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Angle* item or
#. click **Angle** button in Sketch toolbar:
Input fields:
-- **Line 1** is the first line selected in the view
-- **Line 2** is the second line selected in the view
-- **Value** is an angle between the lines, could be modified to set the desirable value
-- **Angle type** is a type of angle measurement
+- **Line 1** is the first line selected in the view;
+- **Line 2** is the second line selected in the view;
+- **Value** is an angle between the lines, can be modified to set the desirable value;
+- **Angle type** is a type of angle measurement:
.. image:: images/angle_direct.png
:align: left
- **Direct** is an angle type measured directly between two lines.
+ **Direct** is the least angle between two lines;
.. image:: images/angle_complementary.png
:align: left
- **Complementary** zzzzzzzz.
+ **Complementary** is 180°- Direct angle between two lines;
.. image:: images/angle_backward.png
:align: left
- **Backward** zzzzzzzz.
-- **Text location** is a position of the angle value label relating to angle line (in the view)
+ **Backward** is 360°- Direct angle between two lines.
+- **Text location** is the position of the angle value label relatively to the angle line (in the view):
.. image:: images/location_left.png
:align: left
- **Left** inserts text at the left of the angle line.
+ **Left** inserts text to the left of the angle line;
.. image:: images/location_automatic.png
:align: left
- **Automatic** inserts text at the middle of the angle line if it has enough length, otherwise - to the left.
+ **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left;
.. image:: images/location_right.png
:align: left
**Right** inserts text to the right of the angle line.
-When both lines are selected angle value is displayed in the property panel and in the view.
+When both lines are selected, the angle value is displayed in the property panel and in the view.
When creating the constraint, after selection of two lines at the first time:
-- drag the angle presentation in the view to the desired position (by move mouse and click once)
+- drag the angle presentation in the view to the desired position and click once;
- set desirable angle value in the input field in the view and press **Enter** or just press **Enter** to keep the current angle
.. image:: images/Angle_field_view.png
.. centered::
Angle created
-**See Also** a sample TUI Script of a :ref:`tui_create_angle` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_angle` operation.
\ No newline at end of file
Arc
===
-The feature Arc creates an arc segment in the current Sketch.
+Arc feature creates an arc segment in the current Sketch.
-To add new Arc to the Sketch:
+To add a new Arc to the Sketch:
#. select in the Main Menu *Sketch - > Arc* item or
#. click **Arc** button in Sketch toolbar:
.. image:: images/arc_base_32x32.png
:align: left
-**By center and two points** creates an arc segment with the given center passing from the start point to the end point on the circumference.
+**By center and two points** creates an arc segment with the given center passing from the start point to the end point on the circle.
.. image:: images/arc_3pt_32x32.png
:align: left
-**By three points** creates an arc segment passing from the start point to end point through another point on the circumference.
+**By three points** creates an arc segment passing from the start point to end point through another point on the circle.
.. image:: images/arc_tang_32x32.png
:align: left
.. image:: images/Arc_panel_tang.png
:align: center
-Select point on segement in the view to set the tangent point, then move the mouse and click to set the end point.
-Tangent point by itself is a start point. The edge on which it lies will be tangent to the arc.
+Select a point on segment in the view to set the tangent point, then move the mouse and click to set the end point.
+The tangent point by itself is a start point. The edge on which it lies will be tangent to the arc.
- When entering a tangent point by selecting a point on segment, a Tangent constraint is created.
- When entering an end point by selecting a segment, a Coincident constraint is created.
.. centered::
Circle created
-**See Also** a sample TUI Script of a :ref:`tui_create_arc` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_arc` operation.
\ No newline at end of file
The feature Circle creates a circle in the current Sketch.
-To add new Circle to the Sketch:
+To add a new Circle to the Sketch:
#. select in the Main Menu *Sketch - > Circle* item or
#. click **Circle** button in Sketch toolbar:
.. image:: images/Circle_panel_edit.png
:align: center
-Note that the edition property panel doesn't show the creation algorithm used.
+Note that the edition property panel does not show the used creation algorithm.
The panel shows:
- center coordinates and radius (read-only).
-- auxiliary flag (could be modified).
+- auxiliary flag (can be modified).
Result
""""""
.. centered::
Circle created
-**See Also** a sample TUI Script of a :ref:`tui_create_circle` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_circle` operation.
Coincident constraint
=====================
-Coincident constraint makes two points to be coincident, or one point to lie on a line or circumference of a circle (or an arc).
+Coincident constraint forces two points to be coincident, or one point to lie on a line, a circle or an arc.
-To create Coincident in the active Sketch:
+To create a Coincident constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Coincident* item or
#. click **Coincident** button in Sketch toolbar:
Note that one of two objects should be a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
-After the objects are selected the point becomes yellow colored in the view.
+After the objects are selected, the point is highlighted in yellow in the view.
**TUI Command**: *Sketch_1.setCoincident(Object1, Object2)*
:align: center
.. centered::
- Coincident constraint created
+ Created coincident constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_coincident` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_coincident` operation.
\ No newline at end of file
Collinear constraint
====================
-Collinear constraint makes to lines collinear.
+Collinear constraint forces lines to be collinear.
-To create Collinear in the active Sketch:
+To create a Collinear constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Collinear* item or
#. click **Collinear** button in Sketch toolbar:
- **First line** is the first line selected in the view.
- **Second line** is the second line selected in the view.
-| After the lines are selected they becomes translated as to be collinear.
-| The lines are marked with the special sign.
+| 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)*
:align: center
.. centered::
- Collinear constraint created
+ Created collinear constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_collinear` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_collinear` operation.
Distance constraint
===================
-Distance constraint fixes distance between two objects.
+Distance constraint fixes the distance between two objects.
The constraint can be defined between such objects as point, line, line or arc end point, center of circle or arc.
-To create Distance constraint in the active Sketch:
+To create a Distance constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Distance* item or
#. click **Distance** button in Sketch toolbar:
Input fields:
-- **First object** is the first object selected in the view
-- **Second object** is the second object selected in the view
-- **Value** is a distance between the objects, could be modified to set the desirable value
-- **Text location** is a position of the distance value label relating to extension line (in the view)
+- **First object** is the first object selected in the view;
+- **Second object** is the second object selected in the view;
+- **Value** is a distance between the objects, can be modified to set the desirable value;
+- **Text location** is a position of the distance value label relating to extension line (in the view):
.. image:: images/location_left.png
:align: left
- **Left** inserts text at the left of the distance extension line.
+ **Left** inserts text to the left of the distance extension line;
.. image:: images/location_automatic.png
:align: left
- **Automatic** inserts text at the middle of the distance extension line if it has enough length, otherwise - to the left.
+ **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
.. image:: images/location_right.png
:align: left
- **Right** inserts text to the right of the distance extension line.
-- **Keep orientation** fixes the relative position between selected objects
+ **Right** inserts text to the right of the distance extension line;
+- **Keep orientation** fixes the relative position between selected objects.
-When both objects are selected distance value is displayed in the property panel and in the view.
+When both objects are selected, the distance value is displayed in the property panel and in the view.
-When creating the constraint, after selection of two objects at the first time:
+When creating a constraint after selection of two objects for the first time:
-- drag the distance presentation in the view to the desired position (by move mouse and click once)
-- set desirable distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
+- drag the distance presentation in the view to the desired position and click once;
+- set the desirable distance value in the input field and press **Enter** or just press **Enter** to keep the current distance.
.. image:: images/Distance_field_view.png
:align: center
.. centered::
Distance created
-**See Also** a sample TUI Script of a :ref:`tui_create_distance` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_distance` operation.
Equal constraint
================
-| Equal constraint makes lines, circles or arcs of equal size.
-| Lines becomes of equal length, circles and arcs - of equal radius.
+| Equal constraint makes lines, circles or arcs equal.
+| Lines become equal in length, circles and arcs - equal in radius.
-To create Equal in the active Sketch:
+To create an Equal constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Equal* item or
#. click **Equal** button in Sketch toolbar:
- **First object** is a line, a circle or an arc selected in the view.
- **Second object** is a line, a circle or an arc selected in the view.
-Note that a line could be equal to a line only, a circle - to a circle or an arc.
+Note that a line can be equal to a line only, a circle - to a circle or an arc.
-| After the objects are selected the object sizes become equal.
+| After the objects are selected, the object sizes become equal.
| The equal objects are marked with **=** sign.
**TUI Command**: *Sketch_1.setEqual(Object1, Object2)*
:align: center
.. centered::
- Equal constraint created
+ Created equal constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_equal` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_equal` operation.
\ No newline at end of file
| The Fillet operation rounds the corner formed by intersection of two sketch elements in a coincident point.
| The operation trims the elements at the intersection and creates a tangent arc between them.
-To create Fillet in the active Sketch:
+To create a Fillet in the active Sketch:
#. select in the Main Menu *Sketch - > Fillet* item or
#. click **Fillet** button in Sketch toolbar:
- **Point** is the coincident point of two intersecting lines (or a line and an arc) selected in the view.
-After the point is selected Fillet preview appears in the view.
+After the point is selected, Fillet preview appears in the view.
**TUI Command**:
:align: center
.. centered::
- Fillet created
+ Created fillet
-**See Also** a sample TUI Script of a :ref:`tui_create_fillet` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_fillet` operation.
\ No newline at end of file
The constraint can be defined for such objects as point, line, line or arc end point, center of circle or arc, whole circle or arc.
-To create Fixed constraint in the active Sketch:
+To create a Fixed constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Fixed* item or
#. click **Fixed** button in Sketch toolbar:
- **Object** is the object selected in the view.
-After the object is selected anchor sign will be added close to it in the view.
+After the object is selected, anchor sign will be added next to it in the view.
Selection rules:
:align: center
.. centered::
- Fixed constraint created
+ Created fixed constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_fixed` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fixed` operation.
Horizontal distance constraint
==============================
-Horizontal Distance constraint fixes distance between two points along the horizontal axis.
+Horizontal Distance constraint fixes the distance between two points along the horizontal axis.
The constraint can be defined between two points such as point object, line or arc end point, center of circle or arc.
-To create Horizontal Distance constraint in the active Sketch:
+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:
Input fields:
-- **First point** is the first point selected in the view
-- **Second point** is the second point selected in the view
-- **Value** is a distance between the objects, could be modified to set the desirable value
-- **Text location** is a position of the distance value label relating to extension line (in the view)
+- **First point** is the first point selected in the view;
+- **Second point** is the second point selected in the view;
+- **Value** is a distance between the objects, can be modified to set the desirable value;
+- **Text location** is a position of the distance value label relating to extension line (in the view):
.. image:: images/location_left.png
:align: left
- **Left** inserts text at the left of the distance extension line.
+ **Left** inserts text to the left of the distance extension line;
.. image:: images/location_automatic.png
:align: left
- **Automatic** inserts text at the middle of the distance extension line if it has enough length, otherwise - to the left.
+ **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
.. image:: images/location_right.png
:align: left
**Right** inserts text to the right of the distance extension line.
-When both objects are selected horizontal distance value is displayed in the property panel and in the view.
+When both objects are selected, the horizontal distance value is displayed in the property panel and in the view.
-When creating the constraint, after selection of two objects at the first time:
+When creating the constraint, after selection of two objects for the first time:
-- drag the horizontal distance presentation in the view to the desired position (by move mouse and click once)
-- set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
+- drag the horizontal distance presentation in the view to the desired position and click once;
+- set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
.. image:: images/HorizontalDistance_field_view.png
:align: center
.. centered::
Horizontal Distance created
-**See Also** a sample TUI Script of a :ref:`tui_create_hdistance` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation.
\ No newline at end of file
Horizontal constraint
=====================
-Horizontal constraint fixes lines to lie parallel to the horizontal axis.
+Horizontal constraint fixes lines as parallel to the horizontal axis.
-To create Horizontal constraint in the active Sketch:
+To create a Horizontal constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Horizontal* item or
#. click **Horizontal** button in Sketch toolbar:
- **Line** is the line selected in the view.
| After the line is selected it becomes parallel to the horizontal axis in the view.
-| **H** sign added above the line.
+| **H** sign is added above the line.
**TUI Command**: *Sketch_1.setHorizontal(LineObject)*
.. centered::
Horizontal constraint created
-**See Also** a sample TUI Script of a :ref:`tui_create_horizontal` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_horizontal` operation.
\ No newline at end of file
Intersection
============
-| The Intersection operation creates intersection of a 3D edge and the sketch plane.
-| The result of intersection is a point.
+| The Intersection operation creates an intersection of a 3D edge and the sketch plane.
+| The result of the intersection is a point.
-To create Intersection in the active Sketch:
+To create an Intersection in the active Sketch:
#. select in the Main Menu *Sketch - > Intersection* item or
#. click **Intersection** button in Sketch toolbar:
:align: center
.. centered::
- Intersection created (purple point)
+ Created intersection (purple point)
-**See Also** a sample TUI Script of a :ref:`tui_create_intersection` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_intersection` operation.
Length constraint
=================
-Length constraint fixes length of lines such as standalone line or rectangle side.
+Length constraint fixes the length of lines, such as standalone line or rectangle side.
-To create Length constraint in the active Sketch:
+To create a Length constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Length* item or
#. click **Length** button in Sketch toolbar:
Input fields:
-- **Line** is the the line object selected in the view
-- **Value** is a line length, could be modified to set the desirable value
-- **Text location** is a position of the length value label relating to extension line (in the view)
+- **Line** is the the line object selected in the view;
+- **Value** is a line length, can be modified to set the desirable value;
+- **Text location** is a position of the length value label relating to extension line (in the view):
.. image:: images/location_left.png
:align: left
- **Left** inserts text at the left of the length extension line.
+ **Left** inserts text to the left of the length extension line;
.. image:: images/location_automatic.png
:align: left
- **Automatic** inserts text at the middle of the length extension line if it has enough length, otherwise - to the left.
+ **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left;
.. image:: images/location_right.png
:align: left
**Right** inserts text to the right of the length extension line.
-When the line is selected length value is displayed in the property panel and in the view.
+When the line is selected, the length value is displayed in the property panel and in the view.
-When creating the constraint, after selection of a line at the first time:
+When creating the constraint, after selection of a line for the first time:
-- drag the length presentation in the view to the desired position (by move mouse and click once)
-- set desirable length value in the input field in the view and press **Enter** or just press **Enter** to keep the current length
+- drag the length presentation in the view to the desired position and click once;
+- set desirable length value in the input field in the view and press **Enter** or just press **Enter** to keep the current length.
.. image:: images/Length_field_view.png
:align: center
.. centered::
Length created
-**See Also** a sample TUI Script of a :ref:`tui_create_length` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_length` operation.
Line
====
-The feature Line creates a line segment by two points in the current Sketch.
+Line feature creates a line segment by two points in the current Sketch.
-To add new Line to the Sketch:
+To add a new Line to the Sketch:
#. select in the Main Menu *Sketch - > Line* item or
#. click **Line** button in Sketch toolbar:
.. centered::
**Line** button
-The following property panel appears.
+The following property panel appears:
.. image:: images/Line_panel.png
:align: center
.. centered::
Line
-Pick 2 points (start and end) in the view to create a Line. In the case of click on an existing object constraint for
-the point will be created automatically.
+Pick 2 points (start and end) in the view to create a Line. If an existing object is clicked, a constraint for the point will be created automatically.
Start and end points coordinates are displayed in the property panel.
.. centered::
Line created
-**See Also** a sample TUI Script of a :ref:`tui_create_line` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_line` operation.
Middle point constraint
=======================
-Middle point constraint makes one point to lie in the middle of a line.
+Middle point constraint forces a point to middle of a line.
-To create Middle point in the active Sketch:
+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:
- **First object** is a point or a line selected in the view.
- **Second object** is a point or a line selected in the view.
-Note that one of two objects should be a line and another one a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
+Note that one of two objects should be a line and the other a point (i.e. a point, a line or an arc end point, a center of a circle or an arc).
-| After the objects are selected the point becomes located in the middle of the line.
-| The middle point are marked with the special sign.
+| 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)*
:align: center
.. centered::
- Middle point constraint created
+ Created middle point constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_middle` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_middle` operation.
Mirror copy operation mirrors sketch entities across a line.
-To create Mirror copy in the active Sketch:
+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:
Created Mirror copy appears in the view.
-| The original and a mirror copy objects are marked with the special sign.
+| The original and the mirror copy objects are marked with a special sign.
| Copy object is drawn with a thinner line.
.. image:: images/Mirror_res.png
.. centered::
Mirror copy created
-**See Also** a sample TUI Script of a :ref:`tui_create_mirror` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_mirror` operation.
\ No newline at end of file
Parallel constraint
===================
-Parallel constraint fixes two lines to lie parallel to one another.
+Parallel constraint fixes two lines as parallel to one another.
-To create Parallel in the active Sketch:
+To create a Parallel constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Parallel* item or
#. click **Parallel** button in Sketch toolbar:
:align: center
.. centered::
- Parallel constraint created
+ Created parallel constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_parallel` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_parallel` operation.
\ No newline at end of file
Perpendicular constraint
========================
-Perpendicular constraint fixes two lines to lie at 90 degrees to one another.
+Perpendicular constraint fixes two lines at 90 degrees to one another.
-To create Perpendicular in the active Sketch:
+To create a Perpendicular constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Perpendicular* item or
#. click **Perpendicular** button in Sketch toolbar:
- **First line** is the first line selected in the view.
- **Second line** is the second line selected in the view.
-After the lines are selected the special sign will be added to each of them in the view.
+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)*
:align: center
.. centered::
- Perpendicular constraint created
+ Created perpendicular constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_perpendicular` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_perpendicular` operation.
Point
=====
-The feature Point creates a point in the current Sketch.
+Point feature creates a point in the current Sketch.
-To add new Point to the Sketch:
+To add a new Point to the Sketch:
#. select in the Main Menu *Sketch - > Point* item or
#. click **Point** button in Sketch toolbar:
.. centered::
**Point** button
-The following property panel appears.
+The following property panel appears:
.. image:: images/Point_panel.png
:align: center
.. centered::
Point
-Clicking in the view creates a point preview. In the case of click on an existing object constraint for
+Clicking in the view creates a point preview. If an existing object is clicked, a constraint for
the point will be created automatically.
The point coordinates are displayed in the property panel.
.. centered::
Point created
-**See Also** a sample TUI Script of a :ref:`tui_create_point` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_point` operation.
\ No newline at end of file
Projection
==========
-| The Projection operation creates projection of 3D edge or vertex onto the sketch plane.
+| The Projection operation creates a projection of 3D edge or vertex onto the sketch plane.
| The result of projection is a line.
-To create Projection in the active Sketch:
+To create a Projection in the active Sketch:
#. select in the Main Menu *Sketch - > Projection* item or
#. click **Projection** button in Sketch toolbar:
:align: center
.. centered::
- Projection created (purple line)
+ Created projection (purple line)
-**See Also** a sample TUI Script of a :ref:`tui_create_projection` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_projection` operation.
\ No newline at end of file
Radius constraint
=================
-Radius constraint fixes radius of circle or arc.
+Radius constraint fixes the radius of circle or arc.
-To create Radius constraint in the active Sketch:
+To create a Radius constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Radius* item or
#. click **Radius** button in Sketch toolbar:
Input fields:
-- **Circle or Arc** is the circe or arc circumference selected in the view
+- **Circle or Arc** is the circle or arc selected in the view;
- **Value** is a radius of the selected object, could be modified to set the desirable value
- **Text location** is a position of the radius value label relating to extension line (in the view)
.. image:: images/location_left.png
:align: left
**Right** inserts text to the right of the radius extension line.
-When circle or arc is selected radius value is displayed in the property panel and in the view.
+When circle or arc is selected, the radius value is displayed in the property panel and in the view.
When creating the constraint, after selection of the circle or arc at the first time :
-- drag the radius presentation in the view to the desired position (by move mouse and click once)
-- set desirable radius value in the input field in the view and press **Enter** or just press **Enter** to keep the current radius
+- drag the radius presentation in the view to the desired position and click once;
+- set desirable radius value in the input field in the view and press **Enter** or just press **Enter** to keep the current radius.
.. image:: images/Radius_field_view.png
:align: center
.. centered::
Radius created
-**See Also** a sample TUI Script of a :ref:`tui_create_radius` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_radius` operation.
Rectangle
=========
-The feature Rectangle creates a rectangle by two opposite points in the current Sketch.
+Rectangle feature creates a rectangle by two opposite points in the current Sketch.
-The result is represented in the form of four Lines which compose a rectangle.
-Two of the lines have Vertical constraint and two others have Horizontal constraint.
+The result is represented in form of four Lines which compose a rectangle.
+Two lines have Vertical constraint and two others have Horizontal constraint.
-To add new Rectangle to the Sketch:
+To add a new Rectangle to the Sketch:
#. select in the Main Menu *Sketch - > Rectangle* item or
#. click **Rectangle** button in Sketch toolbar:
.. centered::
**Rectangle** button
-The following property panel appears.
+The following property panel appears:
.. image:: images/Rectangle_panel.png
:align: center
Rectangle
Click in the view once to set the first corner, then move the mouse and click a second time to set the opposite corner.
-In the case of click on an existing object constraint for the point will be created automatically.
+If an existing object is clicked, a constraint for the point will be created automatically.
Start and end points coordinates are displayed in the property panel.
.. centered::
Rectangle created
-**See Also** a sample TUI Script of a :ref:`tui_create_rectangle` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation.
\ No newline at end of file
Angular copy
============
-Angular copy operation creates one or multiple copies of the skecth entities by rotation relative to a specified center point.
+Angular copy operation creates one or multiple copies of the sketch entities by rotation relative to a specified center point.
-To create Angular copy in the active Sketch:
+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:
Input fields:
-- **Segments** is the list of segments (lines, circles, arcs) selected in the view.
-- **Center of rotation** is the center point selected in the view.
+- **Segments** is the list of segments (lines, circles, arcs) selected in the view;
+- **Center of rotation** is the center point selected in the view;
- **Full angle/Single angle** option:
.. image:: images/angle_up_full_32x32.png
**Single angle**: angle step of rotation is equal to the defined angle.
- **Angle** is the angle of rotation.
-- **Reversed** defines rotation direction. If checked - in clockwise direction, otherwise - in a counterclockwise direction.
+- **Reversed** defines rotation direction. If checked - in a clockwise direction, otherwise - in a counterclockwise direction.
- **Total number of objects** is the total number of objects including the original one.
Created Angular copy appears in the view.
-| The original and an angular copy objects are marked with the special sign.
+| The original and an angular copy objects are marked with a special sign.
| Copy objects are drawn with a thinner line.
.. image:: images/Rotation_res.png
:align: center
.. centered::
- Angular copy created
+ Created angular copy
-**See Also** a sample TUI Script of a :ref:`tui_create_rotation` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_rotation` operation.
| The curve should have points lying on it.
| Open curves (line or arc) require one or more points to split with; closed curves (circle) require two or more points.
-To create Split in the active Sketch:
+To create a Split in the active Sketch:
#. select in the Main Menu *Sketch - > Split* item or
#. click **Split** button in Sketch toolbar:
**TUI Command**: *Sketch_1.addSplit(Feature, PositionPoint)*
-**Arguments**: feature (line, arc or circle) and position point (a point on or closest to the segment to split off)
+**Arguments**: feature (line, arc or circle) and position point (a point on the segment to split off or closest to it)
Result
""""""
:align: center
.. centered::
- Split created
+ Created split
-**See Also** a sample TUI Script of a :ref:`tui_create_split` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_split` operation.
\ No newline at end of file
Tangent constraint fixes a circle (or an arc) and a line so that a line is tangent to a circle (or an arc).
-To create Tangent in the active Sketch:
+To create a Tangent in the active Sketch:
#. select in the Main Menu *Sketch - > Tangent* item or
#. click **Tangent** button in Sketch toolbar:
Note that one of two objects should be a line.
-After the objects are selected the special sign will be added close to the tangency point in the view.
+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)*
:align: center
.. centered::
- Tangent constraint created
+ Created tangent constraint
-**See Also** a sample TUI Script of a :ref:`tui_create_tangent` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_tangent` operation.
Linear copy
===========
-Linear copy operation creates one or multiple copies of the skecth entities along a vector defined by two points.
+Linear copy operation creates one or multiple copies of the sketch entities along a vector defined by two points.
-To create Linear copy in the active Sketch:
+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:
Created Linear copy appears in the view.
-| The original and a linear copy objects are marked with the special sign.
+| The original and a linear copy objects are marked with a special sign.
| Copy objects are drawn with a thinner line.
.. image:: images/Linear_res.png
.. centered::
Linear copy created
-**See Also** a sample TUI Script of a :ref:`tui_create_translation` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_translation` operation.
| The curve should have points lying on it or intersections with other curves.
| Open curves (line or arc) require one or more points; closed curves (circle) require two or more points.
-To create Trim in the active Sketch:
+To create a Trim in the active Sketch:
#. select in the Main Menu *Sketch - > Trim* item or
#. click **Trim** button in Sketch toolbar:
:align: center
.. centered::
- Trim created
+ Created trim
-**See Also** a sample TUI Script of a :ref:`tui_create_trim` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_trim` operation.
Vertical distance constraint
============================
-Vertical Distance constraint fixes distance between two points along the vertical axis.
+Vertical Distance constraint fixes the distance between two points along the vertical axis.
The constraint can be defined between two points such as point object, line or arc end point, center of circle or arc.
-To create Vertical Distance constraint in the active Sketch:
+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:
Input fields:
-- **First point** is the first point selected in the view
-- **Second point** is the second point selected in the view
-- **Value** is a distance between the objects, could be modified to set the desirable value
-- **Text location** is a position of the distance value label relating to extension line (in the view)
+- **First point** is the first point selected in the view;
+- **Second point** is the second point selected in the view:
+- **Value** is a distance between the objects, can be modified to set the desirable value;
+- **Text location** is a position of the distance value label relating to extension line (in the view):
.. image:: images/location_left.png
:align: left
- **Left** inserts text at the left of the distance extension line.
+ **Left** inserts text to the left of the distance extension line:
.. image:: images/location_automatic.png
:align: left
- **Automatic** inserts text at the middle of the distance extension line if it has enough length, otherwise - to the left.
+ **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left
.. image:: images/location_right.png
:align: left
**Right** inserts text to the right of the distance extension line.
-When both objects are selected vertical distance value is displayed in the property panel and in the view.
+When both objects are selected, the vertical distance value is displayed in the property panel and in the view.
-When creating the constraint, after selection of two objects at the first time:
+When creating the constraint, after selection of two objects for the first time:
-- drag the Vertical distance presentation in the view to the desired position (by move mouse and click once)
-- set desirable vertical distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
+- drag the Vertical distance presentation in the view to the desired position and click once;
+- set desirable vertical distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
.. image:: images/VerticalDistance_field_view.png
:align: center
.. centered::
Vertical Distance created
-**See Also** a sample TUI Script of a :ref:`tui_create_vdistance` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_vdistance` operation.
Vertical constraint
===================
-Vertical constraint fixes lines to lie parallel to the vertical axis.
+Vertical constraint fixes lines as parallel to the vertical axis.
-To create Vertical constraint in the active Sketch:
+To create a Vertical constraint in the active Sketch:
#. select in the Main Menu *Sketch - > Vertical* item or
#. click **Vertical** button in Sketch toolbar:
- **Line** is the line selected in the view.
| After the line is selected it becomes parallel to the vertical axis in the view.
-| **V** sign added above the line.
+| **V** sign is added above the line.
**TUI Command**: *Sketch_1.setVertical(LineObject)*
.. centered::
Vertical constraint created
-**See Also** a sample TUI Script of a :ref:`tui_create_vertical` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_vertical` operation.
\ No newline at end of file
