Salome HOME
Implementation of [bos #35140] [EDF] (2023-T1) Memory communication between SHAPER...
[modules/geom.git] / doc / salome / gui / GEOM / input / geometry_preferences.doc
1 /*!
2
3 \page geometry_preferences_page Geometry preferences
4
5 \anchor pref_settings <h2>Settings</h2>
6
7 In the \b Geometry module you can set preferences for visualization of
8 geometrical figures, which can be used right now or in later sessions 
9 with this module according to the preferences.
10
11
12 \image html pref15.png
13
14 \par
15 To redefine any color click on the corresponding line to access to
16 the <b>Select Color</b> dialog box.
17
18 <ul>
19 <li><b>General</b></li>
20 <ul>
21 <li><b>Default display mode</b> - allows to choose between wireframe, shading or 
22 shading with edges.</li>
23 <li><b>Default shading color</b> - allows to select default shading
24 color.</li>
25 <li><b>Edges in shading</b> - allows to select default edges color in shading mode.</li>
26 <li><b> Default wireframe color</b> - allows to select default
27 wireframe color (to be applied to any lines not being free boundaries
28 or isolated lines).</li>
29 <li><b>Color of free boundaries</b> - allows to select default color for free boundaries.</li>
30 <li><b>Color of edges, vectors and wires</b> - allows to select
31 default color for edges, vectors and wires (isolated lines).</li>
32 <li><b>Color of points</b> - allows to select default color for
33 vertices.</li>
34 <li><b>Color of isolines</b> - allows to select default color for
35 isolines.</li>
36 <li><b>Color of labels</b> - allows to select default color for
37 labels (textual fields, shape name).</li>
38 <li><b>Top level color</b> - allows to select default color for objects which 
39 were brought to the viewer foreground.</li>
40 <li><b>Top level display mode</b> - allows to select default top level display mode between:</li>
41 <ul>
42 <li><b>Show additional wireframe actor</b> - allows to have the shading actor at its usual 
43 place (in the back) and add the additional wireframe actor in the viewer foreground.</li>
44 <li><b>Keep current display mode</b> - allows to use current display mode of object.</li>
45 <li><b>Wireframe</b> - allows to switch display mode to wireframe mode after 
46 "top-level" operation.</li>
47 <li><b>Shading</b> - allows to switch display mode to shading mode after 
48 "top-level" operation.</li>
49 <li><b>Shading With Edges</b> - allows to switch display mode to shading with edges mode after 
50 "top-level" operation.</li>
51 </ul>
52 <li><b>Default transparency</b> - allows to define default transparency value.</li>
53 <li><b>Default deflection coefficient</b> - allows to define default deflection
54 coefficient for lines and surfaces. A smaller coefficient provides
55 better quality of a shape in the viewer.</li>
56 <li><b>Show predefined materials in popup menu</b> - allows to customize the displaying of popup menu with list of 
57 predefined materials.</li>
58 <li><b>Default material</b> - allows to define default material.</li>
59 <li><b>Subshapes color for editing a group</b> - allows to select default color for subshapes in a group.</li>
60 <li><b>Default edges width</b> - allows to define default width of the edges.</li>
61 <li><b>Default isolines width</b> - allows to define default width of the isolines.</li>
62 <li><b>Preview edges width</b> - allows to define width of the edges for preview.</li>
63 <li><b>Measures line width</b> - allows to define lines width of measurements tools.</li>
64 <li><b>Step value for spin boxes</b> - allows to define the increment
65 of values set in spin boxes.</li>
66 <li><b>Automatic bring to front</b> - when the option is on, the objects selected by the user automatically become "top-level".</li>
67
68 </ul>
69 </ul>
70
71 <ul>
72 <li><b>Dimensions (Measurements)</b> - a group of preferences controlling the presentation of dimensions.</li>
73 <ul>
74 <li><b>Color</b> - allows to define color for persistent dimension presentations.</li>
75 <li><b>Line width</b> - allows to define pixel width of dimension lines.</li>
76 <li><b>Font height</b> - allows to define height of dimension text.</li>
77 <li><b>Length of arrows</b> - allows to define length of dimension arrows.</li>
78 <li><b>Length measurement units</b> - allows to define units of measurement for lengths dimensions.</li>
79 <li><b>Angle measurement units</b> - allows to define units of measurement for angles dimensions.</li>
80 <li><b>Show units of measurements</b> - when this option is on, the measurement units are added as prefix to value label of dimension.</li>
81 <li><b>Default flyout length</b> - allows to define default flyout length used when creating the dimensions. The length can be interactively changed after creation by moving the flyouts.</li>
82 </ul>
83 </ul>
84
85 <ul>
86 <li><b>Default number of isolines</b> - allows to specify the default number of isolines along <b>Along U</b> and <b>Along V</b> coordinate axes. They are shown on each selected face. For example:
87
88 \image html isos.png
89
90 This preference is not related with <b>Create Isoline</b> operation. 
91 By default <b>Along U</b> and <b>Along V</b> are null and isolines are not drawn. </li>
92  
93 </ul>
94
95 <ul>
96 <li><b>Input fields precision</b> - a group of preferences controlling input
97   precision for floating-point data. The semantics of the precision
98   values is described in detail in <em>Using input widgets</em>
99   chapter of GUI documentation (Introduction to Salome Platform /
100   Introduction to GUI / Using input widgets). In brief: \b positive
101   precision value is the maximum allowed number of digits after the
102   decimal point in the fixed-point format; \b nagative precision value
103   is the maximum allowed number of significant digits in mantissa in
104   either the fixed-point or scientific format.</li>
105 <ul>
106 <li><b>Length precision</b> - allows to adjust input precision of coordinates and dimensions.</li>
107 <li><b>Angular precision</b> - allows to adjust input precision of angles.</li>
108 <li><b>Length tolerance precision</b> - allows to adjust input precision of tolerance of coordinates and dimensions.</li>
109 <li><b>Angular tolerance precision</b> - allows to adjust input precision of tolerance of angles.</li>
110 <li><b>Weight precision</b> - allows to adjust input precision of weight and mass.</li>
111 <li><b>Density precision</b> - allows to a just input precision of density.</li>
112 <li><b>Parametric precision</b> - allows to adjust input precision of parametric values.</li>
113 <li><b>Parametric tolerance precision</b> - allows to adjust input precision of tolerance in parametric space.</li>
114 </ul>
115 </ul>
116
117 <ul>
118 <li><b>Default marker of points</b></li>
119 <ul>
120 <li><b>Type</b> - allows to select the default symbol for representation of
121 points (cross, asterisk, etc.).</li>
122 <li><b>Size</b> - allows to define the default size of the marker from 1
123 (smallest) to 7 (largest).</li>
124 </ul>
125 </ul>
126
127 <ul>
128 <li><b>Scalar bar for field presentation</b></li>
129 <ul>
130 <li><b>X position</b> - allows to define the parametric X position of the scalar bar.</li>
131 <li><b>Y position</b> - allows to define the parametric Y position of the scalar bar.</li>
132 <li><b>Width</b> - allows to define the parametric width of the scalar bar.</li>
133 <li><b>Height</b> - allows to define the parametric height of the scalar bar.</li>
134 <li><b>Text height</b> - allows to define the font height of the scalar bar labels.</li>
135 <li><b>Number of intervals</b> - allows to define the number of scalar bar intervals.</li>
136 </ul>
137 </ul>
138
139 <ul>
140 <li><b>Origin and base vectors</b></li>
141 <ul>
142 <li><b>Length of base vectors</b> - allows to define the length
143 of base vectors.</li>
144 <li><b>Auto create</b> - allows to automatically create a point
145 of origin and three base vectors of the rectangular coordinate
146 system immediately after the module activation.</li>
147 </ul>
148 </ul>
149
150 <ul>
151 <li><b>Operations</b></li>
152 <ul>
153 <li><b>Preview</b> - allows to customize the displaying preview by default.</li>
154 <li><b>Hide input objects from the viewer</b> - allows automatic hiding of input 
155 shapes from the 3D viewer (OCC and VTK) in all operations of Geometry module.</li>
156 </ul>
157 </ul>
158
159 \anchor pref_dependency_tree <h2>Dependency Tree</h2>
160
161 This tab groups preferences for visualization of <b>Dependency Tree</b> in the 2D Viewer.
162
163 \image html pref_dep_tree.png
164
165 <ul>
166 <li><b>General</b></li>
167 <ul>
168 <li><b>Hierarchy type</b> - allows to choose the default display mode of the dependency tree.</li>
169 <li><b>Possibility to move nodes</b> - enables/disables the possibility of moving nodes by default.</li>
170 </ul>
171 </ul>
172
173 <ul>
174 <li><b>Color</b></li>
175 <ul>
176 <li><b>Background color</b> - allows to select the default background color.</li>
177 <li><b>Default node color</b> - allows to select the default node color.</li>
178 <li><b>Main node color</b> - allows to select the default main node color.</li>
179 <li><b>Unpublished node color</b> - allows to select the default node color for unpublished objects.</li>
180 <li><b>Selected node color</b> - allows to select the default selected node color.</li>
181 <li><b>Default arrow color</b> - allows to select the default arrow color.</li>
182 <li><b>Highlighted arrow color</b> - allows to select the default highlighted arrow color.</li>
183 <li><b>Selected arrow color</b> - allows to select the default selected arrow color.</li>
184 </ul>
185 </ul>
186
187 */