src/GeomAlgoAPI/GeomAlgoAPI_Torus.h

   1 // Copyright (C) 2017-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // File:        GeomAlgoAPI_Torus.h
  21 // Created:     20 Mar 2017
  22 // Author:      Clarisse Genrault (CEA)
  23
  24 #ifndef GEOMALGOAPI_TORUS_H_
  25 #define GEOMALGOAPI_TORUS_H_
  26
  27 #include <GeomAlgoAPI_MakeShape.h>
  28
  29 #include <GeomAPI_Ax2.h>
  30
  31 /**\class GeomAlgoAPI_Torus
  32  * \ingroup DataAlgo
  33  * \brief Allows to create Torus Primitives
  34  */
  35 class GeomAlgoAPI_Torus : public GeomAlgoAPI_MakeShape
  36 {
  37  public:
  38   /// Creates a torus.
  39   /// \param theAxis The axis of the torus
  40   /// \param theRadius The radius of the torus
  41   /// \param theRingRadius The ring radius of the torus
  42   GEOMALGOAPI_EXPORT GeomAlgoAPI_Torus(std::shared_ptr<GeomAPI_Ax2> theAxis,
  43                                        const double theRadius,
  44                                        const double theRingRadius);
  45
  46   /// Checks if data for the torus construction is OK.
  47   GEOMALGOAPI_EXPORT bool check();
  48
  49   /// Builds the torus.
  50   GEOMALGOAPI_EXPORT void build();
  51
  52  private:
  53   std::shared_ptr<GeomAPI_Ax2> myAxis; /// Axis of the torus.
  54   double myRadius; /// Radius of the torus.
  55   double myRingRadius; /// Ring radius of the torus.
  56 };
  57
  58 #endif // GEOMALGOAPI_TORUS_H_