- viewing geometrical objects in the OCC viewer;\r
- transformation of geometrical objects using various algorithms.\r
\r
-It is possible to easily set :ref:`parameters` predefined to be used as arguments when objects are created.\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
\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
-:ref:`parameters` created can be used both in Partset and any Part.\r
+:ref:`parameter_usage` created can be used both in Partset and any Part.\r
\r
-If parameter name in Partset and Part are identical then Part parameter has higher prority.\r
\r
New Part can be created as described in :ref:`partPlugin`.\r
\r
- :ref:`main_menu`;\r
- :ref:`doc_windows`;\r
- :ref:`viewer`;\r
+- :ref:`toolbar`; \r
- status bar. \r
\r
.. image:: images/main_window.png\r
\r
and items specific for SHAPER module:\r
\r
-- :ref:`partPlugin`;\r
-- :ref:`sketchPlugin`;\r
-- :ref:`constructionPlugin`;\r
-- :ref:`buildPlugin`;\r
-- :ref:`primitivesPlugin`;\r
-- :ref:`gdmlPlugin`;\r
-- :ref:`featuresPlugin`; \r
+- Part (see :ref:`partPlugin`);\r
+- Sketch (see :ref:`sketchPlugin`);\r
+- Construction (see :ref:`constructionPlugin`);\r
+- Build (see :ref:`buildPlugin`);\r
+- Primitives (see :ref:`primitivesPlugin`);\r
+- GDML (see :ref:`gdmlPlugin`);\r
+- Features (see :ref:`featuresPlugin`); \r
- Macros. \r
\r
+ .. _toolbar: \r
\r
+SHAPER toolbar\r
+--------------\r
+\r
+Application toolbar contains:\r
+\r
+- standard toolbar;\r
+- modukles toolbar;\r
+- SHAPER toolbar.\r
+\r
+.. image:: images/toolbar.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Toolbars\r
+ \r
+SHAPER toolbar duplicates main menu and provides access to all commands of the application.\r
+\r
+SHAPER toolbar is separated into sections:\r
+\r
+- Part;\r
+- Movement;\r
+- Measurement;\r
+- Sketch;\r
+- Construction;\r
+- Build;\r
+- Primitives;\r
+- GDML;\r
+- Features;\r
+- Boolean;\r
+- Collections; \r
+- Fillet; \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
.. _doc_windows:\r
\r
:align: center\r
\r
.. centered::\r
- **OK** button\r
+ **OK/Apply** button\r
\r
.. image:: images/button_cancel.png\r
:align: center\r
**Abort operation** dialog box\r
\r
\r
-**OK** 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/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
Description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
\r
\r
-.. _parameters:\r
+.. _parameter_usage:\r
\r
-Parameters\r
----------\r
+Parameter usage\r
+---------------\r
+\r
+Model parametrization can be done using parameters.\r
+\r
+Parameter can be created in the active partset or part by:\r
+\r
+- :ref:`parameter`;\r
+- :ref:`parameters`;\r
+- :ref:`parameter_expression`.\r
\r
-Parameter\r
-^^^^^^^^^\r
+Created parameters can be used in features defining any argument as parameter or expression containing parameters.\r
\r
+List of features using parameters is given in **Parameters** dialog box:\r
\r
+ .. image:: images/parameters_feature.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Parameters dialog box\r
+ \r
+If 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
+\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
+\r
+In contrast to features (see :ref:`object_browser`), there is an additional option when Delete parameters. \r
+\r
+.. image:: images/delete_parameter.png\r
+ :align: center\r
+\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
+\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
+\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
\r
.. _preferences:\r
\r
SHAPER preferences\r
------------------\r
\r
+SHAPER preferences define visualization of objects, visualization during selection, edition. New preferences can be used right after modification or later after activation of SHAPER module.\r
+\r
+To call **Preferences** dialog box:\r
+\r
+#. select in the Main Menu *File - > Preferences* item or\r
+#. use **Ctrl+P** shortcut.\r
+\r
+SHAPER preferences include 4 tabs:\r
+\r
+- :ref:`visualization_preferences`;\r
+- :ref:`plugins_preferences`;\r
+- :ref:`sketch_preferences`;\r
+- :ref:`viewer_preferences`.\r
+ \r
+.. _visualization_preferences:\r
+\r
Visualization tab\r
^^^^^^^^^^^^^^^^^\r
\r
+Visualization tab is activated by default when **Preferences** dialog box is opened in active SHAPER module.\r
+\r
.. image:: images/visualization_preferences.png\r
:align: center\r
\r
.. centered::\r
Preferences - Visualization tab\r
\r
+To redefine any color click on the corrersponding line to acccsess **Select color** dialog box\r
+\r
+.. image:: images/select_color.png\r
+ :align: center\r
+\r
+.. centered::\r
+ **Select color** dialog box\r
+ \r
+\r
+ \r
+.. _plugins_preferences:\r
+ \r
Plugins tab\r
^^^^^^^^^^^\r
\r
.. centered::\r
Preferences - Plugins tab\r
\r
+.. _sketch_preferences:\r
+ \r
Sketch tab\r
^^^^^^^^^^\r
\r
.. centered::\r
Preferences - Sketch tab\r
\r
+.. _viewer_preferences:\r
+ \r
Viewer tab\r
^^^^^^^^^^\r
\r
+.. _parameters:
+
Parameters manager
==================
+To create/edit a set of parameters in the active partset or part instead of multiply call:
+
+#. select in the Main Menu *Part - > Parameters* item or
+#. click **Parameters** button in the toolbar:
+
+.. image:: images/paper_roll.png
+ :align: center
+
+.. centered::
+ **Parameters** button
+
+The following dialog box with parameter table appears:
+
+.. image:: images/parameters.png
+ :align: center
+
+.. centered::
+ Parameters dialog box
+
+**Input fields**:
+
+- **Name** defines parameter name. Name follows the naming rules of the python language for variables;
+- **Expression** inputs manually 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>*
+- **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
+ up on 1 string in the table,
+
+ .. image:: images/parameters_down.png
+ :align: left
+ down on 1 string 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.
+
+Result
+------
+
+Created parameters and their current values are displayed in the Object Browser, in a special section **Parameters**.
-.. image:: images/Manager.png
- :align: center
+.. image:: images/object_browser_parameters.png
+ :align: center
.. centered::
- Edit parameters with help of parameres manager
+ **Parameters** in object browser
+.. _parameter:
Create parameter
================
+The parameter definition has form *variable=expression*.
-.. image:: images/Parameter.png
- :align: center
+To create 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: center
+
+.. centered::
+ **Parameter** button
+
+The following property panel appears.
+
+.. image:: images/parameter.png
+ :align: center
+
+.. centered::
+ Parameter property panel
+
+**Input fields**:
+
+- .. image:: images/expression.png
+ :align: left
+ defines parameter name. Name follows 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.
+
+- **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.
+
+**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_parameterFeature` operation.
+
+Result
+------
+
+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
.. centered::
- Create a parameter
+ **Parameter** in object browser
