0031458: Visualization - refine classes across Prs3d and StdPrs packages
[occt.git] / src / Prs3d / Prs3d_ToolDisk.hxx
1 // Created on: 2016-02-04
2 // Created by: Anastasia BORISOVA
3 // Copyright (c) 2016 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _Prs3d_ToolDisk_HeaderFile
17 #define _Prs3d_ToolDisk_HeaderFile
18
19 #include <Prs3d_ToolQuadric.hxx>
20
21 //! Standard presentation algorithm that outputs graphical primitives for disk surface.
22 class Prs3d_ToolDisk : public Prs3d_ToolQuadric
23 {
24 public:
25
26   //! Generate primitives for 3D quadric surface and return a filled array.
27   Standard_EXPORT static Handle(Graphic3d_ArrayOfTriangles) Create (const Standard_Real    theInnerRadius,
28                                                                     const Standard_Real    theOuterRadius,
29                                                                     const Standard_Integer theNbSlices,
30                                                                     const Standard_Integer theNbStacks,
31                                                                     const gp_Trsf&         theTrsf);
32 public:
33
34   //! Initializes the algorithm.
35   Standard_EXPORT Prs3d_ToolDisk (const Standard_Real    theInnerRadius,
36                                   const Standard_Real    theOuterRadius,
37                                   const Standard_Integer theNbSlices,
38                                   const Standard_Integer theNbStacks);
39
40   //! Set angle range in radians [0, 2*PI] by default.
41   //! @param theStartAngle [in] Start angle in counter clockwise order
42   //! @param theEndAngle   [in] End   angle in counter clockwise order
43   void SetAngleRange (Standard_Real theStartAngle,
44                       Standard_Real theEndAngle)
45   {
46     myStartAngle = theStartAngle;
47     myEndAngle   = theEndAngle;
48   }
49
50 protected:
51
52   //! Computes vertex at given parameter location of the surface.
53   Standard_EXPORT virtual gp_Pnt Vertex (const Standard_Real theU, const Standard_Real theV) Standard_OVERRIDE;
54
55   //! Computes normal at given parameter location of the surface.
56   virtual gp_Dir Normal (const Standard_Real , const Standard_Real ) Standard_OVERRIDE { return gp_Dir (0.0, 0.0, -1.0); }
57
58 protected:
59
60   Standard_Real myInnerRadius;
61   Standard_Real myOuterRadius;
62   Standard_Real myStartAngle;  //!< Start angle in counter clockwise order
63   Standard_Real myEndAngle;    //!< End   angle in counter clockwise order
64
65 };
66
67 #endif