doc/salome/gui/GEOM/input/manipulate_object.doc

   1 /*!
   2
   3 \page manipulate_object Manipulate GEOM object in the study (module geomtools)
   4
   5 The Python module <a href="geompy_doc/group__geomtools.html">geomtools</a> provides
   6 utility functions to handle %GEOM items in SALOME study:
   7 - add or remove a shape;
   8 - display or erase a shape in the viewer;
   9 - completely delete a shape (undisplay, unpublish, and destroy it);
  10 - manage the selection in the object browser
  11
  12 The usage of <em>geomtools</em> module can be tested with the following set of instructions:
  13
  14 \code
  15 from salome.geom.geomtools import TEST_createAndDeleteShape
  16 TEST_createAndDeleteShape()
  17 \endcode
  18
  19 This test executes the following procedure:
  20 - Create, publish, and display a cylinder;
  21 - Create, publish, and display a sphere;
  22 - Create a box, publish it in a folder <em>boxset</em>, and display it in <em>pink</em> color.
  23 - Erase the sphere from the viewer (the sphere still exists in the study)
  24 - Delete the cylinder. It is no longer displayed and does not exist any more in the study or in the GEOM component.
  25
  26 At outcome of the test execution, the following objects appear in the SALOME session:
  27 - The box located in a dedicated study folder and displayed in the viewer;
  28 - The sphere in the standard place of the study, and not displayed.
  29
  30 */