Salome HOME
Corrections for the user's manual from the English language point of view
[modules/shaper.git] / src / PrimitivesPlugin / doc / coneFeature.rst
1
2 Cone
3 ====
4
5 Cone feature creates a cone solid.
6
7 To create a Cone in the active part:
8
9 #. select in the Main Menu *Primitives - > Cone* item  or
10 #. click **Cone** button in the toolbar
11
12 .. image:: images/Cone_button.png
13    :align: center
14
15 .. centered::
16    **Cone** button 
17
18 The following property panel appears.
19
20 .. image:: images/Cone.png
21   :align: center
22
23 .. centered::
24    Cone property panel
25
26 Input fields:
27
28 - **Point** defines the center of the cone base selected in 3D OCC  viewer or object browser; 
29 - **Vector** defines the axis of the cone selected in 3D OCC  viewer or object browser;
30 - Dimensions:      
31    - **Base Radius**;
32    - **Top radius**;  
33    - **Height**.
34   
35 **TUI Command**: *model.addCone(Part_doc, Point, Axis, Radius1, Radius2, Height)* 
36
37 **Arguments**:  Part + 1 vertex + 1 vector + 3 real values (base and top radii, heght).
38
39 Result
40 """"""
41
42 If both radii are non-zero, then the cone will be truncated.
43
44 If the radii are equal, the Cylinder will be created instead of cone.
45
46 .. image:: images/Cone_res.png
47            :align: center
48                    
49 .. centered::
50    Cone created  
51
52 **See Also** a sample TUI Script of :ref:`tui_create_cone` operation.