Mantis issue 0021703: [CEA 577] Boolean operations on groups.

[modules/geom.git] / doc / salome / gui / GEOM / input / geometrical_object_properties.doc

diff --git a/doc/salome/gui/GEOM/input/geometrical_object_properties.doc b/doc/salome/gui/GEOM/input/geometrical_object_properties.doc
index 21b72f7f5e4a4513978867597ad5e2c5eb0262a6..a5b55449a48b9800ab95c1579ac168770d2b7334 100644 (file)
--- a/doc/salome/gui/GEOM/input/geometrical_object_properties.doc
+++ b/doc/salome/gui/GEOM/input/geometrical_object_properties.doc
@@ -1,14 +1,14 @@
 /*!
 
-\page geometrical_obj_prop_page Geometrical Object Properties
+\page geometrical_obj_prop_page Geometrical Object Types
 
-<h2>Geometrical Object Type</h2>
+<b>GetType function:</b>
 
 The <b>Type</b> property of the geometrical object specifies the 
 way the object has been created. It is an integer identifier that 
-has predefined value depending on the function type used for the 
+has a predefined value depending on the function type used for the 
 object creation. The type of the object can be retrieved using the 
-<b>GetType()</b> function.
+\b %GetType() function of the \b GEOM_Object interface.
 
 <b>For example</b>: the geometrical object created using MakeBox() 
 functions has type equal to 7. The shape imported from the BREP, 
@@ -16,8 +16,7 @@ IGES, STEP or other CAD file, has type equal to 1.
 
 The possible values of the geometrical objects are listed in the table below: 
 
-<table border="1" align="center" width="250" cellpadding="3"
-            cellspacing="0" bgcolor="#EEEEEE">
+<table border="1" align="center" width="250" cellpadding="3" cellspacing="0" bgcolor="#EEEEEE">
             <tr align=center bgcolor=#999999><td>ID</td><td>STRING</td></tr>
             <tr align=center><td>0</td><td>COPY</td></tr>
             <tr align=center><td>1</td><td>IMPORT</td></tr>
@@ -66,13 +65,13 @@ The possible values of the geometrical objects are listed in the table below:
             <tr align=center><td>44</td><td>3DSKETCHER</td></tr>
             <tr align=center><td>45</td><td>FILLET_2D</td></tr>
             <tr align=center><td>46</td><td>FILLET_1D</td></tr>
+            <tr align=center><td>201</td><td>PIPETSHAPE</td></tr>
 </table>
 
 Also geompy.py module provides a helper function ShapeIdToType() 
-that allows converting of the geometrical object type id value 
-to its string representation.
+that allows converting the geometrical object id value to its string representation.
 
-<b>For example:</b>
+For example, the output of the following code:
 \code
 import geompy
 box = geompy.MakeBoxDXDYDZ(10,10,10)
@@ -80,6 +79,28 @@ type = geompy.ShapeIdToType(box.GetType())
 print type
 \endcode
 
-The above code prints "BOX" value. 
+will be the "BOX" value.
+
+<b>GetShapeType function:</b>
+
+The ShapeType property specifies the geometrical object in terms of
+its topologic nature.
+
+The possible values are defined in the GEOM namespace: { COMPOUND, COMPSOLID,
+SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }<br>
+
+This type can be retrieved using the \b %GetShapeType() function
+of the \b GEOM_Object interface.
+
+For example:
+\code
+import geompy
+import GEOM
+box = geompy.MakeBoxDXDYDZ(10,10,10)
+type = box.GetShapeType()
+print type == GEOM.SOLID
+\endcode
+
+The result is "True".
 
 */