From: dmv <dmv@opencascade.com>
Date: Mon, 11 Aug 2008 13:26:18 +0000 (+0000)
Subject: 0016757: EDF 546 GEOM : Add Face and Disc in geom primitives (DOCUMENTATION)
X-Git-Tag: V5_1_0a1~26
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=e84cf1b119a7a79a96865e5f7d01440b06ef8188;p=modules%2Fgeom.git

0016757: EDF 546 GEOM : Add Face and Disc in geom primitives (DOCUMENTATION)
---

diff --git a/doc/salome/gui/GEOM/images/disk1.png b/doc/salome/gui/GEOM/images/disk1.png
new file mode 100644
index 000000000..215df98d3
Binary files /dev/null and b/doc/salome/gui/GEOM/images/disk1.png differ
diff --git a/doc/salome/gui/GEOM/images/disk2.png b/doc/salome/gui/GEOM/images/disk2.png
new file mode 100644
index 000000000..d6a7a3dab
Binary files /dev/null and b/doc/salome/gui/GEOM/images/disk2.png differ
diff --git a/doc/salome/gui/GEOM/images/disk3.png b/doc/salome/gui/GEOM/images/disk3.png
new file mode 100644
index 000000000..5dd30b554
Binary files /dev/null and b/doc/salome/gui/GEOM/images/disk3.png differ
diff --git a/doc/salome/gui/GEOM/images/disks.png b/doc/salome/gui/GEOM/images/disks.png
new file mode 100644
index 000000000..368d9b6be
Binary files /dev/null and b/doc/salome/gui/GEOM/images/disks.png differ
diff --git a/doc/salome/gui/GEOM/images/face1.png b/doc/salome/gui/GEOM/images/face1.png
new file mode 100644
index 000000000..2fbea98ae
Binary files /dev/null and b/doc/salome/gui/GEOM/images/face1.png differ
diff --git a/doc/salome/gui/GEOM/images/face2.png b/doc/salome/gui/GEOM/images/face2.png
new file mode 100644
index 000000000..97ce397a0
Binary files /dev/null and b/doc/salome/gui/GEOM/images/face2.png differ
diff --git a/doc/salome/gui/GEOM/images/faces.png b/doc/salome/gui/GEOM/images/faces.png
new file mode 100644
index 000000000..b97e81edd
Binary files /dev/null and b/doc/salome/gui/GEOM/images/faces.png differ
diff --git a/doc/salome/gui/GEOM/input/creating_disk.doc b/doc/salome/gui/GEOM/input/creating_disk.doc
new file mode 100755
index 000000000..821198c43
--- /dev/null
+++ b/doc/salome/gui/GEOM/input/creating_disk.doc
@@ -0,0 +1,43 @@
+/*!
+
+\page create_disk_page Disk
+
+To create a \b Disk in the <b>Main Menu</b> select <b>New Entity - >
+Primitives - > Disk</b>
+
+\n There are 3 algorithms to create a \b Disk in 3D space. 
+\n The \b Result of each operation will be a GEOM_Object (face).
+
+\n Firstly, you can create a \b Disk by the given radius at the origin 
+of coordinates. You can define the axis of the disk by the orientation
+group buttons. There are three options to create an object in OXY, OYZ or OZX Planes.
+\n <b>TUI Command:</b> <em>geompy.MakeDiskR(Radius, Orientation)</em>
+\n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and
+orientation).
+\n The orientation can be defined by "1", "2" or "3" values. This 
+means that Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
+
+\image html disk1.png
+
+\n Secondly, you can define a \b Disk by a <b>Center Point</b>, a \b
+Vector giving the circle's normal and a \b Radius.
+\n <b>TUI Command:</b> <em>geompy.MakeDiskPntVecR(Point, Vector,
+Radius)</em>
+\n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
+the direction) + Radius.
+
+\image html disk2.png
+
+\n Finally, you can define a \b Disk by three \b Points that lie on its boundary. 
+\n <b>TUI Command:</b> <em>geompy.MakeDiskThreePnt(Point1, Point2, Point3)</em>
+\n <b>Arguments:</b> Name + 3 points which will form the disk.
+
+\image html disk3.png
+
+<b>Example:</b>
+\image html disks.png
+
+Our <b>TUI Scripts</b> provide you with useful examples of creating 
+\ref tui_creation_disk "Primitives".
+
+*/
diff --git a/doc/salome/gui/GEOM/input/creating_face.doc b/doc/salome/gui/GEOM/input/creating_face.doc
index bdf6164f8..2015e8657 100644
--- a/doc/salome/gui/GEOM/input/creating_face.doc
+++ b/doc/salome/gui/GEOM/input/creating_face.doc
@@ -33,6 +33,6 @@ face or nothing if it is impossible.
 \image html facesn3.png
 
 Our <b>TUI Scripts</b> provide you with useful examples of creation of 
-\ref tui_creation_face "Advanced Geometric Objects".
+\ref tui_creation_squareface "Primitives".
 
 */
diff --git a/doc/salome/gui/GEOM/input/creating_geom_objects.doc b/doc/salome/gui/GEOM/input/creating_geom_objects.doc
index 1c804ae71..5d889f02a 100644
--- a/doc/salome/gui/GEOM/input/creating_geom_objects.doc
+++ b/doc/salome/gui/GEOM/input/creating_geom_objects.doc
@@ -23,6 +23,8 @@
 <li>\ref create_sphere_page</li>
 <li>\ref create_torus_page </li>
 <li>\ref create_cone_page </li>
+<li>\ref create_disk_page </li>
+<li>\ref create_squareface_page </li>
 </ul>
 <li>\subpage create_complex_obj_page</li>
 <ul>
diff --git a/doc/salome/gui/GEOM/input/creating_squareface.doc b/doc/salome/gui/GEOM/input/creating_squareface.doc
new file mode 100755
index 000000000..effcc67e5
--- /dev/null
+++ b/doc/salome/gui/GEOM/input/creating_squareface.doc
@@ -0,0 +1,42 @@
+/*!
+
+\page create_squareface_page Face
+
+To create a \b Disk in the <b>Main Menu</b> select <b>New Entity - >
+Primitives - > Face</b>
+
+\n There are 2 algorithms to create a \b Face in 3D space. 
+\n The \b Result of each operation will be a GEOM_Object (Face).
+
+\n Firstly, you can create a \b Face by the given height and width at the origin 
+of coordinates. You can define the axis of the face by the orientation
+group buttons. There are three options to create a face in OXY, OYZ or OZX Planes.
+\n <b>TUI Command:</b> <em>geompy.MakeFaceHW(Height, Width, Orientation)</em>
+\n <b>Arguments:</b> Name + 3 values (Dimensions at origin: heigth, width and
+orientation).
+\n The orientation can be defined by "1", "2" or "3" values. This 
+means that the Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
+
+\image html face1.png
+
+\n Secondly, you can define a \b Face by a \b Vector giving the face's normal to the center and 
+\b Heigth and Width sizes.
+\n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Vector, Height, Width)</em>
+\n <b>Arguments:</b> Name + 1 Vector (normale to the center) + 2 doubles (to
+describe a face sizes).
+\n You can also create face from another selected face. Just turn the <b>Object Type</b> button 
+to condition \b Face, then you can select a face object and set new values of
+Height and Width for the newly face. The created face will lie in the plane
+of the selected face.
+\n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Face, Height, Width)</em>
+\n <b>Arguments:</b> Name + 1 Face + 2 parameters (to describe a face sizes).
+
+\image html face2.png
+
+<b>Example:</b>
+\image html faces.png
+
+Our <b>TUI Scripts</b> provide you with useful examples of creating 
+\ref tui_creation_face "Primitives".
+
+*/
diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc
index f32498681..cc7fda330 100644
--- a/doc/salome/gui/GEOM/input/index.doc
+++ b/doc/salome/gui/GEOM/input/index.doc
@@ -27,6 +27,8 @@
 <li>\ref create_sphere_page</li>
 <li>\ref create_torus_page </li>
 <li>\ref create_cone_page </li>
+<li>\ref create_disk_page </li>
+<li>\ref create_squareface_page </li>
 </ul>
 <li>\ref create_complex_obj_page</li>
 <ul>
diff --git a/doc/salome/gui/GEOM/input/tui_primitives.doc b/doc/salome/gui/GEOM/input/tui_primitives.doc
index 441ac464c..538067c01 100644
--- a/doc/salome/gui/GEOM/input/tui_primitives.doc
+++ b/doc/salome/gui/GEOM/input/tui_primitives.doc
@@ -156,4 +156,80 @@ gg.createAndDisplayGO(id_cone2)
 gg.setDisplayMode(id_cone2,1)
 \endcode
 
+\anchor tui_creation_disk
+<br><h2>Creation of a Disk</h2>
+
+\code
+import geompy
+import salome
+gg = salome.ImportComponentGUI("GEOM")
+
+# create vertices
+p0 = geompy.MakeVertex(0., 0., 0.)
+px = geompy.MakeVertex(100., 0.  , 0.  )
+py = geompy.MakeVertex(0.  , 100., 0.  )
+pz = geompy.MakeVertex(0.  , 0.  , 100.)
+
+# create a vector on two points
+vxy  = geompy.MakeVector(px, py)
+
+# create a disk in OXY plane
+disk1 = geompy.MakeDiskR(100, 1)
+
+# create a disk from a point, a vector and a radius
+disk2 = geompy.MakeDiskPntVecR(pz, vxy, 30)
+
+#create a circle from three points
+disk3 = geompy.MakeDiskThreePnt(p0, px, py)
+
+# add objects in the study
+id_vxy    = geompy.addToStudy(vxy,  "Vector")
+id_disk1  = geompy.addToStudy(disk1,"Disk1")
+id_disk2  = geompy.addToStudy(disk2,"Disk2")
+id_disk3  = geompy.addToStudy(disk3,"Disk3")
+
+# display disks
+gg.createAndDisplayGO(id_vxy)
+gg.createAndDisplayGO(id_disk1)
+gg.createAndDisplayGO(id_diks2)
+gg.createAndDisplayGO(id_diks3)
+\endcode
+
+\anchor tui_creation_squareface
+<br><h2>Creation of a Face</h2>
+
+\code
+import geompy
+import salome
+gg = salome.ImportComponentGUI("GEOM")
+
+# create vertices
+px = geompy.MakeVertex(100., 0.  , 0.  )
+py = geompy.MakeVertex(0.  , 100., 0.  )
+
+# create a vector on two points
+vxy  = geompy.MakeVector(px, py)
+
+# create a face in OXY plane
+face1 = geompy.MakeFaceHW(100, 100, 1)
+
+# create a disk from a point, a vector and a radius
+face2 = geompy.MakeFaceObjHW(vxy, 50, 150)
+
+#create a circle from three points
+face3 = geompy.MakeFaceObjHW(face2, 150, 50)
+
+# add objects in the study
+id_vxy    = geompy.addToStudy(vxy,  "Vector")
+id_face1  = geompy.addToStudy(face1,"Face1")
+id_face2  = geompy.addToStudy(face2,"Face2")
+id_face3  = geompy.addToStudy(face3,"Face3")
+
+# display disks
+gg.createAndDisplayGO(id_vxy)
+gg.createAndDisplayGO(id_face1)
+gg.createAndDisplayGO(id_face2)
+gg.createAndDisplayGO(id_face3)
+\endcode
+
 */