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 .. image:: images/Cone.png
  16   :align: center
  17
  18 .. centered::
  19    Cone property panel
  20
  21 Input fields:
  22
  23 - **Point** defines the center of the cone base selected in 3D OCC  viewer or object browser;
  24 - **Vector** defines the axis of the cone selected in 3D OCC  viewer or object browser;
  25 - Dimensions:
  26    - **Base Radius**;
  27    - **Top radius**;
  28    - **Height**.
  29
  30 **TUI Command**:
  31
  32 .. py:function:: model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height)
  33
  34     :param part: The current part object.
  35     :param object: Vertex.
  36     :param object: Axis.
  37     :param real: Radius 1.
  38     :param real: Radius 2.
  39     :param real: Height.
  40     :return: Result object.
  41
  42 Result
  43 """"""
  44
  45 If both radii are non-zero, then the cone will be truncated.
  46
  47 If the radii are equal, the Cylinder will be created instead of cone.
  48
  49 .. image:: images/Cone_res.png
  50            :align: center
  51
  52 .. centered::
  53    Cone created
  54
  55 **See Also** a sample TUI Script of :ref:`tui_create_cone` operation.