Salome HOME
Common update of Salome GUI documentation
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_squareface.doc
1 /*!
2
3 \page create_squareface_page Square Face
4
5 A primitive called <b>Square Face</b> is a square plane of certain dimensions and orientation
6
7 To create a \b Square Face  in the <b>Main Menu</b> select <b>New Entity - >
8 Primitives - > Face</b>
9
10 \n There are 2 algorithms to create a \b Square \b Face in the 3D space. 
11 \n The \b Result of each operation will be a GEOM_Object (Face).
12
13 \n Firstly, you can create a \b Face at the origin 
14 of coordinates defining its boundaries by the height and the width and its axis by the orientation
15 radio buttons (OXY, OYZ or OZX).This 
16 means that the Square Face will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
17 \n <b>TUI Command:</b> <em>geompy.MakeFaceHW(Height, Width, Orientation)</em>
18 \n <b>Arguments:</b> Name + 3 values (Dimensions at origin: heigth, width and
19 orientation).
20
21
22 \image html face1.png
23
24 \n Secondly, you can define a \b Face by Heigth and Width sizes and an \b Edge defining the normal to the center of the face.
25 \n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Vector, Height, Width)</em>
26 \n <b>Arguments:</b> Name + 1 Vector (normal to the center) + 2 doubles (to
27 describe a face sizes).
28
29 \n It is also possible to create a Square Face from another selected face. For this, switch the <b>Object Type</b> button 
30 to \b Face, then select a face object and set the values of
31 Height and Width for the new face. The created face will lie in the plane of the selected face.
32 \n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Face, Height, Width)</em>
33 \n <b>Arguments:</b> Name + 1 Face + 2 parameters (to describe a face sizes).
34
35 \image html face2.png
36
37 <b>Example:</b>
38 \image html faces.png
39
40 Our <b>TUI Scripts</b> provide you with useful examples of creating 
41 \ref tui_creation_face "Primitives".
42
43 */