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

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