Salome HOME
Merge from V7_3_BR branch 18/12/2013
[modules/yacs.git] / doc / representation.rst
1
2
3
4 Representation of a schema
5 ==========================
6
7
8
9
10 .. _change_2d_representation_schema:
11
12
13 Change 2D representation of a schema
14 ------------------------------------
15 The schema consists of several nodes of control and computation types. These nodes have input and output data, stream and control ports. 
16 Connecting these ports by links means transferring data from output port to input port of a next node.
17
18 At the current moment YACS GUI for SALOME provides the user with only one view mode of a schema.
19
20
21 .. _full_view_of_a_schema:
22
23
24 + **Full view.** Nodes are "fully" displayed, with all ports and information labels. All links between connected ports are shown.
25
26 .. image:: images/functionality_list_77.jpg
27   :align: center
28
29 .. centered::
30   **Full view of a schema**
31
32
33 Within YACS module the user can zoom-in and zoom-out 2D schema presentation interactively with the mouse, 
34 fit 2D presentation of a schema into 2D Viewer bounds (**Fit all** operation) and pan content of 2D Viewer (**Panning** operation) 
35 interactively with the mouse. 
36 These commands are accessible from :ref:`View Operations toolbar <view_operations_toolbar>`.
37
38 The user can also use the mouse wheel button to zoom in and out and the arrow key for panning.
39
40 The user can also zoom inside a composed node by using the **zoom to bloc** command from the node context menu.
41
42 .. image:: images/functionality_list_77a.jpg
43   :align: center
44
45 .. centered::
46   **A zoom inside loopIter composed node**
47
48 Use **Fit all** operation to go back to full view.
49
50 .. _auto-arrange_nodes:
51
52 Auto-arrange schema nodes
53 -------------------------
54 It is a very useful operation, because it simplifies the schema presentation in the schema 2D Viewer and makes it easier for the user perception. 
55 This operation is applicable to the whole schema (**arrange nodes recursion** command from the schema context menu) or only to some parts
56 of the schema (**arrange local nodes** command from a composed node context menu).
57
58 .. _rebuild_links:
59
60 Rebuild links between nodes
61 ---------------------------
62 It is a very useful operation, because it simplifies the schema presentation in the schema 2D Viewer and makes it easier for the user perception. 
63 This operation constructs links in orthogonal mode.
64
65 The rebuild links between nodes operation is performed automatically when **automatic link** option is activated in the YACS main menu or
66 in the toolbar :ref:`edition_toolbar`. To force links computation, use the **compute links** command from the node context menu.
67
68 The user can change the links representation with the options **simplify links** which tries to make the links as direct as possible with
69 a slight CPU cost and **separate links** which tries to avoid links superposition with again a CPU cost.
70