include/opencascade/Prs3d_ToolSphere.hxx

0001 // Created on: 2016-02-04
0002 // Created by: Anastasia BORISOVA
0003 // Copyright (c) 2016 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _Prs3d_ToolSphere_HeaderFile
0017 #define _Prs3d_ToolSphere_HeaderFile
0018
0019 #include <Prs3d_ToolQuadric.hxx>
0020
0021 //! Standard presentation algorithm that outputs graphical primitives for spherical surface.
0022 class Prs3d_ToolSphere : public Prs3d_ToolQuadric
0023 {
0024 public:
0025
0026   //! Generate primitives for 3D quadric surface.
0027   //! @param theRadius   [in] sphere radius
0028   //! @param theNbSlices [in] number of slices within U parameter
0029   //! @param theNbStacks [in] number of stacks within V parameter
0030   //! @param theTrsf     [in] optional transformation to apply
0031   //! @return generated triangulation
0032   Standard_EXPORT static Handle(Graphic3d_ArrayOfTriangles) Create (const Standard_Real    theRadius,
0033                                                                     const Standard_Integer theNbSlices,
0034                                                                     const Standard_Integer theNbStacks,
0035                                                                     const gp_Trsf&         theTrsf);
0036 public:
0037
0038   //! Initializes the algorithm creating a sphere.
0039   //! @param theRadius   [in] sphere radius
0040   //! @param theNbSlices [in] number of slices within U parameter
0041   //! @param theNbStacks [in] number of stacks within V parameter
0042   Standard_EXPORT Prs3d_ToolSphere (const Standard_Real    theRadius,
0043                                     const Standard_Integer theNbSlices,
0044                                     const Standard_Integer theNbStacks);
0045
0046 protected:
0047
0048   //! Computes vertex at given parameter location of the surface.
0049   Standard_EXPORT virtual gp_Pnt Vertex (const Standard_Real theU, const Standard_Real theV) const Standard_OVERRIDE;
0050
0051   //! Computes normal at given parameter location of the surface.
0052   Standard_EXPORT virtual gp_Dir Normal (const Standard_Real theU, const Standard_Real theV) const Standard_OVERRIDE;
0053
0054 protected:
0055
0056   Standard_Real myRadius; //!< sphere radius
0057
0058 };
0059
0060 #endif