src/GeomAlgoAPI/GeomAlgoAPI_Placement.h

   1 // Copyright (C) 2014-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_Placement_H_
  21 #define GeomAlgoAPI_Placement_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 #include <GeomAPI_Shape.h>
  27 #include <GeomAPI_Trsf.h>
  28
  29 /// \class GeomAlgoAPI_Placement
  30 /// \ingroup DataAlgo
  31 /// \brief Creates the copied object which sub-element is placed on the given element
  32 class GeomAlgoAPI_Placement : public GeomAlgoAPI_MakeShape
  33 {
  34 public:
  35   /// \brief Creates an object which is obtained from current object by transformation calculated
  36   ///        as a movement of the source object to be coincident with the destination object
  37   /// \param[in] theSourceSolid  a shape to be moved
  38   /// \param[in] theDestSolid    invariant shape
  39   /// \param[in] theSourceShape  a shape on the solid to be made coincident with destination object
  40   /// \param[in] theDestShape    destination object
  41   /// \param[in] theIsReverse    indicates that the solid materials should be on the same side
  42   ///                            against the destination plane
  43   /// \param[in] theIsCentering  indicates the planes should be centered
  44   /// \param[in] theSimpleTransform makes just transformation of shape
  45   ///                               without changing of topology or geometry
  46   GEOMALGOAPI_EXPORT GeomAlgoAPI_Placement(const std::shared_ptr<GeomAPI_Shape> theSourceSolid,
  47                                            const std::shared_ptr<GeomAPI_Shape> theDestSolid,
  48                                            const std::shared_ptr<GeomAPI_Shape> theSourceShape,
  49                                            const std::shared_ptr<GeomAPI_Shape> theDestShape,
  50                                            const bool theIsReverse = false,
  51                                            const bool theIsCentering = false,
  52                                            const bool theSimpleTransform = false);
  53
  54   /// Returns the simple transformation
  55   GEOMALGOAPI_EXPORT std::shared_ptr<GeomAPI_Trsf> transformation() const;
  56
  57 private:
  58   /// builds resulting shape
  59   void build(const std::shared_ptr<GeomAPI_Shape>& theSourceSolid,
  60              const std::shared_ptr<GeomAPI_Shape>& theDestSolid,
  61              const std::shared_ptr<GeomAPI_Shape>& theSourceShape,
  62              const std::shared_ptr<GeomAPI_Shape>& theDestShape,
  63              const bool theIsReverse,
  64              const bool theIsCentering,
  65              const bool theSimpleTransform);
  66
  67 private:
  68   std::shared_ptr<GeomAPI_Trsf> myTrsf; ///< transformation of the shape in case theSimpleTransform
  69 };
  70
  71 #endif