]> SALOME platform Git repositories - modules/shaper.git/blobdiff - src/PrimitivesPlugin/doc/coneFeature.rst
Salome HOME
[bos #42437] fixed problem where sketch validation icons in toolbar were not activated
[modules/shaper.git] / src / PrimitivesPlugin / doc / coneFeature.rst
index 118d42dbde22e17afbdb4a4d050b86ee6e281976..68788cc4994fb209667adf3376354c3cd53cf67e 100644 (file)
@@ -1,10 +1,53 @@
+.. |Cone_button.icon|    image:: images/Cone_button.png
 
 Cone
 ====
 
+Cone feature creates a cone solid.
 
-.. image:: images/Cone.png
-  :align: center
+To create a Cone in the active part:
 
-.. centered::
-  Create a cone
+#. select in the Main Menu *Primitives - > Cone* item  or
+#. click |Cone_button.icon| **Cone** button in the toolbar
+
+The following property panel appears.
+
+.. figure:: images/Cone.png
+   :align: center
+
+   Cone property panel
+
+Input fields:
+
+- **Point** defines the center of the cone base selected in 3D OCC  viewer or object browser; 
+- **Vector** defines the axis of the cone selected in 3D OCC  viewer or object browser;
+- Dimensions:      
+   - **Base Radius**;
+   - **Top radius**;  
+   - **Height**.
+  
+**TUI Command**:
+
+.. py:function:: model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height)
+
+    :param part: The current part object.
+    :param object: Vertex.
+    :param object: Axis.
+    :param real: Radius 1.
+    :param real: Radius 2.
+    :param real: Height.
+    :return: Result object.
+
+Result
+""""""
+
+If both radii are non-zero, then the cone will be truncated.
+
+If the radii are equal, the Cylinder will be created instead of cone.
+
+.. figure:: images/Cone_res.png
+   :align: center
+                  
+   Cone created  
+
+**See Also** a sample TUI Script of :ref:`tui_create_cone` operation.