src/PrimitivesPlugin/doc/coneFeature.rst

   1 .. |Cone_button.icon|    image:: images/Cone_button.png
   2
   3 Cone
   4 ====
   5
   6 Cone feature creates a cone solid.
   7
   8 To create a Cone in the active part:
   9
  10 #. select in the Main Menu *Primitives - > Cone* item  or
  11 #. click |Cone_button.icon| **Cone** button in the toolbar
  12
  13 The following property panel appears.
  14
  15 .. figure:: images/Cone.png
  16    :align: center
  17
  18    Cone property panel
  19
  20 Input fields:
  21
  22 - **Point** defines the center of the cone base selected in 3D OCC  viewer or object browser;
  23 - **Vector** defines the axis of the cone selected in 3D OCC  viewer or object browser;
  24 - Dimensions:
  25    - **Base Radius**;
  26    - **Top radius**;
  27    - **Height**.
  28
  29 **TUI Command**:
  30
  31 .. py:function:: model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height)
  32
  33     :param part: The current part object.
  34     :param object: Vertex.
  35     :param object: Axis.
  36     :param real: Radius 1.
  37     :param real: Radius 2.
  38     :param real: Height.
  39     :return: Result object.
  40
  41 Result
  42 """"""
  43
  44 If both radii are non-zero, then the cone will be truncated.
  45
  46 If the radii are equal, the Cylinder will be created instead of cone.
  47
  48 .. figure:: images/Cone_res.png
  49    :align: center
  50
  51    Cone created
  52
  53 **See Also** a sample TUI Script of :ref:`tui_create_cone` operation.