doc/salome/gui/GEOM/input/geometrical_object_properties.doc

   1 /*!
   2
   3 \page geometrical_obj_prop_page Geometrical Object Types
   4
   5 <b>GetType function:</b>
   6
   7 The <b>Type</b> property of the geometrical object specifies the
   8 way the object has been created. It is an integer identifier that
   9 has a predefined value depending on the function type used for the
  10 object creation. The type of the object can be retrieved using the
  11 \b %GetType() function of the \b GEOM_Object interface.
  12
  13 <b>For example</b>: the geometrical object created using MakeBox()
  14 functions has type equal to 7. The shape imported from the BREP,
  15 IGES, STEP or other CAD file, has type equal to 1.
  16
  17 The possible values of the geometrical objects are listed in the table below:
  18
  19 <table border="1" align="center" width="250" cellpadding="3" cellspacing="0" bgcolor="#EEEEEE">
  20             <tr align=center bgcolor=#999999><td>ID</td><td>STRING</td></tr>
  21             <tr align=center><td>0</td><td>COPY</td></tr>
  22             <tr align=center><td>1</td><td>IMPORT</td></tr>
  23             <tr align=center><td>2</td><td>POINT</td></tr>
  24             <tr align=center><td>3</td><td>VECTOR</td></tr>
  25             <tr align=center><td>4</td><td>PLANE</td></tr>
  26             <tr align=center><td>5</td><td>LINE</td></tr>
  27             <tr align=center><td>6</td><td>TORUS</td></tr>
  28             <tr align=center><td>7</td><td>BOX</td></tr>
  29             <tr align=center><td>8</td><td>CYLINDER</td></tr>
  30             <tr align=center><td>9</td><td>CONE</td></tr>
  31             <tr align=center><td>10</td><td>SPHERE</td></tr>
  32             <tr align=center><td>11</td><td>PRISM</td></tr>
  33             <tr align=center><td>12</td><td>REVOLUTION</td></tr>
  34             <tr align=center><td>13</td><td>BOOLEAN</td></tr>
  35             <tr align=center><td>14</td><td>PARTITION</td></tr>
  36             <tr align=center><td>15</td><td>POLYLINE</td></tr>
  37             <tr align=center><td>16</td><td>CIRCLE</td></tr>
  38             <tr align=center><td>17</td><td>SPLINE</td></tr>
  39             <tr align=center><td>18</td><td>ELLIPSE</td></tr>
  40             <tr align=center><td>19</td><td>CIRC_ARC</td></tr>
  41             <tr align=center><td>20</td><td>FILLET</td></tr>
  42             <tr align=center><td>21</td><td>CHAMFER</td></tr>
  43             <tr align=center><td>22</td><td>EDGE</td></tr>
  44             <tr align=center><td>23</td><td>WIRE</td></tr>
  45             <tr align=center><td>24</td><td>FACE</td></tr>
  46             <tr align=center><td>25</td><td>SHELL</td></tr>
  47             <tr align=center><td>26</td><td>SOLID</td></tr>
  48             <tr align=center><td>27</td><td>COMPOUND</td></tr>
  49             <tr align=center><td>28</td><td>SUBSHAPE</td></tr>
  50             <tr align=center><td>29</td><td>PIPE</td></tr>
  51             <tr align=center><td>30</td><td>ARCHIMEDE</td></tr>
  52             <tr align=center><td>31</td><td>FILLING</td></tr>
  53             <tr align=center><td>32</td><td>EXPLODE</td></tr>
  54             <tr align=center><td>33</td><td>GLUED</td></tr>
  55             <tr align=center><td>34</td><td>SKETCHER</td></tr>
  56             <tr align=center><td>35</td><td>CDG</td></tr>
  57             <tr align=center><td>36</td><td>FREE_BOUNDS</td></tr>
  58             <tr align=center><td>37</td><td>GROUP</td></tr>
  59             <tr align=center><td>38</td><td>BLOCK</td></tr>
  60             <tr align=center><td>39</td><td>MARKER</td></tr>
  61             <tr align=center><td>40</td><td>THRUSECTIONS</td></tr>
  62             <tr align=center><td>41</td><td>COMPOUNDFILTER</td></tr>
  63             <tr align=center><td>42</td><td>SHAPES_ON_SHAPE</td></tr>
  64             <tr align=center><td>43</td><td>ELLIPSE_ARC</td></tr>
  65             <tr align=center><td>44</td><td>3DSKETCHER</td></tr>
  66             <tr align=center><td>45</td><td>FILLET_2D</td></tr>
  67             <tr align=center><td>46</td><td>FILLET_1D</td></tr>
  68             <tr align=center><td>201</td><td>PIPETSHAPE</td></tr>
  69 </table>
  70
  71 Also geompy.py module provides a helper function ShapeIdToType()
  72 that allows converting the geometrical object id value to its string representation.
  73
  74 For example, the output of the following code:
  75 \code
  76 import geompy
  77 box = geompy.MakeBoxDXDYDZ(10,10,10)
  78 type = geompy.ShapeIdToType(box.GetType())
  79 print type
  80 \endcode
  81
  82 will be the "BOX" value.
  83
  84 <b>GetShapeType function:</b>
  85
  86 The ShapeType property specifies the geometrical object in terms of
  87 its topologic nature.
  88
  89 The possible values are defined in the GEOM namespace: { COMPOUND, COMPSOLID,
  90 SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE }<br>
  91
  92 This type can be retrieved using the \b %GetShapeType() function
  93 of the \b GEOM_Object interface.
  94
  95 For example:
  96 \code
  97 import geompy
  98 import GEOM
  99 box = geompy.MakeBoxDXDYDZ(10,10,10)
 100 type = box.GetShapeType()
 101 print type == GEOM.SOLID
 102 \endcode
 103
 104 The result is "True".
 105
 106 */