doc/salome/gui/GEOM/input/annotation.doc

   1 /*!
   2
   3 \page annotation_page Shape annotation
   4
   5 <b> Annotation </b> functionality allows showing in the viewer special user-defined text label connected to corresponding part of a CAD model with a line.
   6 Annotation text is always parallel to the screen and horizontal. It is not zoomed or rotated when a 3D scene is zoomed or rotated by the user.
   7 The annotation text is defined using UTF-8 encoding and thus support any Unicode characters.
   8
   9 There are several algorithms for the annotation position calculation during the scene manipulations (panning, zooming, rotation):
  10 <ul>
  11   <li>Algorithm 1: an annotation has fixed position in 2D screen coordinates (fixed screen position mode). In this mode, the annotations are always visible (appear as topmost objects), never hidden by the (annotated) geometry.</li>
  12   <li>Algorithm 2: an annotation has fixed position in 3D model space, this position is projected onto the screen just as normal point coordinates. In this mode, some annotations may be invisible depending on the camera (position, orientation, zoom).</li>
  13 </ul>
  14
  15 \image html annotation_preview.png
  16
  17 It can be accessed from the main menu via <b>Inspection -> Annotation </b>
  18
  19 \image html annotation.png "Create Annotation dialog"
  20
  21 In this dialog you can:
  22 <ul>
  23   <li>Set <b>Text</b> text shown in View 3d and a name of annotation presented in the Text Browser.</li>
  24   <li>Select a \b Shape to which the annotation will be assigned.</li>
  25   <li>Set <b>Fixed screen position</b> to select alogithm for the annotation position caldulation.</li>
  26   <li>Select a <b>Shape Type</b> to which the annotation will be assigned on the shape.
  27   It contains "Whole shape", "Vertex", "Edge", "Face" and "Solid" choices.</li>
  28   <li>Select a sub shape to assign annotation to. Text control contains information about local selection in the viewer.</li>
  29   <li>Move annotation dragging it in 3D view to select an appropriate position.</li>
  30   <li>Push \b Apply or <b>Apply and Close</b> button to commit creation of the field.</li>
  31 </ul>
  32
  33 Annotations appear in an Annotations sub-tree in Text Browser.</li>
  34 The foolowing context menu commands are provided for annotation object in Text Browser:
  35 <ul>
  36   <li><b>Edit</b> allows modifying the annotation text, the positioning algorithm and the annotation position.</li>
  37   <li><b>Delete</b> deletes selected annotation.</li>
  38   <li><b>Show</b>/<b>Hide</b> change visibility of annotation in the active view.</li>
  39 </ul>
  40 <b>Edit</b> and <b>Delete</b> actions are also available in View 3d for selected annotation object/s.
  41
  42 All annotations may be shown/hidden in a 3D view. The corresponded popup menu is available in Text Browser.
  43
  44 All annotations of a shape may be shown/hidden in a 3D view using corresponded popup menu on the shape item in Object Browser.
  45
  46 Synchronization of selection between 3D view and Text browser is available. It means that selection of annotation in 3D view will select this annotation in Text browser and vice versa.
  47
  48 Annotation is logically connected to the shape:
  49 <ul>
  50   <li>Selection of an annotation will highlight corresponding shape/subshape in 3D view.</li>
  51   <li>When the shape is deleted, the annotation will be also deleted.</li>
  52 </ul>
  53
  54 The user is able to modify the font, the style, the color and the size of the annotation text and the color, the width and the style of the connection line applied to all annotations.
  55 It can be accessed from the main menu via <b>File -> Preferences</b>. The Shape annotations group on Geometry Settings pane contains controls for it.
  56
  57 */