doc/salome/gui/VISU/input/cut_segment.doc

   1 /*!
   2
   3 \page cut_segment_page Cut Segment presentation
   4 \image html cutsegmentprsnt.png "Example of Cut Segment presentation"
   5
   6 \n <b>Cut Segment</b> is a simplified variant of
   7 \ref cut_lines_page "Cut Lines" presentation, displaying a single line
   8 instead of a set of lines. The axis of this line is
   9 defined by two points in a 3D space.
  10
  11 <em>To create a Cut Segment presentation:</em>
  12 \par
  13 &ndash; Right-click on one of the time stamps of the field in the
  14 Object browser and from the pop-up menu choose <b>Cut Segment</b>, or
  15 \n &ndash; Click on one of the time stamps of the field in the Object
  16 browser and select from the main menu <b>Visualization > Cut
  17 Segment</b>, or click <em>"Cut Segment"</em> icon in the <b>Visualization
  18 Toolbar</b>.
  19
  20 \image html cutsegmenticon.jpg
  21 <center><em>"Cut Segment" icon</em></center>
  22
  23 \image html cutsegment.png
  24
  25 \par
  26 <b>Cut Segment:</b> this tab of the dialog box contains the
  27 parameters of the cut segment.
  28 <ul>
  29 <li><b>Point 1</b> and <b>Point 2</b> spin boxes allow to set the coordinates
  30 of two points, defining an axis of the segment.</li>
  31 <li><b>Show preview</b> check box allows to edit the parameters of the
  32 presentation and simultaneously observe the preview of this
  33 presentation in the viewer.</li>
  34 <li><b>Invert curve</b> check box allows to invert the resulting
  35 curve.</li>
  36 <li><b>Use absolute length</b> check box allows to see the real length
  37 of the line, instead of [0,1] interval.</li>
  38 <li><b>Generate Data Table:</b> If this check box is marked, Post-Pro
  39 will automatically generate a data table on the basis of your Cut
  40 Segment presentation. This table will be created in the structure of the
  41 study.</li>
  42 <li><b>Generate Curve:</b> If this check box is marked, Post Pro
  43 will automatically generate curve line on the basis of values taken
  44 from the generated data table. This curve will be created in the
  45 structure of the study and can be visualized in a XY plot.</li>
  46 </ul>
  47 See more about table presentations and curve lines
  48 \ref table_presentations_page "here".
  49
  50 \par
  51 <b>Scalar Bar</b> tab allows to define the parameters of the scalar bar
  52 displayed with this presentation (\ref scalar_map_page "see also").
  53
  54 After you have finished with setting these parameters, click \b
  55 OK. Your presentation with scalar bar will be immediately displayed in
  56 the viewer:
  57
  58 <b>Tip:</b> From <b>Cut Segment</b> presentation you can create a
  59 <b>data table</b>. This table will consist of the field scalar values
  60 located on the cut line of the constructed presentation. After that
  61 your data table can be used for construction of a 2d plot
  62 based on the scalar values from the table (see also:
  63 \ref creating_curves_page "Creating curves" and
  64 \ref creating_plot2d_page "Creating Plot 2D presentation").
  65
  66 <br><b>See Also</b> a sample TUI Script of
  67 \ref tui_cut_segment_page "Cut Segment" presentation creation.
  68
  69 */