src/GeomAlgoAPI/GeomAlgoAPI_Scale.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   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_SCALE_H_
  21 #define GEOMALGOAPI_SCALE_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_Transform.h>
  25
  26 class GeomAPI_Pnt;
  27
  28 /// \class GeomAlgoAPI_Scale
  29 /// \ingroup DataAlgo
  30 /// \brief Creates a copy of the object by performing a scale operation by a factor or
  31 ///        by dimensions.
  32 class GeomAlgoAPI_Scale : public GeomAlgoAPI_Transform
  33 {
  34 public:
  35   /// \brief Creates an object which is obtained from current object by performing
  36   ///        a scale operation by a factor.
  37   /// \param[in] theSourceShape  the shape to be moved.
  38   /// \param[in] theCenterPoint  the center point.
  39   /// \param[in] theFactor       the scale factor.
  40   GEOMALGOAPI_EXPORT GeomAlgoAPI_Scale(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  41                                        std::shared_ptr<GeomAPI_Pnt>   theCenterPoint,
  42                                        double                         theScaleFactor);
  43
  44   /// \brief Creates an object which is obtained from current object by performing
  45   ///        a scale operation by dimensions.
  46   /// \param[in] theSourceShape  the shape to be moved.
  47   /// \param[in] theCenterPoint  the center point.
  48   /// \param[in] theFactorX      the scale factor in X.
  49   /// \param[in] theFactorY      the scale factor in Y.
  50   /// \param[in] theFactorZ      the scale factor in Z.
  51   GEOMALGOAPI_EXPORT GeomAlgoAPI_Scale(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  52                                        std::shared_ptr<GeomAPI_Pnt>   theCenterPoint,
  53                                        double                         theScaleFactorX,
  54                                        double                         theScaleFactorY,
  55                                        double                         theScaleFactorZ);
  56
  57 private:
  58   void buildByDimensions(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  59                          std::shared_ptr<GeomAPI_Pnt>   theCenterPoint,
  60                          double                         theScaleFactorX,
  61                          double                         theScaleFactorY,
  62                          double                         theScaleFactorZ);
  63 };
  64
  65 #endif // GEOMALGOAPI_SCALE_H_