]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Preferences description added
authorgzy <gzy@opencascade.com>
Tue, 18 Sep 2018 08:32:36 +0000 (11:32 +0300)
committergzy <gzy@opencascade.com>
Tue, 18 Sep 2018 08:32:36 +0000 (11:32 +0300)
doc/gui/Introduction.rst
doc/gui/images/find_directory.png [new file with mode: 0644]
doc/gui/images/open_button.png [new file with mode: 0644]

index cbaf9159cea305caa62cf57cb505f6027af02a6c..7521f31874f09710327112f0862f266754e52681 100644 (file)
@@ -37,7 +37,7 @@ New study contains only Partset with 7 default constructions which cannot be del
 - 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:`parameter_usage` created can be used both in Partset and any Part.\r
+:ref:`parameter_usage` can be used both in Partset and any Part.\r
 \r
      \r
 New Part can be created as described in :ref:`partPlugin`.\r
@@ -174,7 +174,7 @@ Each dock window can be closed using **Cross** window button and opened again us
 Object browser\r
 ^^^^^^^^^^^^^^\r
 \r
-Object browser contains all documents created in the current study. shown in Tree View.\r
+Object browser contains all documents created in the current study. \r
 \r
 Each document includes standard branches where created objects are placed.\r
 \r
@@ -208,7 +208,13 @@ New part contains only 3 empty branches:
 - Constructions;\r
 - Results.\r
 \r
-Features are placed one after another in the active document with default names and their results are placed in the corresponding branch.\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
+\r
+Note, that result used in feature as argument is removed from Tree View.\r
+\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
@@ -284,7 +290,7 @@ By default Property Panel is hidden.
 \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 they will be tabbed.\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
@@ -305,7 +311,7 @@ Property panel consists of two parts:
    :align: center\r
 \r
 .. centered::\r
-   **Cancel**  button\r
+   **Cancel/Close**  button\r
 \r
 .. image:: images/button_help.png\r
    :align: center\r
@@ -460,6 +466,8 @@ After validation of feature a new parameter with given name **variable** and val
 SHAPER preferences\r
 ------------------\r
 \r
+Description of General application preferences and **Preferences** dialog box is provided in GUI module user's guide in chapter **Setting Preferences**.\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
@@ -473,13 +481,17 @@ SHAPER preferences include 4 tabs:
 - :ref:`plugins_preferences`;\r
 - :ref:`sketch_preferences`;\r
 - :ref:`viewer_preferences`.\r
+\r
+Visualization tab is activated by default when **Preferences** dialog box is opened in active SHAPER module.\r
+\r
+Other tabs are activated by clck on tab header.\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
+This tab defines presentation of objects displayed in OCC 3D viewer.\r
 \r
 .. image:: images/visualization_preferences.png\r
    :align: center\r
@@ -487,6 +499,32 @@ Visualization tab is activated by default when **Preferences** dialog box is ope
 .. centered::\r
    Preferences - Visualization tab\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
+- **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
+- **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
+- **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
+- **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
+- **Dimension value size**  defines default size of value for dimensional constraint;\r
+- **Sketch dimension color**  defines default color of dimensional constraint; \r
+- **Construction plane color** selects default color for Construction planes;  \r
+- **Sketch entity color** selects default color for sketch objects;\r
+- **Sketch external entity color** selects default color for external objects selected as reference during sketch creation/edition;\r
+- **Sketch auxiliary entity color** selects default color for sketch auxiliary objects;\r
+- **Sketch overconsrtaint color** selects default color for sketch with redundant constraints;\r
+- **Sketch fully consrtaint 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
 \r
 .. image:: images/select_color.png\r
@@ -495,12 +533,13 @@ To redefine any color click on the corrersponding line to acccsess **Select colo
 .. centered::\r
    **Select color** dialog box\r
    \r
-\r
+Preferences for sketch are applicable  during sketch creation/edition operation.\r
    \r
 .. _plugins_preferences:\r
    \r
 Plugins tab\r
 ^^^^^^^^^^^\r
+Plugins tab defines folders where plugins and resources are located.\r
 \r
 .. image:: images/plugins_preferences.png\r
    :align: center\r
@@ -508,24 +547,67 @@ Plugins tab
 .. centered::\r
    Preferences - Plugins tab\r
 \r
+**Input fields**:\r
+\r
+- **Default path** selects default folder where plugins are located. Click on **Open** button opens standard **Find directory** dialog box to navigate to desired folder;\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
+   :align: center\r
+\r
+.. centered::\r
+   **Open** button\r
+\r
+.. image:: images/find_directory.png\r
+   :align: center\r
+\r
+.. centered::\r
+   **Find directory** dialog box\r
+    \r
+   \r
 .. _sketch_preferences:\r
    \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
+\r
 .. image:: images/sketch_preferences.png\r
    :align: center\r
 \r
 .. centered::\r
    Preferences - Sketch tab\r
 \r
+**Input fields**:\r
+\r
+- **Size** defines size of coordinate planes;\r
+- **Thickness**  defines thickness of coordinate plane borders; \r
+- **Rotate to plane when selected** check-box turns on/off automatic switch the viewer to the top view for the selected sketch plane.  \r
+\r
+   \r
 .. _viewer_preferences:\r
    \r
 Viewer tab\r
 ^^^^^^^^^^\r
 \r
+Viewer tab defines selection in OCC 3D viewer properties. \r
+\r
 .. image:: images/viewer_preferences.png\r
    :align: center\r
 \r
 .. centered::\r
    Preferences - Viewer tab   \r
+\r
+**Input fields**:\r
+\r
+- **Default Selection** defines objects to be selected by mouse click in OCC 3D viewer:\r
+\r
+  - **Faces** check-box turns on/off selection of faces;\r
+  - **Edges** check-box turns on/off selection of edges;\r
+  - **Vertices** check-box turns on/off selection of vertices;\r
+\r
+- **Selection sensitivity** defines size of area around object in pixels, in which  mouse click selects object inside this area:\r
+\r
+  - **Vertex** defines selection  sensitivity for vertices; \r
+  - **Edge**  defines selection  sensitivity for edges.  \r
diff --git a/doc/gui/images/find_directory.png b/doc/gui/images/find_directory.png
new file mode 100644 (file)
index 0000000..c35de8f
Binary files /dev/null and b/doc/gui/images/find_directory.png differ
diff --git a/doc/gui/images/open_button.png b/doc/gui/images/open_button.png
new file mode 100644 (file)
index 0000000..21180a2
Binary files /dev/null and b/doc/gui/images/open_button.png differ