src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAlgoAPI_Rotation.h
   4 // Created:     12 May 2015
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef GeomAlgoAPI_Rotation_H_
   8 #define GeomAlgoAPI_Rotation_H_
   9
  10 #include <GeomAlgoAPI.h>
  11 #include <GeomAlgoAPI_MakeShape.h>
  12 #include <GeomAPI_Ax1.h>
  13 #include <GeomAPI_DataMapOfShapeShape.h>
  14 #include <GeomAPI_Shape.h>
  15
  16 /** \class GeomAlgoAPI_Rotation
  17  *  \ingroup DataAlgo
  18  *  \brief Creates a copy of the object by rotating it around the axis.
  19  */
  20 class GeomAlgoAPI_Rotation : public GeomAPI_Interface
  21 {
  22 public:
  23   /** \brief Creates an object which is obtained from current object by rotating it around the axis.
  24    *  \param[in] theSourceShape  a shape to be rotated.
  25    *  \param[in] theAxis         rotation axis.
  26    *  \param[in] theAngle        rotation angle(in degree).
  27    */
  28   GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  29                                           std::shared_ptr<GeomAPI_Ax1>   theAxis,
  30                                           double                         theAngle);
  31
  32   /// \return true if algorithm succeed.
  33   GEOMALGOAPI_EXPORT const bool isDone() const
  34   { return myDone; }
  35
  36   /// \return true if resulting shape is valid.
  37   GEOMALGOAPI_EXPORT const bool isValid() const;
  38
  39   /// \return true if resulting shape has volume.
  40   GEOMALGOAPI_EXPORT const bool hasVolume() const;
  41
  42   /// \return result of the Placement algorithm which may be a Solid or a Face.
  43   GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape>& shape() const;
  44
  45   /// \return map of sub-shapes of the result. To be used for History keeping.
  46   GEOMALGOAPI_EXPORT void  mapOfShapes(GeomAPI_DataMapOfShapeShape& theMap) const;
  47
  48   /// \return interface for for History processing.
  49   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape* makeShape() const;
  50
  51   /// Destructor.
  52   GEOMALGOAPI_EXPORT virtual ~GeomAlgoAPI_Rotation();
  53
  54 private:
  55   /// Builds resulting shape.
  56   void build(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  57              std::shared_ptr<GeomAPI_Ax1>   theAxis,
  58              double                         theAngle);
  59
  60 private:
  61   /// Fields.
  62   bool myDone;
  63   std::shared_ptr<GeomAPI_Shape> myShape;
  64   GeomAPI_DataMapOfShapeShape    myMap;
  65   GeomAlgoAPI_MakeShape*         myMkShape;
  66 };
  67
  68 #endif