SHAPER module of SALOME is destined for:\r
\r
- import and export of geometrical models in IGES, BREP, STEP and XAO formats;\r
-- parametrical 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 :ref:`featuresPlugin`;\r
- - construction of model using primitives defined in :ref:`primitivesPlugin`;\r
- - usage of Boolean operations :ref:`featuresPlugin`;\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
+ - usage of Boolean operations (see :ref:`featuresPlugin`);\r
\r
- viewing geometrical objects in the OCC viewer;\r
- transformation of geometrical objects using various algorithms.\r
\r
It is possible to easily set :ref:`parameter_usage` predefined to be used as arguments when objects are created.\r
\r
-SHAPER module preferences are described in the SHAPER :ref:`preferences` section of SALOME Help.\r
+SHAPER module preferences are described in the :ref:`preferences` section of SALOME Help.\r
\r
Almost all SHAPER module functionalities are accessible via Python Interface.\r
\r
\r
Only one document can be active.\r
\r
-New study contains only Partset with 7 default constructions which cannot be deleted:\r
+New study contains only partset with 7 default constructions which cannot be deleted:\r
\r
-- one point **Origin** coincing with origin of coordinate system;\r
+- one point **Origin** coinciding with origin of 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 plane (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added in Partset to be used in any part later.\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
:ref:`parameter_usage` can be used both in Partset and any Part.\r
\r
\r
Application toolbar contains:\r
\r
- standard toolbar;\r
-- modukles toolbar;\r
+- modules toolbar;\r
- SHAPER toolbar.\r
\r
.. image:: images/toolbar.png\r
\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
+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
:align: center\r
\r
.. centered::\r
- Pop-up menu for visibilty of windows and toolbars\r
+ Pop-up menu for visibility of windows and toolbars\r
\r
\r
.. _object_browser: \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
-Not defaullt branch is added into Tree View when the first feature of this type is created.\r
+Example 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
+\r
+Not 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 from Tree View.\r
+Note, that result used in feature as argument is removed.\r
\r
-This child result can be restored using Recover Feature.\r
+This child result can be restored using **Recover** feature.\r
\r
Each feature, result, construction, group, field, parameter can be renamed using *Rename* pop-up menu command.\r
\r
.. centered::\r
Construction pop-up menu\r
\r
-Order of featurs can be changed using *Move to the end* pop-up menu command. Selected feature will be moved to the end of feture list.\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
\r
Folders can be used to arrange long Tree View for features.\r
\r
\r
Feature together with 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 simulteneously.\r
+Note that all features using removed feature and their results will be removed simultaneously.\r
\r
-**Delete feature** dialog box shows list of feature to be removed. After confirmation by click **Yes** button all these features are removed.\r
+**Delete feature** dialog box shows 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
Property panel\r
^^^^^^^^^^^^^^\r
\r
-By default Property Panel is hidden.\r
-\r
-The Property Panel is shown on operation start at left side of the main window by default.\r
-\r
-If Object Browser is shown at the same side then it will be tabbed with Property Panel.\r
-\r
Property panel consists of two parts:\r
\r
- controls container for input of parameters for the current operation;\r
- buttons panel containing standard buttons:\r
- \r
- - **Ok/Apply** executes operation with defined parameters,\r
- - **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort,\r
- - **Help** calls User's guide opened on page describing the current operation.\r
-\r
-.. image:: images/button_ok.png\r
- :align: center\r
-\r
-.. centered::\r
- **OK/Apply** button\r
+ \r
+ .. image:: images/button_ok.png\r
+ :align: left\r
+ **Ok/Apply** executes operation with defined parameters,\r
\r
-.. image:: images/button_cancel.png\r
- :align: center\r
\r
-.. centered::\r
- **Cancel/Close** button\r
-\r
-.. image:: images/button_help.png\r
- :align: center\r
+ .. image:: images/button_cancel.png\r
+ :align: left\r
+ **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, \r
\r
-.. centered::\r
- **Help** button\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
**Abort operation** dialog box\r
\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
\r
.. _inspection_panel: \r
Inspection panel \r
^^^^^^^^^^^^^^^^\r
\r
-Inspection panel provides the list of types and quantities of all topological entities, composing the selected result, consruction or feature.\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
:align: center\r
.. centered::\r
Inspection panel for default Box\r
\r
-**Object** displays name of the selected result, consruction or feature.\r
+**Object** displays name of the selected result, construction or feature.\r
\r
**Type** characterizes the whole shape.\r
\r
\r
The information about Plane, Face additionally shows coordinates of center point and direction of normal.\r
\r
-.. image:: images/inspection_panel_line.png\r
+.. image:: images/inspection_panel_face.png\r
:align: center\r
\r
.. centered::\r
Inspection panel for Face \r
\r
- \r
-\r
.. _python console:\r
\r
Python console\r
\r
Python console interpreters Python commands entered manually.\r
\r
-In particular, it is possble to load python script:\r
+In particular, it is possible to load python script:\r
\r
*execfile(r"/dn48/newgeom/data/example.py")*\r
\r
\r
.. _parameter_usage:\r
\r
-Parameter usage\r
----------------\r
+Parameters \r
+----------\r
\r
Model parametrization can be done using parameters.\r
\r
\r
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 prority 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 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
\r
In contrast to features (see :ref:`object_browser`), there is an additional option when Delete parameters. \r
\r
\r
Visualization tab is activated by default when **Preferences** dialog box is opened in active SHAPER module.\r
\r
-Other tabs are activated by clck on tab header.\r
+Other tabs are activated by click on tab header.\r
\r
.. _visualization_preferences:\r
\r
**Input fields**:\r
\r
- **Result color** selects default shading color for objects from **Results** branch;\r
-- **Group color** selects default color for objects from **Group** branch;\r
+- **Group color** selects default color for objects from **Groups** branch;\r
- **Construction color** selects default color for objects from **Constructions** branch;\r
- **Part color** selects default color for parts shown in Partset; \r
-- **Field color** selects default color for objects from **Field** branch;\r
+- **Field color** selects default color for objects from **Fields** branch;\r
- **Body deflection coefficient** defines default deflection coefficient for objects from **Results** branch. A smaller coefficient provides better quality of a shape in the viewer;\r
-- **Construction deflection coefficient** defines default deflection coefficient for objects from **Construction** branch. A smaller coefficient provides better quality of a shape in the viewer;\r
+- **Construction deflection coefficient** defines default deflection coefficient for objects from **Constructions** branch. A smaller coefficient provides better quality of a shape in the viewer;\r
- **Reference shape wireframe color in operation** selects default color used for wireframe visualization of objects used in active operation;\r
- **Result shape wireframe color in operation** selects default color used for wireframe visualization of result in active operation. Click **See preview** button to show result;\r
-- **Multi selector item color in operation** selects default color used for wireframe visualization of objects selected in propertry panel to distiguish them among all objects used in active operation;\r
-- **Color of removed feature in operation** selects default color used for visualization of sketch entities to be removed during Trim/Split operations;\r
-- **Color of sketch plane** selects default shading color for objects from **Results** branch;\r
+- **Multi selector item color in operation** selects default color used for visualization of objects selected in property panel to distinguish them among all objects used in active operation;\r
+- **Color of removed feature in operation** selects default color used for visualization of sketch entities to be removed during **Trim/Split** operations;\r
+- **Color of sketch plane** selects default shading color for sketch plane;\r
- **Hidden faces transparency** defines default transparency value for hidden faces;\r
- **Dimension arrow size** defines default size of arrows for extension line showing dimensional constraint; \r
- **Dimension font** defines font used for value of dimensional constraint;\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 consrtaint color** selects default color for sketch with zero degrees of freedom.\r
+- **Sketch fully constraint color** selects default color for sketch with zero degrees of freedom.\r
\r
-To redefine any color click on the corrersponding line to acccsess **Select color** dialog box\r
+To redefine any color click on the corresponding line to access **Select color** dialog box\r
\r
.. image:: images/select_color.png\r
:align: center\r
Sketch tab\r
^^^^^^^^^^\r
\r
-Sketch tab defines properties of coordinate planes shown for selection of sketch plane when no convinient objects are shown in OCC 3D viewer.\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
:align: center\r
-
+.. _box_feature:
Box
===
.. image:: images/box_2pt_32x32.png
:align: left
-**By dimensions** creates a box by dimensions along X, Y, Z axis.
+**By dimensions**
.. image:: images/box_dxyz_32x32.png
:align: left
-**By two points** creates a box by two points of the box diagnal.
-
+**By two points**
By dimensions
"""""""""""""
+Box is created by dimensions along X, Y, Z axis starting from the origin.
+
.. image:: images/Box_dimensions.png
:align: center
-In this case it is necessary to specify **DX**, **DY**, **DZ** sizes of the box along corresponding coordinate axes. The box will be created starting from the origin.
+Input fields:
+
+- **DX**, **DY**, **DZ** define sizes of the box along corresponding coordinate axes.
**TUI Command**: *model.addBox(Part_doc, DX, DY, DZ)*
-**Arguments**: 1 Part + 3 values (dimensions at origin).
+**Arguments**: Part + 3 real values (dimensions at origin).
By two points
"""""""""""""
+Box is created by two points of the box diagonal.
+
.. image:: images/Box_2points.png
:align: center
-In this case it is necessary to select **Point 1** and **Point 2** to define a diagonal points of the box.
+Input fields:
+
+- **Point 1** and **Point 2** define diagonal points of the box selected in 3D OCC viewer or object browser.
-**TUI Command**: *model.addBox(Part_doc, FirstPoint, SecondPoint)*
+**TUI Command**: *model.addBox(Part_doc, point1, point2)*
-**Arguments**: 1 Part + 2 selected points (opposite vertices of the box)
+**Arguments**: Part + 2 selected points (opposite vertices of the box)
Result
""""""
-The Result of operation will be a SOLID. The edges of the box will be parallel to the coordinate axes.
-
-Name is assigned automatically:
-
-* **Box_1**, **Box_2**, ... to Feature;
-* **Box_1_1**, **Box_2_1**, ... to Result.
-
-Example is shown below.
+The edges of the created boxes are parallel to the coordinate axes.
.. image:: images/Boxes.png
:align: center
.. centered::
Boxes created
-**See Also** a sample TUI Script of a :ref:`tui_create_box` operation.
+**See Also** a sample TUI Script of a :ref:`tui_create_box` operation.
\ No newline at end of file
