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, check in "Set
   9 presentation parameters and subshapes from arguments" checkbox in the
  10 corresponding dialog.
  11
  12 \n For example, there exist two objects: Box_1 with two published
  13 faces and Cylinder_1 with free published edges.
  14
  15 \image html restore-ss-viewer-before.png "The initial box and cylinder"
  16
  17 First, we examine the case when the resulting shape corresponds to one argument (after transformation,
  18 after the boolean operation Cut, or after the partiton with one object shape).
  19
  20 We create a Cut of Box_1 with Cylinder_1.
  21
  22 \image html restore-ss-cut.png
  23
  24 The resulting shape inherits the subshapes and the colour of Box_1.
  25
  26 \image html restore-ss-viewer-cut.png "The resulting shape"
  27
  28 Second, we examine the case when the  resulting shape is composed from multiple arguments
  29 (after all boolean operations, except for Cut, or after the partition with
  30 several object shapes, or if the resulting shape is a compound).
  31
  32 We create a Common of Box_1 and Cylinder_1.
  33
  34 \image html restore-ss-dialog.png
  35
  36 \n The resulting object is created with several subshapes that correspond to the
  37 operation arguments and their published subshapes. The resulting shape
  38 has a default colour, but its subshapes inherit colors corresponding
  39 to arguments and their subshapes.
  40
  41 \image html restore-ss-viewer-after.png "Thev resulting shape"
  42
  43
  44 Please, note that when the resulting shape corresponds to one
  45 argument, the inherited subshapes depend directly on the resulting shape.
  46
  47 \image html restore-ss-OB-cut.png
  48
  49 When the resulting shape is composed from multiple arguments, the
  50 inherited subshapes depend on the arguments.
  51
  52 \image html restore-ss-OB.png
  53
  54 \n You can also call this functionality from your python scripts.
  55 See our <b>TUI Scripts</b> for \ref tui_restore_prs_params "example".
  56
  57 */