Salome HOME
Corrections for the user's manual from the English language point of view
[modules/shaper.git] / src / PrimitivesPlugin / doc / coneFeature.rst
index 5041deccfe9bf82b9c6347a6742def368f7e11c6..beb1f612f1d42f2ea6e88f6cf82223a36fbf0369 100644 (file)
@@ -1,3 +1,52 @@
 
 Cone
 ====
+
+Cone feature creates a cone solid.
+
+To create a Cone in the active part:
+
+#. select in the Main Menu *Primitives - > Cone* item  or
+#. click **Cone** button in the toolbar
+
+.. image:: images/Cone_button.png
+   :align: center
+
+.. centered::
+   **Cone** button 
+
+The following property panel appears.
+
+.. image:: images/Cone.png
+  :align: center
+
+.. centered::
+   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**: *model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height)* 
+
+**Arguments**:  Part + 1 vertex + 1 vector + 3 real values (base and top radii, heght).
+
+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.
+
+.. image:: images/Cone_res.png
+          :align: center
+                  
+.. centered::
+   Cone created  
+
+**See Also** a sample TUI Script of :ref:`tui_create_cone` operation.