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

   1 /*!
   2
   3 \page restore_presentation_parameters_page Advanced Transformation Options
   4
   5 <br><center><b>Set presentation parameters and sub-shapes from arguments</b></center>
   6
   7 \n This option allows the operation result to inherit color
   8 and sub-shapes from its arguments.
   9
  10 \n To activate this functionality, check in "Set
  11 presentation parameters and sub-shapes from arguments" checkbox in the
  12 corresponding dialog.
  13
  14 \n For example, there exist two objects: Box_1 with two published
  15 faces and Cylinder_1 with free published edges.
  16
  17 \image html restore-ss-viewer-before.png "The initial box and cylinder"
  18
  19 First, we examine the case when the resulting shape corresponds to one argument (after transformation,
  20 after the Boolean operation Cut, or after the partition with one object shape).
  21
  22 We create a Cut of Box_1 with Cylinder_1.
  23
  24 \image html restore-ss-cut.png
  25
  26 The resulting shape inherits the sub-shapes and the colour of Box_1.
  27
  28 \image html restore-ss-viewer-cut.png "The resulting shape"
  29
  30 Second, we examine the case when the resulting shape is composed from multiple arguments
  31 (after all Boolean operations, except for Cut, or after the partition with
  32 several object shapes, or if the resulting shape is a compound).
  33
  34 We create a Common of Box_1 and Cylinder_1.
  35
  36 \image html restore-ss-dialog.png
  37
  38 \n The resulting object is created with several sub-shapes that correspond to the
  39 operation arguments and their published sub-shapes. The resulting shape
  40 has a default color, but its sub-shapes inherit colors corresponding
  41 to arguments and their sub-shapes.
  42
  43 \image html restore-ss-viewer-after.png "The resulting shape"
  44
  45
  46 Please, note that when the resulting shape corresponds to one
  47 argument, the inherited sub-shapes depend directly on the resulting shape.
  48
  49 \image html restore-ss-OB-cut.png
  50
  51 When the resulting shape is composed from multiple arguments, the
  52 inherited sub-shapes depend on the arguments.
  53
  54 \image html restore-ss-OB.png
  55
  56 \n You can also call this functionality from your python scripts.
  57 See our <b>TUI Scripts</b> for \ref tui_restore_prs_params "example".
  58
  59 <br><center><b>Add prefix to names of restored sub-shapes</b></center>
  60 This option allows adding the prefix "from_" to the names of
  61 restored sub-shapes, and the prefix "from_subshapes_of_" to the names of partially restored sub-shapes.
  62 By default this option is On.
  63
  64 \anchor preview_anchor <br><center><b>Preview</b></center>
  65 <b>Preview</b> checkbox allows displaying/erasing simulation of the <b>Result</b> in the viewer.
  66
  67 */