src/GeomAlgoAPI/GeomAlgoAPI_Tube.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 #ifndef GEOMALGOAPI_TUBE_H_
  21 #define GEOMALGOAPI_TUBE_H_
  22
  23 #include <GeomAlgoAPI_MakeShape.h>
  24
  25 /**\class GeomAlgoAPI_Tube
  26  * \ingroup DataAlgo
  27  * \brief Allows to create Tube Primitives
  28  */
  29 class GeomAlgoAPI_Tube : public GeomAlgoAPI_MakeShape
  30 {
  31  public:
  32   GEOMALGOAPI_EXPORT GeomAlgoAPI_Tube();
  33
  34   /// Creates a tube.
  35   /// \param theRMin The inside radius
  36   /// \param theRMax The outside radius
  37   /// \param theZ The heigth
  38   GEOMALGOAPI_EXPORT GeomAlgoAPI_Tube(const double theRMin,
  39                                       const double theRMax,
  40                                       const double theZ);
  41
  42   /// Checks if data for the torus construction is OK.
  43   GEOMALGOAPI_EXPORT bool check();
  44
  45   /// Builds the torus.
  46   GEOMALGOAPI_EXPORT void build();
  47
  48 private:
  49   /// Builds the the tube with the inside radius, the outside radius and the height.
  50   void buildTube();
  51
  52   double myRMin; /// inside radius to create a tube.
  53   double myRMax; /// outside radius to create a tube.
  54   double myZ; /// height to create a tube.
  55 };
  56
  57 #endif // GEOMALGOAPI_TUBE_H_