doc/salome/gui/GEOM/input/restore_presentation_parameters.doc

   1 /*!
   2
   3 \page restore_presentation_parameters_page Restore presentation parameters and a tree of subshapes
   4
   5 \n This functionality allows the operation result to inherit colour
   6 and subshapes from its arguments.
   7
   8 \n To activate this functionality, one should check the "Set
   9 presentation parameters and subshapes from arguments" checkbox in
  10 corresponding dialog.
  11
  12 \image html restore-ss-dialog.png
  13
  14 \n Let us view an example to understand, how it works.
  15 Before the partitioning we had box Box_1 with two published faces and
  16 cylinder Cylinder_1 with free published edges. After the partition we
  17 have also resulting object with several subshapes, that corresponds to
  18 operation arguments and their published subshapes. We performed two
  19 partitions: Partition_1 result obtained by partitioning two objects
  20 Box_1 and Cylinder_1 as objects, with no tool, Partiton_2 obtained by
  21 partitioning Box_1 object with Cylinder_1 tool:
  22
  23 \image html restore-ss-OB.png
  24
  25 \n If all the shapes and subshapes have their own colours before the
  26 partitioning, the resultiong shape and its automatically generated
  27 subshapes will inherit these colours.
  28
  29 \n If the resulting shape corresponds to its first argument (like
  30 after transformation or after the boolean operation Cut, or after the
  31 partiton with one object shape), it inherits its colour, and also
  32 inherits its subshapes (like Partition_2).
  33
  34 \n In the case, when the resulting shape composed from multiple arguments
  35 (like after boolean operations, except Cut, or after the partition with
  36 several object shapes, or it is a compound), it will have default
  37 colour, but its generated subshapes, corresponding to arguments and
  38 their subshapes, will inherit corresponding colours. And in this case
  39 it will have generated subshapes, corresponding to the arguments (like
  40 Partition_1).
  41
  42 \n See the picture before the partition:
  43
  44 \image html restore-ss-viewer-before.png
  45
  46 \n And the picture, displaying only the Partition_2 with subshapes:
  47
  48 \image html restore-ss-viewer-after.png
  49
  50 \n You can also call this functionality from your python scripts.
  51 See our <b>TUI Scripts</b> for \ref tui_restore_prs_params "example".
  52
  53 */