Salome HOME
optparse => argparse
[modules/hexablock.git] / doc / gui_asso_vertex_to_geom.rst
1 :tocdepth: 3
2
3 .. _guiassovertex2:
4
5 ========================================
6 GUI: Definition of point of the geometry
7 ========================================
8
9 To make a vertex association you need to define the Geom Point you want to associate 
10 your vertex to.
11
12 There are five algorithms to create a Point in the 3D space in Geom. 
13 Each time the Result of the operation will be a GEOM_Object (vertex).
14
15
16 .. _guiassovertexcoords:
17
18 By coordinates
19 ==============
20
21 Firstly, we can define a point by setting its X, Y and Z Coordinates.
22
23 **Arguments:**
24
25 - Name of the vertex of the model
26 - Name of the resulting point
27 - X, Y and Z coordinates of the point
28
29 The dialogue box to associate a vertex to a point defined by its coordinates is:
30
31 .. image:: _static/gui_vertex_assoc_coordinates.png
32    :align: center
33
34 .. centered::
35    Point defined by its coordinates
36
37
38 .. _guiassovertexref:
39
40 By a reference
41 ==============
42
43 Secondly, we can define a point by a Reference to another point and the shift of the coordinates of the new point regarding the coordinates of the old one. 
44
45 **Arguments:**
46
47 - Name of the vertex of the model
48 - Name of the resulting point
49 - 1 reference point
50 - 3 coordinates defining the position of this point regarding the reference one
51
52 The dialogue box to associate a vertex to a point defined by a reference is:
53
54 .. image:: _static/gui_vertex_assoc_on_geom_point.png
55    :align: center
56
57 .. centered::
58    Point defined by reference to a point of the geometry and a translation
59
60
61 .. _guiassovertexedgeparam:
62
63 By an Edge and a Parameter
64 ==========================
65
66 Thirdly, we can define a point by an Edge and a Parameter indicating its position on the Edge, ranging from 0.0 to 1.0. For example, 0.5 means that the point is located in the middle of the edge. 
67
68 **Arguments:**
69
70 - Name of the vertex of the model
71 - Name of the resulting point
72 - 1 edge
73 - 1 Parameter defining the position of the point on the given edge
74
75
76 The dialogue box to associate a vertex to a point of the geometry defined by an edge and parameter:
77
78 .. image:: _static/gui_vertex_assoc_on_edge_byParam.png
79    :align: center
80
81 .. centered::
82    Point defined by an edge and a parameter
83    
84    
85 .. _guiassovertexedgelength:
86
87 By an Edge and a Length
88 =======================
89
90 Alternatively, it is possible to define a point by an Edge and a Length. 
91 The Length defines the position of the point on the given edge. 
92 It can exceed the length of the edge or be negative. 
93 In this case the edge is extrapolated along its curve (except for bezier and b-spline curves). 
94 The Start Point defines the direction for the length calculation (if not defined, the first vertex of Edge is used, else the vertex of Edge closest to StartPoint is used). 
95
96 **Arguments:**
97
98 - Name of the vertex of the model
99 - Name of the resulting point
100 - 1 edge 
101 - 1 Point
102 - 1 Length
103
104 The dialogue box to associate a vertex to a point of the geometry defined by an edge and a length:
105
106 .. image:: _static/gui_vertex_assoc_on_edge_byLength.png
107    :align: center
108
109 .. centered::
110    Point defined by an edge and a length
111    
112    
113 .. _guiassovertexedgecoords:
114
115 By an Edge and Coordinates
116 ==========================
117
118 It is also possible to define 3D coordinates of the point projected on the given edge to produce the resulting point. 
119
120 **Arguments:**
121
122 - Name of the vertex of the model
123 - Name of the resulting point
124 - 3 coordinate values of the projected point
125 - 1 edge
126
127 The dialogue box to associate a vertex to a point of the geometry defined by an edge and coordinates:
128
129 .. image:: _static/gui_vertex_assoc_on_edge_byCoords.png
130    :align: center
131
132 .. centered::
133    Point defined by an edge and 3 coordinates
134    
135    
136 .. _guiassovertexlineintersect:
137
138 By intersection of two Lines or Wires
139 =====================================
140
141 Fourthly, we can define a point(s) by intersection of two Lines or Wires (or a Wire and a Line).
142 If they intersect only once, a point will be created. If there are several intersections, a compound of points will be created. 
143 The type of the selected object (Line or Wire) can be changed in the popup menu, after clicking the corresponding selection button. (see the picture below) 
144
145 **Arguments:**
146
147 - Name ot he vertex of the model
148 - Name of the resulting point
149 - 2 1D objects (Line or Wire)
150
151 The dialogue box to associate a vertex to a point of the geometry defined by the intersection of two lines or wires is:
152
153 .. image:: _static/gui_vertex_assoc_on_lines_intersection.png
154    :align: center
155
156 .. centered::
157    Point defined by the intersection of two lines or wires
158    
159    
160 .. _guiassovertexpointonfaceparams:
161
162 By a face and two parameters
163 ============================
164
165 Finally, we can define a point by a Face and Two Parameters: U and V indicating its position on the Face, ranging from 0.0 to 1.0. 
166 For example, (0.5; 0.5) means that the point is located in the middle of the face. 
167
168 **Arguments:**
169
170 - Name of the vertex of the model
171 - Name of the resulting point
172 - 1 face
173 - 2 Parameters defining the position of the point on the given face
174
175 The dialogue box to associate a vertex to a point on a face using U and V parameters is:
176
177 .. image:: _static/gui_vertex_assoc_on_face_byParam.png
178    :align: center
179
180 .. centered::
181    Point defined by a face and two parameters  
182    
183       
184 .. _guiassovertexpointonfacecoords:
185
186 By a face and coordinates
187 =========================
188
189 Alternatively, it is possible to define 3D coordinates of the point projected on the given face.
190
191 **Arguments:**
192
193 - Name of the vertex of the model
194 - Name of the resulting point
195 - 3 coordinate values to project point on the given face
196 - 1 face
197
198 The dialogue box to associate a vertex to a point on a face using coordinates is:
199
200 .. image:: _static/gui_vertex_assoc_on_face_byCoords.png
201    :align: center
202
203 .. centered::
204    Point defined by a face and 3 coordinates
205    
206
207 GUI: :ref:`guiassovertex`