\r
.. _introduction:\r
\r
-\r
Introduction to SHAPER\r
======================\r
\r
\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
+ \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
-\r
Application desktop\r
-------------------\r
\r
- :ref:`toolbar`; \r
- status bar. \r
\r
-.. image:: images/main_window.png\r
+.. figure:: images/main_window.png\r
:align: center\r
\r
-.. centered::\r
Main window of SHAPER module\r
-\r
\r
.. _main_menu:\r
\r
\r
Main menu provides access to all commands of the application.\r
\r
-.. image:: images/main_menu.png\r
+.. figure:: images/main_menu.png\r
:align: center\r
\r
-.. centered::\r
Main menu\r
\r
Main menu includes standard Salome items:\r
- modules toolbar;\r
- SHAPER toolbar.\r
\r
-.. image:: images/toolbar.png\r
+.. figure:: images/toolbar.png\r
:align: center\r
\r
-.. centered::\r
Toolbars\r
\r
SHAPER toolbar duplicates the main menu and provides access to all commands of the application.\r
- Macros. \r
\r
Visibility of SHAPER toolbar sections is managed using *View -> Toolbar* :ref:`main_menu` item or toolbar pop-up menu.\r
- \r
- \r
+\r
.. _doc_windows:\r
\r
Dock windows\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
-.. image:: images/popup_menu.png\r
+.. figure:: images/popup_menu.png\r
:align: center\r
\r
-.. centered::\r
Pop-up menu for visibility of windows and toolbars\r
\r
-\r
.. _object_browser: \r
\r
Object browser\r
\r
Documents with branches are shown in Tree View.\r
\r
-.. image:: images/object_browser.png\r
+.. figure:: images/object_browser.png\r
:align: center\r
\r
-.. centered::\r
- Object browser. Partset active\r
-\r
+ **Object browser**: Partset active\r
\r
Partset includes three branches:\r
\r
\r
Each feature, result, construction, group, field, parameter can be renamed using *Rename* pop-up menu command.\r
\r
-.. image:: images/popup_menu_object_browser_feature.png\r
+.. figure:: images/popup_menu_object_browser_feature.png\r
:align: center\r
\r
-.. centered::\r
- Feature pop-up menu\r
+ **Feature** pop-up menu\r
\r
-.. image:: images/popup_menu_object_browser_result.png\r
+.. figure:: images/popup_menu_object_browser_result.png\r
:align: center\r
\r
-.. centered::\r
- Result pop-up menu\r
+ **Result** pop-up menu\r
\r
-.. image:: images/popup_menu_object_browser_construction.png\r
+.. figure:: images/popup_menu_object_browser_construction.png\r
:align: center\r
\r
-.. centered::\r
- Construction pop-up menu\r
+ **Construction** pop-up menu\r
\r
The order of features can be changed using *Move to the end* and *Move to the end and split* pop-up menu commands. They work only for Group features. The selected group or several groups will be moved to the end of features list. The *Move to the end and split* also splits the resulting group in several groups: one group per one selection.\r
\r
Folders can be used to arrange long Tree View for features.\r
\r
-.. image:: images/object_browser_folder.png\r
+.. figure:: images/object_browser_folder.png\r
:align: center\r
\r
-.. centered::\r
- Object browser with folder Dome. Part_1 active\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. The folder can be renamed.\r
\r
\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
+.. figure:: images/clean_history.png\r
:align: center\r
\r
-.. centered::\r
**Clean history** dialog box\r
\r
-\r
*Select result* and *Select parent feature* pop-up menu commands help to navigate along Tree View.\r
\r
-\r
A feature and its result can be deleted using *Delete* pop-up menu command.\r
\r
Note that all features using the removed feature and their results will be removed simultaneously.\r
\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
+.. figure:: images/delete_feature.png\r
:align: center\r
\r
-.. centered::\r
**Delete feature** dialog box\r
\r
.. _property_panel:\r
Property panel\r
^^^^^^^^^^^^^^\r
\r
+.. |ok_btn| image:: images/button_ok.png\r
+.. |cancel_btn| image:: images/button_cancel.png\r
+.. |help_btn| image:: images/button_help.png\r
+\r
Property panel consists of two parts:\r
\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
- :align: left\r
- **Ok/Apply** executes operation with defined parameters,\r
-\r
-\r
- .. image:: images/button_cancel.png\r
- :align: left\r
- **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, \r
-\r
- .. image:: images/button_help.png\r
- :align: left\r
- **Help** calls User's guide opened on page describing the current operation.\r
-\r
-.. image:: images/abort_operation.png\r
- :align: center\r
-\r
-.. centered::\r
- **Abort operation** dialog box\r
+ | |ok_btn| **Ok/Apply** executes operation with defined parameters,\r
+ | |cancel_btn| **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, \r
+ | |help_btn| **Help** calls User's guide opened on page describing the current operation.\r
\r
+ .. figure:: images/abort_operation.png\r
+ :align: center\r
+ \r
+ **Abort operation** dialog box\r
\r
-.. image:: images/button_ok.png\r
- :align: left\r
-**OK/Apply** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in status bar.\r
+|ok_btn| **OK/Apply** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in status bar.\r
\r
.. _inspection_panel: \r
\r
\r
Inspection panel provides the list of types and quantities of all topological entities, composing the selected result, construction or feature.\r
\r
-.. image:: images/inspection_panel.png\r
+.. figure:: images/inspection_panel.png\r
:align: center\r
\r
-.. centered::\r
- Inspection panel for default Box\r
+ **Inspection panel** for default Box\r
\r
**Object** displays name of the selected result, construction or feature.\r
\r
\r
The information about Point, Axis or Edge additionally shows coordinates of point / end points.\r
\r
-.. image:: images/inspection_panel_line.png\r
+.. figure:: images/inspection_panel_line.png\r
:align: center\r
\r
-.. centered::\r
- Inspection panel for Axis\r
+ **Inspection panel** for Axis\r
\r
-\r
The information about Plane, Face additionally shows coordinates of center point and direction of normal.\r
\r
-.. image:: images/inspection_panel_face.png\r
+.. figure:: images/inspection_panel_face.png\r
:align: center\r
\r
-.. centered::\r
- Inspection panel for Face \r
+ **Inspection panel** for Face \r
\r
.. _hidefaces_panel:\r
\r
\r
**Hide Faces** panel makes possible to hide temporary faces of any displayed object. **Hide Faces** panel looks like following:\r
\r
-.. image:: images/hide_faces_panel.png\r
+.. figure:: images/hide_faces_panel.png\r
:align: center\r
\r
-.. centered::\r
- Hide Faces panel\r
+ **Hide Faces** panel\r
\r
- If this panel is activated it "listens" user selection.\r
- If a face is selected then its name will be shown in the panel's list and hidden in the viewer. \r
Also it is possible do not to hide faces, but make them transparent. For this purpose **"Transparent"** check-box can be used. Value of the transparency can be changed in **Visualization** tab of **Preferences** dialog box.\r
Closing of **Hide Faces** panel restores visibility state of all objects. If it is necessary to deactivete the **Hide Faces** panel (preserving the current display state) then user has to press **"Esc"** button.\r
\r
-\r
.. _python console:\r
\r
Python console\r
- Dump commands from console into the specified file;\r
- Start/Stop writing log into the specified file. \r
\r
-\r
-.. image:: images/python_console_popup.png\r
+.. figure:: images/python_console_popup.png\r
:align: center\r
\r
-.. centered::\r
Pop-up menu of Python console\r
\r
.. _viewer:\r
\r
This point of view can be modified using viewer commands: **Panning**, **Zooming**, **Scaling**, etc.\r
\r
-\r
-.. image:: images/2_viewers.png\r
+.. figure:: images/2_viewers.png\r
:align: center\r
\r
-.. centered::\r
Two view windows\r
\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
Parameters \r
\r
The list of features using parameters is given in **Parameters** dialog box:\r
\r
- .. image:: images/parameters_feature.png\r
+ .. figure:: images/parameters_feature.png\r
:align: center\r
\r
-.. centered::\r
Parameters dialog box\r
\r
If a parameter value is changed, then all features where it is used are rebuilt.\r
\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
+.. figure:: images/delete_parameter.png\r
:align: center\r
\r
-.. centered::\r
Delete parameter\r
\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
This tab defines presentation of objects displayed in OCC 3D viewer.\r
\r
-.. image:: images/visualization_preferences.png\r
+.. figure:: images/visualization_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Visualization tab\r
+ **Preferences**: Visualization tab\r
\r
**Input fields**:\r
\r
\r
To redefine any color click on the corresponding line to access **Select color** dialog box\r
\r
-.. image:: images/select_color.png\r
+.. figure:: images/select_color.png\r
:align: center\r
\r
-.. centered::\r
- **Select color** dialog box\r
+ **Preferences**: **Select color** dialog box\r
\r
Preferences for sketch are applicable during sketch creation/edition operation.\r
\r
^^^^^^^^^^^\r
Plugins tab defines folders where plugins and resources are located.\r
\r
-.. image:: images/plugins_preferences.png\r
+.. figure:: images/plugins_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Plugins tab\r
+ **Preferences**: Plugins tab\r
\r
**Input fields**:\r
\r
\r
- **Import initial directory** selects default folder where resources are located. Click on **Open** button opens standard **Find directory** dialog box to navigate to desired folder.\r
\r
-.. image:: images/open_button.png\r
+.. figure:: images/open_button.png\r
:align: center\r
\r
-.. centered::\r
**Open** button\r
\r
-.. image:: images/find_directory.png\r
+.. figure:: images/find_directory.png\r
:align: center\r
\r
-.. centered::\r
**Find directory** dialog box\r
\r
\r
\r
Shortcuts tab defines shortcut keys for different operations.\r
\r
-.. image:: images/shortcuts_preferences.png\r
+.. figure:: images/shortcuts_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Shortcuts tab\r
+ **Preferences**: Shortcuts tab\r
\r
- **Add parameter in parameters manager dialog** defines shortcut keys for adding parameter in parameters manager dialog box.\r
\r
\r
Windows tab contains definitions for the module windows management.\r
\r
-.. image:: images/windows_preferences.png\r
+.. figure:: images/windows_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Windows tab\r
+ **Preferences**: Windows tab\r
\r
- **Use HideFaces panel in operation** if the checkbox is checked then HideFaces panel will be launched automatically on launching an operation where using of this panel is considered.\r
\r
\r
Sketch tab defines properties of coordinate planes shown for selection of sketch plane when no convenient objects are shown in OCC 3D viewer.\r
\r
-.. image:: images/sketch_preferences.png\r
+.. figure:: images/sketch_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Sketch tab\r
+ **Preferences**: Sketch tab\r
\r
**Input fields**:\r
\r
- **Default spline weight** defines default weight for B-spline nodes during creation. The default value can be changed by editing of the spline;\r
- **Cursor for sketch operation** defines a cursor which indicates a launched sketcher sub-operation.\r
- **Create sketch entities by dragging** defines a style of sketch etities creation. It concerns creation of lines, rectangles, circles, arcs, ellipses, elliptic arcs. If it is switched ON then points of objects have to be defined by mouse press - mouse move - mouse release. Otherwise every point of an object has to be defined by mouse click;\r
-\r
\r
.. _viewer_preferences:\r
\r
\r
Viewer tab defines selection in OCC 3D viewer properties. \r
\r
-.. image:: images/viewer_preferences.png\r
+.. figure:: images/viewer_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Viewer tab \r
+ **Preferences**: Viewer tab \r
\r
**Input fields**:\r
\r
- **Vertex** defines selection sensitivity for vertices; \r
- **Edge** defines selection sensitivity for edges. \r
\r
-\r
.. _toolbars_management:\r
\r
Toolbars management\r
To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item. \r
The following dialog box with existing toolbars appears:\r
\r
-.. image:: images/Toolbars.png\r
+.. figure:: images/Toolbars.png\r
:align: center\r
\r
-.. centered::\r
**Toolbars** dialog box\r
\r
**Input fields**:\r
- **OK** button closes the dialog box, stores result of tool bars edition and updates Shaper tool bars;\r
- **Cancel** button closes the dialog box without modification of tool bars.\r
\r
-.. image:: images/delete_toolbar.png\r
+.. figure:: images/delete_toolbar.png\r
:align: center\r
\r
-.. centered::\r
- Warning dialog box\r
-\r
+ Warning dialog box\r
\r
.. _create_toolbar:\r
\r
\r
**Input fields** of **Create toolbar** dialog box:\r
\r
-.. image:: images/create_toolbar.png\r
+.. figure:: images/create_toolbar.png\r
:align: center\r
\r
-.. centered::\r
**Create toolbar** dialog box\r
\r
- **Name of a new toolbar** defines name of the new tool bar. The name of tool bar has to be unique. If user defines a not unique name then a warning appears and a new tooolbar with not unique name is not created;\r
- **Ok** button closes the dialog box and add a new tool bar of the module into **Toolbars** window;\r
- **Cancel** button closes the dialog box without addition of a new tool bar.\r
\r
-.. image:: images/name_toolbar.png\r
+.. figure:: images/name_toolbar.png\r
:align: center\r
\r
-.. centered::\r
**Warning** dialog box\r
- \r
\r
.. _edit_toolbar:\r
\r
\r
**Input fields** of **Edit toolbar** dialog box:\r
\r
-.. image:: images/EditToolbar.png\r
+.. figure:: images/EditToolbar.png\r
:align: center\r
\r
-.. centered::\r
**Edit toolbar** dialog box\r
\r
- **Toolbar name** non-editable field displays name of modified tool bar;\r
- **Up** and **Down** buttons change position of selected command in **In the toolbar** window;\r
- **Ok** button closes the dialog box, stores result of edition;\r
- **Cancel** button closes the dialog box without modification of tool bar content.\r
-\r
-\r
This exercise illustrates how to create screw-nut shape from scratch.
-Step1. Sketch.
+Step 1. Sketch
--------------
At this step we will create a regular hexagon.
- Select **XOY** plane in the view
- Click **Set plane view** button in the Sketch property panel
-.. image:: images/tutorial1_1.png
+.. figure:: images/tutorial1_1.png
:align: center
-.. centered::
Skecth plane XOY
+
- Start :ref:`Line <sketchLine>` creation via Main Menu *Sketch - > Line*
- Pick 3 points in the view one by one and select the first one at the end to get a triangle:
-.. image:: images/tutorial1_2.png
+.. figure:: images/tutorial1_2.png
:align: center
-.. centered::
3 Lines forming a triangle
+
- Hide trihedron via **Show/Hide trihedron** button in viewer toolbar
- Select **Origin** object from **Part set / Constructions** folder in the object browser
- Click on the eye icon on the left of the origin item to show it in the view
- Select both origin and the bottom vertex of the triangle in the view (use **Shift** key for multi-selection)
-.. image:: images/tutorial1_3.png
+.. figure:: images/tutorial1_3.png
:align: center
-.. centered::
Origin and triangle
+
- Create :ref:`Coincident <sketchCoincident>` constraint via **Coincident** button in Sketch toolbar
-.. image:: images/tutorial1_4.png
+
+.. figure:: images/tutorial1_4.png
:align: center
-.. centered::
Triangle vertex coincident with origin
+
- Show trihedron
- Select both **OY** axis and the upper side of the triangle in the view
- Create :ref:`Perpendicular <sketchPerpendicular>` constraint via **Pependicular** button in Sketch toolbar
-.. image:: images/tutorial1_5.png
+
+.. figure:: images/tutorial1_5.png
:align: center
-.. centered::
Upper triangle side perpendicular to OY axis
+
- Select the left and the upper side of the triangle
- Create :ref:`Equal <sketchEqual>` constraint via **Equal** button in Sketch toolbar
- Make the upper and the right sides equal length in the same way
-.. image:: images/tutorial1_6.png
+
+.. figure:: images/tutorial1_6.png
:align: center
-.. centered::
Equilateral triangle
+
- Select the left side of the triangle
- Check **Auxiliary** check box in the property panel and click **Apply** button
-.. image:: images/tutorial1_7.png
+
+.. figure:: images/tutorial1_7.png
:align: center
-.. centered::
Line property panel
+
- Make the right side auxiliary in the same way
-.. image:: images/tutorial1_8.png
+
+.. figure:: images/tutorial1_8.png
:align: center
-.. centered::
The lateral sides are auxiliary
+
- Start creation of :ref:`Angular copy <sketchAngularCopy>` feature via **Angular copy** button in Sketch toolbar
- Select the upper side of the triangle for **Segments** parameter in the property panel
- Select origin in the view as a center of rotation
- Set **Total number** of objects equal to 6
-.. image:: images/tutorial1_9.png
+
+.. figure:: images/tutorial1_9.png
:align: center
-.. centered::
Angular copy parameters
+
- Click **Apply** button
-.. image:: images/tutorial1_10.png
+
+.. figure:: images/tutorial1_10.png
:align: center
-.. centered::
Regular hexagon
+
- Select the upper side of the hexagon
- Start creation of :ref:`Length <sketchLength>` constraint via **Length** button in Sketch toolbar
- Set length expression equal to "a=115.4" and press **Enter**
-.. image:: images/tutorial1_11.png
+
+.. figure:: images/tutorial1_11.png
:align: center
-.. centered::
Fully fixed regular hexagon
+
- Click **Apply** button in the *Skecth* property panel to finish the sketch creation
-.. image:: images/tutorial1_12.png
+
+.. figure:: images/tutorial1_12.png
:align: center
-.. centered::
Finished Sketch
+
- Check item corresponding to the created parameter **a** under **Part_1 / Parameters** node
-.. image:: images/tutorial1_13.png
+
+.. figure:: images/tutorial1_13.png
:align: center
-.. centered::
Parameter created during the Sketch operation
-Step2. Polyline.
+Step 2. Polyline
----------------
- Start :ref:`Parameter <parameter>` creation via Main Menu *Part - > Parameter*
- Set parameter name = "h", set parameter expression = "90", set comment = "nut height"
-.. image:: images/tutorial2_0.png
+
+.. figure:: images/tutorial2_0.png
:align: center
-.. centered::
Creation of parameter h = 90
+
- Click **Apply** button to finish parameter creation
- Start :ref:`Point <constructionPoint>` creation via Main Menu *Construction - > Point*
- Set x = 50, y = 0, z = 0
-.. image:: images/tutorial2_1.png
+
+.. figure:: images/tutorial2_1.png
:align: center
-.. centered::
Construction of point (50, 0, 0)
+
- Click **Apply** button to finish point creation
- Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, h), (50, 0, h) in the same way
- Select the created points in the object browser under **Part_1 / Constructions** node
- Click right mouse button and select **Color...** item in the popup menu
- Select blue color and click **OK** button
-.. image:: images/tutorial2_2.png
+
+.. figure:: images/tutorial2_2.png
:align: center
-.. centered::
Points created from scratch
+
- Start :ref:`Polyline <buildPolyline>` creation via Main Menu *Build - > Polyline*
- Select all the 7 points (use **Shift** key for multi-selection)
- Check **Closed** check box
-.. image:: images/tutorial2_3.png
+
+.. figure:: images/tutorial2_3.png
:align: center
-.. centered::
Creation of closed polyline from 7 points
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial2_4.png
+
+.. figure:: images/tutorial2_4.png
:align: center
-.. centered::
Closed Polyline
-Step3. Face.
+Step 3. Face
------------
- Start :ref:`Face <buildFace>` creation via Main Menu *Build - > Face*
- Select **Polyline_1_1** in the object browser under **Part_1 / Results** node
-.. image:: images/tutorial3_1.png
+
+.. figure:: images/tutorial3_1.png
:align: center
-.. centered::
Construction of face from a polyline
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial3_2.png
+
+.. figure:: images/tutorial3_2.png
:align: center
-.. centered::
Face
-Step4. Revolution.
+Step 4. Revolution
------------------
- Start :ref:`Revolution <featureRevolution>` creation via Main Menu *Features - > Revolution*
- Select the face created at step 3 in the view
- Click on axis input field in the property panel and select **OZ** axis in the view
-.. image:: images/tutorial4_1.png
+
+.. figure:: images/tutorial4_1.png
:align: center
-.. centered::
Revolution around OZ by 360 degrees
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial4_2.png
+
+.. figure:: images/tutorial4_2.png
:align: center
-.. centered::
Solid created by rotation of face
-Step5. Extrusion.
+Step 5. Extrusion
-----------------
- Start :ref:`Extrusion <featureExtrusion>` creation via Main Menu *Features - > Extrusion*
- Check **By bounding planes and offsets option**
- Select the bottom face of the revolution shape as **From** plane
- Select the top face of the revolution shape as **To** plane
-.. image:: images/tutorial5_1.png
+
+.. figure:: images/tutorial5_1.png
:align: center
-.. centered::
Extrusion along OZ axis by bounding planes
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial5_2.png
+
+.. figure:: images/tutorial5_2.png
:align: center
-.. centered::
Solid created by extrusion of sketch
-Step6. Common.
+Step 6. Common
--------------
- Start :ref:`Common <featureCommon>` creation via Main Menu *Features - > Common*
- Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection)
-.. image:: images/tutorial6_1.png
+
+.. figure:: images/tutorial6_1.png
:align: center
-.. centered::
Common creation
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial6_2.png
+
+.. figure:: images/tutorial6_2.png
:align: center
-.. centered::
The revolution and the extrusion common part
-Step7. Fillet.
+Step 7. Fillet
--------------
- Start :ref:`Fillet <featureFillet>` creation via Main Menu *Features - > Fillet*
- Select the edge
-.. image:: images/tutorial7_1.png
+
+.. figure:: images/tutorial7_1.png
:align: center
-.. centered::
Select edge for a Fillet
+
- Select **Radius** parameter equal to 10
-.. image:: images/tutorial7_2.png
+
+.. figure:: images/tutorial7_2.png
:align: center
-.. centered::
Fillet with radius = 10
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial7_3.png
+
+.. figure:: images/tutorial7_3.png
:align: center
-.. centered::
Fillet
-Step8. Box.
+Step 8. Box
-----------
- Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view
- Start :ref:`Box <box_feature>` creation via Main Menu *Primitives - > Box*
- Set **DX** = 10, **DY** = 120, **DZ** = 20
-.. image:: images/tutorial8_1.png
+
+.. figure:: images/tutorial8_1.png
:align: center
-.. centered::
Box creation
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial8_2.png
+
+.. figure:: images/tutorial8_2.png
:align: center
-.. centered::
Box
-Step9. Translation.
+Step 9. Translation
-------------------
- Start :ref:`Translation <featureTranslation>` creation via Main Menu *Part - > Translation*
- Check **By X, Y and Z dimensions** option on the top of the property panel
- Select the box in the view
- Set **DX** = -10, **DY** = 20, **DZ** = 70
-.. image:: images/tutorial9_1.png
+
+.. figure:: images/tutorial9_1.png
:align: center
-.. centered::
Box translation
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial9_2.png
+
+.. figure:: images/tutorial9_2.png
:align: center
-.. centered::
Translated Box
-Step10. Angular Copy.
+Step 10. Angular Copy
---------------------
- Start :ref:`Angular Copy <featureAngularCopy>` creation via Main Menu *Part - > Angular Copy*
- Select the box in the view
- Click on axis input field in the property panel and select **OZ** axis in the view
- Set **Nb copies** parameter equal to 6
-.. image:: images/tutorial10_1.png
+
+.. figure:: images/tutorial10_1.png
:align: center
-.. centered::
Angular Copy around OZ
+
- Click **Apply** button in the property panel
-.. image:: images/tutorial10_2.png
+
+.. figure:: images/tutorial10_2.png
:align: center
-.. centered::
Copied Box
-Step11. Cut.
+Step 11. Cut
------------
- Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node
- Start :ref:`Cut <featureCut>` creation via Main Menu *Features - > Cut*
- Select the fillet object in the view as a main object
- Select the angular copy object in the object browser as a tool object
-.. image:: images/tutorial11_1.png
+
+.. figure:: images/tutorial11_1.png
:align: center
-.. centered::
Cut creation
+
- Click **Apply** button in the property panel
- Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node
- Click right mouse button and select **Color...** item in the popup menu
- Set (R: 255, G: 214, B: 0) color and click **OK** button
-.. image:: images/tutorial11_2.png
+.. figure:: images/tutorial11_2.png
:align: center
-.. centered::
Cut
-
-**See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.
\ No newline at end of file
+**See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.
use_rtd_theme = False
# Add any paths that contain templates here, relative to this directory.
-templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
+#templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
'body_max_width':'none',
'body_min_width':0,
}
+themes_options['sphinx_rtd_theme'] = {
+ 'prev_next_buttons_location':'both',
+}
+
html_theme_options = themes_options.get(html_theme, {})
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
+#html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
# -- Options for HTMLHelp output ------------------------------------------
:linenos:
:language: python
-:download:`Download this script <examples/polyline.py >`
-
+:download:`Download this script <examples/polyline.py>`
+
:linenos:
:language: python
-:download:`Download this script <examples/subshapes.py >`
-
+:download:`Download this script <examples/subshapes.py>`
.. image:: images/edge_by_segments_32x32.png
:align: left
+ :height: 24px
+
**By edges** creates edges using already existing edges in other shapes or full sketches.
.. image:: images/edge_by_points_32x32.png
:align: left
+ :height: 24px
+
**By points** creates segment between two points.
+--------------------------------------------------------------------------------
By edges
--------
-.. |shape_group.icon| image:: images/shape_group.png
-.. |plus.icon| image:: images/add.png
-.. |minus.icon| image:: images/reverce.png
-.. |delete.icon| image:: images/delete.png
+.. |shape_group.icon| image:: images/shape_group.png
.. _groupPage:
.. centered::
Create a group
+.. |group_vertices| image:: images/group_property_panel_vertice.png
+.. |group_edges| image:: images/group_property_panel_edge.png
+.. |group_faces| image:: images/group_property_panel_face.png
+.. |group_solids| image:: images/group_property_panel_solid.png
+
Input fields:
- **Name** defines the name of the group, by default, it is **Group_n**.
- **Type** buttons select geometrical entities to be included in group:
- .. image:: images/group_property_panel_vertice.png
- :align: left
- Vertices;
-
- .. image:: images/group_property_panel_edge.png
- :align: left
- Edges;
+ |group_vertices| Vertices;
+
+ |group_edges| Edges;
- .. image:: images/group_property_panel_face.png
- :align: left
- Faces;
+ |group_faces| Faces;
- .. image:: images/group_property_panel_solid.png
- :align: left
- Solids;
+ |group_solids| Solids;
- 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.
.. image:: images/axis_dxyz_32x32.png
:align: left
+ :height: 24px
+
**By three dimensions** creates an axis by dimensions along X, Y, Z axes starting form existing origin.
.. image:: images/by_two_points_32x32.png
:align: left
+ :height: 24px
+
**By two points** creates an axis using existing points.
.. image:: images/axis_by_line_32x32.png
:align: left
+ :height: 24px
+
**By line** creates an axis using a line.
-.. image:: images/axis_by_line_32x32.png
+.. image:: images/cylindrical_face_32x32.png
:align: left
+ :height: 24px
+
**As an axis of cylindrical face** creates an axis using a cylindrical face.
-.. image:: images/axis_by_line_32x32.png
+.. image:: images/axis_by_plane_and_point_32x32.png
:align: left
+ :height: 24px
+
**By plane and point** creates an axis using a plane and point.
-.. image:: images/axis_by_line_32x32.png
+.. image:: images/axis_by_two_planes_32x32.png
:align: left
+ :height: 24px
+
**By two planes** creates an axis as the intersection of two planes.
+--------------------------------------------------------------------------------
+
By three dimensions
-------------------
.. image:: images/plane_by_three_points_32x32.png
:align: left
+ :height: 24px
+
**By three points** creates a plane by three points.
.. image:: images/plane_by_line_and_point_32x32.png
:align: left
+ :height: 24px
+
**By line and point** creates a plane by a line and a point.
.. image:: images/plane_by_other_plane_32x32.png
:align: left
+ :height: 24px
+
**By other plane** creates a plane parallel to another plane.
.. image:: images/plane_by_two_parallel_planes_32x32.png
:align: left
+ :height: 24px
+
**By two parallel planes** creates a plane between two parallel planes.
+--------------------------------------------------------------------------------
By three points
---------------
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
+ :height: 24px
:align: left
By distance from the selected plane.
.. image:: images/plane_by_coincident_to_point_24x24.png
+ :height: 24px
:align: left
By coincidence with a point.
.. image:: images/plane_by_rotation_24x24.png
+ :height: 24px
:align: left
By rotation around an edge by a specified angle.
.. image:: images/point_by_xyz_32x32.png
:align: left
+ :height: 24px
+
**By X,Y,Z** creates a point by three coordinates.
.. image:: images/point_by_distance_on_edge_32x32.png
:align: left
+ :height: 24px
+
**By distance on edge** creates a point on an edge.
.. image:: images/point_by_projection_32x32.png
:align: left
+ :height: 24px
+
**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
+ :height: 24px
+
**By intersection of objects** creates a point by intersection of planes or/ and edges.
.. image:: images/point_by_geometrical_property_32x32.png
:align: left
+ :height: 24px
+
**By geometrical property of object** creates a point in COG or center of arc or circle.
+--------------------------------------------------------------------------------
+
By X,Y,Z
--------
filletFeature.rst
fuseFeature.rst
fuseFeatureFaces.rst
- importResult.rst
+ importResultFeature.rst
intersectionFeature.rst
linearCopyFeature.rst
measurementFeature.rst
:linenos:
:language: python
-:download:`Download this script <examples/chamfer2.py >`
-
+:download:`Download this script <examples/chamfer2.py>`
:linenos:
:language: python
-:download:`Download this script <examples/chamfer1.py >`
-
+:download:`Download this script <examples/chamfer1.py>`
.. _tui_create_extrusion_fuse_through_all:
Create Extrusion Fuse through all objects
-========================================
+=========================================
.. literalinclude:: examples/extrusion_fuse_through_all.py
:linenos:
:linenos:
:language: python
-:download:`Download this script <examples/fillet1.py >`
-
+:download:`Download this script <examples/fillet1.py>`
:linenos:
:language: python
-:download:`Download this script <examples/fillet2.py >`
-
+:download:`Download this script <examples/fillet2.py>`
:linenos:
:language: python
-:download:`Download this script <examples/fuse_faces.py >`
-
+:download:`Download this script <examples/fuse_faces.py>`
.. _tui_create_import_result:
Create Import Result
-============
+====================
.. literalinclude:: examples/import_result.py
:linenos:
:linenos:
:language: python
-:download:`Download this script <examples/linearcopy.py >`
+:download:`Download this script <examples/linearcopy.py>`
:linenos:
:language: python
-:download:`Download this script <examples/pipe_binormal.py >`
\ No newline at end of file
+:download:`Download this script <examples/pipe_binormal.py>`
:linenos:
:language: python
-:download:`Download this script <examples/pipe_locations.py >`
\ No newline at end of file
+:download:`Download this script <examples/pipe_locations.py>`
:linenos:
:language: python
-:download:`Download this script <examples/pipe_simple.py >`
\ No newline at end of file
+:download:`Download this script <examples/pipe_simple.py>`
:linenos:
:language: python
-:download:`Download this script <examples/rotation2.py >`
\ No newline at end of file
+:download:`Download this script <examples/rotation2.py>`
:linenos:
:language: python
-:download:`Download this script <examples/rotation1.py >`
\ No newline at end of file
+:download:`Download this script <examples/rotation1.py>`
:linenos:
:language: python
-:download:`Download this script <examples/scaleXYZ.py >`
\ No newline at end of file
+:download:`Download this script <examples/scaleXYZ.py>`
:linenos:
:language: python
-:download:`Download this script <examples/scalefactor.py >`
\ No newline at end of file
+:download:`Download this script <examples/scalefactor.py>`
:linenos:
:language: python
-:download:`Download this script <examples/symmetryaxis.py >`
\ No newline at end of file
+:download:`Download this script <examples/symmetryaxis.py>`
:linenos:
:language: python
-:download:`Download this script <examples/symmetryplane.py >`
\ No newline at end of file
+:download:`Download this script <examples/symmetryplane.py>`
:linenos:
:language: python
-:download:`Download this script <examples/symmetrypoint.py >`
\ No newline at end of file
+:download:`Download this script <examples/symmetrypoint.py>`
:linenos:
:language: python
-:download:`Download this script <examples/translation2points.py >`
\ No newline at end of file
+:download:`Download this script <examples/translation2points.py>`
:linenos:
:language: python
-:download:`Download this script <examples/translationDXDYDZ.py >`
\ No newline at end of file
+:download:`Download this script <examples/translationDXDYDZ.py>`
:linenos:
:language: python
-:download:`Download this script <examples/translationvector.py >`
-
+:download:`Download this script <examples/translationvector.py>`
.. _featureChamfer:
Chamfer
-======
+=======
**Chamfer** feature creates chamfers on the edges or on the faces of a shape.
There are 2 types of chamfer:
- .. image:: images/chamfer_distances.png
- :align: left
- chamfer by two distances
+.. image:: images/chamfer_distances.png
+ :align: left
+ :height: 24px
- .. image:: images/chamfer_dist_angle.png
- :align: left
- chamfer by a distance and an angle
+chamfer by two distances
+
+.. image:: images/chamfer_dist_angle.png
+ :align: left
+ :height: 24px
+
+chamfer by a distance and an angle
+
+--------------------------------------------------------------------------------
Chamfer by two distances
------------------------
.. |bool_common.icon| image:: images/bool_common.png
+ :height: 16px
Common
======
.. image:: images/bool_common_simple.png
:align: left
+ :height: 24px
+
**Simple** common part between all selected objects.
.. image:: images/bool_common_advanced.png
:align: left
+ :height: 24px
+
**Advanced** common part for each object between this object and all tools.
+--------------------------------------------------------------------------------
Simple
------
.. _featureCut:
.. |bool_cut.icon| image:: images/bool_cut.png
+ :height: 16px
Cut
===
.. image:: images/extrusion_by_sizes.png
:align: left
+ :height: 24px
+
**By Sizes** extrudes objects by specifying sizes.
.. image:: images/extrusion_by_bounding_planes.png
:align: left
+ :height: 24px
+
**By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
.. image:: images/extrusion_through_all.png
:align: left
+ :height: 24px
+
**Through All** extrudes base objects through all objects to be cut.
+--------------------------------------------------------------------------------
By sizes
--------
.. image:: images/extrusion_by_sizes.png
:align: left
+ :height: 24px
+
**By Sizes** extrudes objects by specifying sizes.
.. image:: images/extrusion_by_bounding_planes.png
:align: left
+ :height: 24px
+
**By Bounding Faces** extrudes objects by specifying bounding faces/planes and offsets.
+--------------------------------------------------------------------------------
By sizes
--------
.. |extrusion_fuse_btn.icon| image:: images/extrusion_fuse_btn.png
Extrusion Fuse
-=============
+==============
Extrusion Fuse feature extrudes selected objects along their normals or the selected axis and fuses the result with other objects.
.. image:: images/extrusion_by_sizes.png
:align: left
+ :height: 24px
+
**By Sizes** extrudes objects by specifying sizes.
.. image:: images/extrusion_by_bounding_planes.png
:align: left
+ :height: 24px
+
**By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
.. image:: images/extrusion_through_all.png
:align: left
+ :height: 24px
+
**Through All** extrudes base objects to pass through all objects fuse with.
+--------------------------------------------------------------------------------
By sizes
--------
There are 2 types of fillet:
- .. image:: images/fillet_fixed_radius.png
- :align: left
- fillet by fixed radius
+.. image:: images/fillet_fixed_radius.png
+ :align: left
+ :height: 24px
- .. image:: images/fillet_var_radius.png
- :align: left
- fillet by variable radius
+fillet by fixed radius
+
+.. image:: images/fillet_var_radius.png
+ :align: left
+ :height: 24px
+
+fillet by variable radius
+
+--------------------------------------------------------------------------------
Fillet by fixed radius
----------------------
.. |bool_fuse.icon| image:: images/bool_fuse.png
+ :height: 16px
Fuse
====
.. image:: images/bool_fuse_simple.png
:align: left
+ :height: 24px
+
**Simple** simply fuses selected objects.
.. image:: images/bool_fuse_advanced.png
:align: left
+ :height: 24px
+
**Advanced** fuse with additional functionality for subshapes of compsolids/compounds.
+--------------------------------------------------------------------------------
Simple
------
.. |import_result_btn.icon| image:: images/import_result_btn.png
Import Result
-=====
+=============
The Import Result feature allows the user to import one or several results from another Part. If the result of the source-part is
changed, the part and part result that contains the copy-results will be updated. The feature keeps the
The following dimensions can be calculated:
- .. image:: images/meas_length_32x32.png
- :align: left
- edge length
+.. image:: images/meas_length_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/meas_distance_32x32.png
- :align: left
- distance between objects
+edge length
- .. image:: images/meas_radius_32x32.png
- :align: left
- radius
+.. image:: images/meas_distance_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/meas_angle_32x32.png
- :align: left
- angle between edges
+distance between objects
- .. image:: images/meas_angle3p_32x32.png
- :align: left
- angle by 3 points
+.. image:: images/meas_radius_32x32.png
+ :align: left
+ :height: 24px
+
+radius
+
+.. image:: images/meas_angle_32x32.png
+ :align: left
+ :height: 24px
+
+angle between edges
+
+.. image:: images/meas_angle3p_32x32.png
+ :align: left
+ :height: 24px
+
+angle by 3 points
+
+--------------------------------------------------------------------------------
Edge length
-----------
:param object: A second vertex in format *model.selection("TYPE", shape)*.
:param object: A third vertex in format *model.selection("TYPE", shape)*.
:return: Calculated value.
-
\ No newline at end of file
+
Pipe can be created in three different ways:
- .. image:: images/pipe_simple_32x32.png
- :align: left
- by object and path
+.. image:: images/pipe_simple_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/pipe_binormal_32x32.png
- :align: left
- by object, path and Bi-normal
+by object and path
- .. image:: images/pipe_locations_32x32.png
- :align: left
- by object, path and locations
+.. image:: images/pipe_binormal_32x32.png
+ :align: left
+ :height: 24px
+
+by object, path and Bi-normal
+
+.. image:: images/pipe_locations_32x32.png
+ :align: left
+ :height: 24px
+
+by object, path and locations
+
+--------------------------------------------------------------------------------
Pipe by object and path
-----------------------
.. centered::
Pipe by object, path and locations
-**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.
.. image:: images/recover_default_32x32.png
:align: left
+ :height: 24px
+
restore only the objects used in the operation
.. image:: images/recover_compound_32x32.png
:align: left
+ :height: 24px
+
restore full compound/compsolid if the operation used one or more of its sub-shapes
+--------------------------------------------------------------------------------
Recover objects
---------------
.. centered::
Remove Sub-Shapes
+.. |by_removing| image:: images/remove_subshapes_32x32.png
+.. |by_keeping| image:: images/keep_subshapes_32x32.png
+
- **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 selecting sub-shapes to be removed.
+|by_removing| **By removing** allows selecting sub-shapes to be removed.
- **Sub-Shapes to remove** the list of sub-shapes which should be removed.
:param list: A list of objects.
-
-.. image:: images/keep_subshapes_32x32.png
- :align: left
-**By keeping** allows select sub-shapes to be kept.
+|by_keeping| **By keeping** allows select sub-shapes to be kept.
- **Sub-Shapes to keep** the list of sub-shapes which should be kept.
.. image:: images/revolution_by_angles.png
:align: left
+ :height: 24px
+
**By Angles** revolves objects by specifying angles.
.. image:: images/revolution_by_bounding_planes.png
:align: left
+ :height: 24px
+
**By Bounding Planes** revolves objects by specifying bounding planes and angles.
.. image:: images/revolution_through_all.png
:align: left
+ :height: 24px
+
**Through All** revolves objects by 360 degrees.
+--------------------------------------------------------------------------------
By angles
---------
+---------
.. image:: images/RevolutionCut1.png
:align: center
**See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_bounding_planes` operation.
Through all
---------
+-----------
.. image:: images/RevolutionCut3.png
:align: center
.. image:: images/revolution_by_angles.png
:align: left
+ :height: 24px
+
**By Angles** revolves objects by specifying angles.
.. image:: images/revolution_by_bounding_planes.png
:align: left
+ :height: 24px
+
**By Bounding Planes** revolves objects by specifying bounding planes and angles.
+--------------------------------------------------------------------------------
By angles
---------
+---------
.. image:: images/Revolution1.png
:align: center
.. centered::
**Revolution created**
-**See Also** a sample TUI Script of :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.
.. image:: images/revolution_by_angles.png
:align: left
+ :height: 24px
+
**By Angles** revolves objects by specifying angles.
.. image:: images/revolution_by_bounding_planes.png
:align: left
+ :height: 24px
+
**By Bounding Planes** revolves objects by specifying bounding planes and angles.
.. image:: images/revolution_through_all.png
:align: left
+ :height: 24px
+
**Through All** revolves objects by 360 degrees.
+--------------------------------------------------------------------------------
By angles
---------
+---------
.. image:: images/RevolutionFuse1.png
:align: center
Two rotation algorithms are:
- .. image:: images/rotation_axis_32x32.png
- :align: left
- by axis and angle
+.. image:: images/rotation_axis_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/rotation_3pt_32x32.png
- :align: left
- by center and 2 points
+by axis and angle
+
+.. image:: images/rotation_3pt_32x32.png
+ :align: left
+ :height: 24px
+
+by center and 2 points
+
+--------------------------------------------------------------------------------
Rotation by axis and angle
--------------------------
.. centered::
Rotation by center and 2 points
-**See Also** a sample TUI Script of :ref:`tui_rotation_3points` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_rotation_3points` operation.
.. |bool_smash.icon| image:: images/bool_smash.png
+ :height: 16px
Smash
=====
.. |bool_split.icon| image:: images/bool_split.png
+ :height: 16px
Split
=====
Symmetrical copy of an Object can be mirrored in three different ways:
- .. image:: images/symmetry_point_32x32.png
- :align: left
- through a Point of symmetry
+.. image:: images/symmetry_point_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/symmetry_axis_32x32.png
- :align: left
- through an Axis of symmetry
+through a Point of symmetry
- .. image:: images/symmetry_plane_32x32.png
- :align: left
- through a Plane of symmetry
+.. image:: images/symmetry_axis_32x32.png
+ :align: left
+ :height: 24px
+
+through an Axis of symmetry
+
+.. image:: images/symmetry_plane_32x32.png
+ :align: left
+ :height: 24px
+
+through a Plane of symmetry
+
+--------------------------------------------------------------------------------
Symmetry through a Point of symmetry
------------------------------------
.. centered::
Symmetry through a Plane of symmetry
-**See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation.
Two Scale algorithms are:
- .. image:: images/scale_factor_32x32.png
- :align: left
- by one common factor
+.. image:: images/scale_factor_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/scale_dimensions_32x32.png
- :align: left
- by different factors along axes
+by one common factor
+
+.. image:: images/scale_dimensions_32x32.png
+ :align: left
+ :height: 24px
+
+by different factors along axes
+
+--------------------------------------------------------------------------------
Scale by one common factor
--------------------------
.. centered::
Scale by different factors
-**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation.
.. _featureTranslation:
.. |translation_vector_32x32.icon| image:: images/translation_vector_32x32.png
+ :height: 16px
Translation
===========
The Vector of translation can be defined in three different ways:
- .. image:: images/translation_vector_32x32.png
- :align: left
- by by axis and distance
+.. image:: images/translation_vector_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/translation_dxyz_32x32.png
- :align: left
- by vector
+by by axis and distance
- .. image:: images/translation_2pt_32x32.png
- :align: left
- by two points
+.. image:: images/translation_dxyz_32x32.png
+ :align: left
+ :height: 24px
+
+by vector
+
+.. image:: images/translation_2pt_32x32.png
+ :align: left
+ :height: 24px
+
+by two points
+
+--------------------------------------------------------------------------------
Translation by axis and distance
--------------------------------
if the filter has arguments.
- **Select** button traverces all objects of a current document and selects entities acceptable by currently defined set of filters. All selected entities will be shown in viewer 3d with
-blue semi-transparent color. Any modification in filters clears current selection.
+ blue semi-transparent color. Any modification in filters clears current selection.
- **Number of selected objects** shows number currently selected entities.
- **Arguments:** A point, an edge or a face. A “propagation” flag (check-box).
- **Algorithm:**
- If a point of an edge is selected as an argument, the result is all faces that contain this argument.If a face is selected, the result is all faces that have shared edges or vertices with this selection.
- - If “propagation” flag is enabled (it is disabled by default), the algorithm becomes recursive: all connected faces are added to the results. So, for the solid shape there will be all faces except internal-volumes faces, not connected to any external faces.
\ No newline at end of file
+ - If “propagation” flag is enabled (it is disabled by default), the algorithm becomes recursive: all connected faces are added to the results. So, for the solid shape there will be all faces except internal-volumes faces, not connected to any external faces.
.. centered::
Parameters dialog box
+.. |param_up| image:: images/parameters_up.png
+.. |param_down| image:: images/parameters_down.png
+
**Input fields**:
- **Name** defines parameter name. Name follows the naming rules of the python language for variables;
- **Insert** button adds a new empty string before the selected parameter;
- **Delete** button removes the selected parameter from the table;
- **Modify parameter position** button moves the selected parameter
- .. image:: images/parameters_up.png
- :align: left
- one string higher in the table,
- .. image:: images/parameters_down.png
- :align: left
- one string lower in the table.
-
+ | |param_up| one string higher in the table,
+ | |param_down| one string lower in the table.
**TUI Command**:
.. _tui_create_torus:
Create / Torus
-=============
+==============
.. literalinclude:: examples/torus.py
:linenos:
.. _box_feature:
-.. |box.icon| image:: images/box.png
Box
===
+.. |box.icon| image:: images/box.png
+
Box feature creates a box solid.
To create a Box in the active part:
There are 2 algorithms for creation of a Box:
-.. image:: images/box_2pt_32x32.png
+.. image:: images/box_dxyz_32x32.png
:align: left
+ :height: 24px
+
**By dimensions**
-.. image:: images/box_dxyz_32x32.png
+.. image:: images/box_2pt_32x32.png
:align: left
+ :height: 24px
+
**By two points**
+--------------------------------------------------------------------------------
By dimensions
-------------
:param object: First vertex of diagonal.
:param object: Second vertex of diagonal.
:return: Result object.
+
**Arguments**: Part + 2 selected points (opposite vertices of the box)
Result
.. image:: images/cylinder_32x32.png
:align: left
+ :height: 24px
+
**Cylinder** creates a cylinder.
.. image:: images/cylinder_portion_32x32.png
:align: left
+ :height: 24px
+
**Portion of cylinder** creates one segment of a cylinder.
+--------------------------------------------------------------------------------
+
Cylinder
--------
.. _sketchPlugin:
-.. |SketchButton.icon| image:: images/SketchButton.png
Sketch plug-in
================
+.. |SketchButton.icon| image:: images/SketchButton.png
+
Sketch plug-in includes features for creation of 2D shapes.
The sketch creation takes the following steps:
.. _tui_create_ellipse:
Create Skecth Ellipse
-====================
+=====================
.. literalinclude:: examples/ellipse.py
:linenos:
.. _tui_create_perpendicular:
Create Perpendicular constraint
-==========================
+===============================
.. literalinclude:: examples/perpendicular.py
:linenos:
.. image:: images/Angle_panel.png
:align: center
+.. |angle_direct| image:: images/angle_direct.png
+.. |angle_complement| image:: images/angle_complementary.png
+.. |angle_backward| image:: images/angle_backward.png
+.. |loc_left| image:: images/location_left.png
+.. |loc_auto| image:: images/location_automatic.png
+.. |loc_right| image:: images/location_right.png
+
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, 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 the least angle between two lines;
-
- .. image:: images/angle_complementary.png
- :align: left
- **Complementary** is 180°- Direct angle between two lines;
-
- .. image:: images/angle_backward.png
- :align: left
- **Backward** is 360°- Direct angle between two lines.
+ | |angle_direct| **Direct** is the least angle between two lines;
+ | |angle_complement| **Complementary** is 180°- Direct angle between two lines;
+ | |angle_backward| **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 to the left of the angle line;
-
- .. image:: images/location_automatic.png
- :align: 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.
+ | |loc_left| **Left** inserts text to the left of the angle line;
+ | |loc_auto| **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left;
+ | |loc_right| **Right** inserts text to the right of the angle line.
When both lines are selected, the angle value is displayed in the property panel and in the view.
.. centered::
Angle created
-**See Also** a sample TUI Script of :ref:`tui_create_angle` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_angle` operation.
.. image:: images/arc_base_32x32.png
:align: left
+ :height: 24px
+
**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
+ :height: 24px
+
**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
+ :height: 24px
+
**By tangent point and end point** creates an arc segment with the tangent point and the end point.
.. image:: images/arc_perp_32x32.png
:align: left
+ :height: 24px
+
**By point on perpendicular line and end point** creates an arc segment perpendicular to a straight line with the start point, connected with boundary of this line, and the end point.
+-------------------------------------------------------------------------------------------
+
By center and two points
""""""""""""""""""""""""
.. centered::
Arc created
-**See Also** a sample TUI Script of :ref:`tui_create_arc` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_arc` operation.
.. image:: images/circle_pt_rad_32x32.png
:align: left
+ :height: 24px
+
**By center and passed point** creates a circle with the given center passing through the given point.
.. image:: images/circle_3pt_32x32.png
:align: left
+ :height: 24px
+
**By three points** creates a circle passing through the given three points.
+-------------------------------------------------------------------------------------------
+
By center and passed point
""""""""""""""""""""""""""
-.. |distance.icon| image:: images/distance.png
+.. |distance.icon| image:: images/Distance.png
Distance constraint
===================
.. image:: images/Distance_panel.png
:align: center
+.. |location_left| image:: images/location_left.png
+.. |location_auto| image:: images/location_automatic.png
+.. |location_right| image:: images/location_right.png
+
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, 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 to the left of the distance extension line;
-
- .. image:: images/location_automatic.png
- :align: 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;
+ | |location_left| **Left** inserts text to the left of the distance extension line;
+ | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
+ | |location_right| **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, the distance value is displayed in the property panel and in the view.
.. image:: images/ellipse_cent_rad_32x32.png
:align: left
+ :height: 24px
+
**By center and major semi-axes and passing points** creates an ellipse with the given center passing through given points.
.. image:: images/ellipse_axes_32x32.png
:align: left
+ :height: 24px
+
**By major axis and passing point** creates an ellipse passing through the given three points.
+-------------------------------------------------------------------------------------------
+
By center and major semi-axes and passing points
""""""""""""""""""""""""""""""""""""""""""""""""
.. _sketchEqual:
-.. |equal.icon| image:: images/equal.png
+.. |equal.icon| image:: images/Equal.png
Equal constraint
================
.. centered::
Created equal constraint
-**See Also** a sample TUI Script of :ref:`tui_create_equal` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_equal` operation.
-.. |fillet.icon| image:: images/fillet.png
+.. |fillet.icon| image:: images/Fillet.png
Fillet
======
.. centered::
Created fillet
-**See Also** a sample TUI Script of :ref:`tui_create_fillet` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_fillet` operation.
-.. |fixed.icon| image:: images/fixed.png
+.. |fixed.icon| image:: images/Fixed.png
Fixed constraint
================
.. image:: images/HorizontalDistance_panel.png
:align: center
+.. |location_left| image:: images/location_left.png
+.. |location_auto| image:: images/location_automatic.png
+.. |location_right| image:: images/location_right.png
+
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, 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 to the left of the distance extension line;
-
- .. image:: images/location_automatic.png
- :align: 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.
+ | |location_left| **Left** inserts text to the left of the distance extension line;
+ | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
+ | |location_right| **Right** inserts text to the right of the distance extension line.
When both objects are selected, the horizontal distance value is displayed in the property panel and in the view.
.. centered::
Horizontal Distance created
-**See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation.
-.. |intersection.icon| image:: images/intersection.png
+.. |intersection.icon| image:: images/Intersection.png
Intersection
============
.. _sketchLength:
-.. |length.icon| image:: images/length.png
+.. |length.icon| image:: images/Length.png
Length constraint
=================
.. image:: images/Length_panel.png
:align: center
+.. |location_left| image:: images/location_left.png
+.. |location_auto| image:: images/location_automatic.png
+.. |location_right| image:: images/location_right.png
+
Input fields:
- **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 to the left of the length extension line;
-
- .. image:: images/location_automatic.png
- :align: 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.
+ | |location_left| **Left** inserts text to the left of the length extension line;
+ | |location_auto| **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left;
+ | |location_right| **Right** inserts text to the right of the length extension line.
When the line is selected, the length value is displayed in the property panel and in the view.
.. _sketchLine:
-.. |line.icon| image:: images/line.png
+.. |line.icon| image:: images/Line.png
Line
====
-.. |middlepoint.icon| image:: images/middlepoint.png
+.. |middlepoint.icon| image:: images/MiddlePoint.png
Middle point constraint
=======================
-.. |mirror.icon| image:: images/mirror.png
+.. |mirror.icon| image:: images/Mirror.png
Mirror copy
===========
.. centered::
Mirror copy created
-**See Also** a sample TUI Script of :ref:`tui_create_mirror` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_mirror` operation.
-.. |parallel.icon| image:: images/parallel.png
+.. |parallel.icon| image:: images/Parallel.png
Parallel constraint
===================
.. centered::
Created parallel constraint
-**See Also** a sample TUI Script of :ref:`tui_create_parallel` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_parallel` operation.
-.. |point.icon| image:: images/point.png
+.. |point.icon| image:: images/Point.png
Point
=====
.. centered::
Point created
-**See Also** a sample TUI Script of :ref:`tui_create_point` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_point` operation.
-.. |projection.icon| image:: images/projection.png
+.. |projection.icon| image:: images/Projection.png
Projection
==========
.. centered::
Created projection (purple line)
-**See Also** a sample TUI Script of :ref:`tui_create_projection` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_projection` operation.
.. image:: images/Radius_panel.png
:align: center
+.. |loc_left| image:: images/location_left.png
+.. |loc_auto| image:: images/location_automatic.png
+.. |loc_right| image:: images/location_right.png
Input fields:
- **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
- **Left** inserts text at the left of the radius extension line.
-
- .. image:: images/location_automatic.png
- :align: left
- **Automatic** inserts text at the middle of the radius 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 radius extension line.
+ | |loc_left| **Left** inserts text at the left of the radius extension line.
+ | |loc_auto| **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left.
+ | |loc_right| **Right** inserts text to the right of the radius extension line.
When circle or arc is selected, the radius value is displayed in the property panel and in the view.
.. _create_sketch_rectangle:
-.. |rectangle.icon| image:: images/rectangle.png
Rectangle
=========
+.. |rectangle.icon| image:: images/Rectangle.png
+
Rectangle feature creates a rectangle by two opposite points in the current Sketch.
The result is represented in form of four Lines which compose a rectangle.
.. centered::
Rectangle created
-**See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation.
.. centered::
Angular copy
+.. |full_angle| image:: images/angle_up_full_32x32.png
+.. |single_angle| image:: images/angle_up_32x32.png
+
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;
- **Full angle/Single angle** option:
-
- .. image:: images/angle_up_full_32x32.png
- :align: left
- **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one).
-
- .. image:: images/angle_up_full_32x32.png
- :align: left
- **Single angle**: angle step of rotation is equal to the defined angle.
-
+ | |full_angle| **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one).
+ | |single_angle| **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 a clockwise direction, otherwise - in a counterclockwise direction.
- **Total number of objects** is the total number of objects including the original one.
.. |SketchDrawer.icon| image:: images/SketchDrawer.png
Sketch Drawer
-=========
+=============
Sketch Drawer featrure is a macro-feature, i.e. it is removed after its execution.
It allows simplify creation of sketches basing on existing models without referencing to
-.. |split.icon| image:: images/split.png
+.. |split.icon| image:: images/Split.png
Split
=====
.. centered::
Created split
-**See Also** a sample TUI Script of :ref:`tui_create_split` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_split` operation.
-.. |tangent.icon| image:: images/tangent.png
+.. |tangent.icon| image:: images/Tangent.png
Tangent constraint
==================
.. centered::
Linear copy
+
+.. |single_value| image:: images/translate_32x32.png
+.. |full_value| image:: images/translate_full_32x32.png
+
Input fields:
- **Segments** is the list of segments (lines, circles, arcs) selected in the view.
- **Single value/Full value** option:
-
- .. image:: images/translate_32x32.png
- :align: left
- **Single value**: step of translation is equal to the distance between the start and the end point.
-
- .. image:: images/translate_full_32x32.png
- :align: left
- **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
+ | |single_value| **Single value**: step of translation is equal to the distance between the start and the end point.
+ | |full_value| **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
- **Start point** is the initial point of translation vector.
- **End point** is the terminal point of translation vector.
- **Total number of objects** is the total number of objects including the original one.
-.. |trim.icon| image:: images/trim.png
+.. |trim.icon| image:: images/Trim.png
Trim
====
:param object: Line, arc or circle.
:param object: Position point.
:return: Result object.
+
**Arguments**: feature (line, arc or circle) and position point (a point on or closest to the segment to remove)
Result
.. image:: images/VerticalDistance_panel.png
:align: center
+.. |location_left| image:: images/location_left.png
+.. |location_auto| image:: images/location_automatic.png
+.. |location_right| image:: images/location_right.png
+
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, 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 to the left of the distance extension line:
-
- .. image:: images/location_automatic.png
- :align: 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.
+ | |location_left| **Left** inserts text to the left of the distance extension line:
+ | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left
+ | |location_right| **Right** inserts text to the right of the distance extension line.
When both objects are selected, the vertical distance value is displayed in the property panel and in the view.
-.. |vertical.icon| image:: images/vertical.png
+.. |vertical.icon| image:: images/Vertical.png
Vertical constraint
===================
.. centered::
Vertical constraint created
-**See Also** a sample TUI Script of :ref:`tui_create_vertical` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_vertical` operation.
