src/FeaturesPlugin/doc/normalToFaceFeature.rst

   1 .. |normalToFace.icon|    image:: images/normal.png
   2
   3 Normal to a face
   4 ================
   5
   6 The **Normal to a face** feature displays the normal to a face. A vertex can be specified to indicate the position of the normal else the center of face is used.
   7
   8 The resulting normal can be created via a dedicated check-box **Create normal**. If this last is checked corresponding result and feature would be created.
   9
  10 If the check-box **Create normal** isn't checked, **Apply** button does not generate any result and has the same effect as **Cancel** for this feature.
  11
  12 To display the normal to a face in the active part:
  13
  14 #. select in the Main Menu *Inspection - > Normal to a face* item  or
  15 #. click |normalToFace.icon| **Normal to a face** button in the toolbar
  16
  17 The property panel is shown below.
  18
  19 .. figure:: images/normalToFacePropertyPanel.png
  20    :align: center
  21
  22    Normal to a face
  23
  24
  25 Input fields:
  26
  27 - **Face** contains face selected in 3D OCC viewer or object browser.
  28 - **Vertex** contains optionnal vertex selected in 3D OCC viewer or object browser.
  29 - **Create normal** check-box allow the creation of the normal (result and feature).
  30
  31 **TUI Command**:
  32
  33 .. py:function:: model.getNormal(Part, face)
  34
  35     :param part: The current part object.
  36     :param object: A face in format *model.selection("FACE", face)*.
  37     :return: Created normal to a face in the center of the face.
  38
  39 Result
  40 """"""
  41
  42 Result of **Normal to a face**.
  43
  44 .. figure:: images/normalToFaceResult.png
  45    :align: center
  46
  47    Normal to a face
  48
  49 **See Also** a sample TUI Script of :ref:`tui_create_normal_to_face` operation.
  50
  51
  52 **TUI Command**:
  53
  54 .. py:function:: model.getNormal(Part, face, vertex)
  55
  56     :param part: The current part object.
  57     :param object: A face in format *model.selection("FACE", face)*.
  58     :param object: A vertex in format *model.selection("VERTEX", vertex)*.
  59     :return: Created normal to a face at vertex.
  60
  61 Result
  62 """"""
  63
  64 Result of **Normal to aface** where **Vertex** is selecteted.
  65
  66 .. figure:: images/normalToFaceResultWithVertex.png
  67    :align: center
  68
  69    Normal to a face at vertex
  70
  71 **See Also** a sample TUI Script of :ref:`tui_create_normal_to_face_at_vertex` operation.