ConstructionAPI_Plane.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_PLANE_H_
#define SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_PLANE_H_
 
#include "ConstructionAPI.h"
 
#include <ConstructionPlugin_Plane.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
#include <ModelHighAPI_Integer.h>
 
class ModelHighAPI_Double;
class ModelHighAPI_Selection;
 
class ConstructionAPI_Plane: public ModelHighAPI_Interface
{
public:
  CONSTRUCTIONAPI_EXPORT
  explicit ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theFace,
                        const ModelHighAPI_Double& theDistance,
                        const bool theIsReverse,
                        const ModelHighAPI_Integer& theNbCopy = ModelHighAPI_Integer(1));
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Double& theA,
                        const ModelHighAPI_Double& theB,
                        const ModelHighAPI_Double& theC,
                        const ModelHighAPI_Double& theD);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& thePoint1,
                        const ModelHighAPI_Selection& thePoint2,
                        const ModelHighAPI_Selection& thePoint3);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theLine,
                        const ModelHighAPI_Selection& thePoint,
                        const bool theIsPerpendicular);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theObject1,
                        const ModelHighAPI_Selection& theObject2);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Plane(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& thePlane,
                        const ModelHighAPI_Selection& theAxis,
                        const ModelHighAPI_Double& theAngle,
                        const ModelHighAPI_Integer& theNbCopy = ModelHighAPI_Integer(1));
 
  CONSTRUCTIONAPI_EXPORT
  virtual ~ConstructionAPI_Plane();
 
  INTERFACE_21(ConstructionPlugin_Plane::ID(),
               creationMethod, ConstructionPlugin_Plane::CREATION_METHOD(),
               ModelAPI_AttributeString, ,
               A, ConstructionPlugin_Plane::A(),
               ModelAPI_AttributeDouble, ,
               B, ConstructionPlugin_Plane::B(),
               ModelAPI_AttributeDouble, ,
               C, ConstructionPlugin_Plane::C(),
               ModelAPI_AttributeDouble, ,
               D, ConstructionPlugin_Plane::D(),
               ModelAPI_AttributeDouble, ,
               point1, ConstructionPlugin_Plane::POINT1(),
               ModelAPI_AttributeSelection, ,
               point2, ConstructionPlugin_Plane::POINT2(),
               ModelAPI_AttributeSelection, ,
               point3, ConstructionPlugin_Plane::POINT3(),
               ModelAPI_AttributeSelection, ,
               line, ConstructionPlugin_Plane::LINE(),
               ModelAPI_AttributeSelection, ,
               point, ConstructionPlugin_Plane::POINT(),
               ModelAPI_AttributeSelection, ,
               perpendicular, ConstructionPlugin_Plane::PERPENDICULAR(),
               ModelAPI_AttributeBoolean, ,
               creationMethodByOtherPlane,
               ConstructionPlugin_Plane::CREATION_METHOD_BY_OTHER_PLANE_OPTION(),
               ModelAPI_AttributeString, ,
               plane, ConstructionPlugin_Plane::PLANE(),
               ModelAPI_AttributeSelection, ,
               distance, ConstructionPlugin_Plane::DISTANCE(),
               ModelAPI_AttributeDouble, ,
               reverse, ConstructionPlugin_Plane::REVERSE(),
               ModelAPI_AttributeBoolean, ,
               coincidentPoint, ConstructionPlugin_Plane::COINCIDENT_POINT(),
               ModelAPI_AttributeSelection, ,
               axis, ConstructionPlugin_Plane::AXIS(),
               ModelAPI_AttributeSelection, ,
               angle, ConstructionPlugin_Plane::ANGLE(),
               ModelAPI_AttributeDouble, ,
               plane1, ConstructionPlugin_Plane::PLANE1(),
               ModelAPI_AttributeSelection, ,
               plane2, ConstructionPlugin_Plane::PLANE2(),
               ModelAPI_AttributeSelection, ,
               nbcopy, ConstructionPlugin_Plane::NB_COPIES(),
               ModelAPI_AttributeInteger, )
 
  
  CONSTRUCTIONAPI_EXPORT
  void setByFaceAndDistance(const ModelHighAPI_Selection& theFace,
                            const ModelHighAPI_Double& theDistance,
                            const bool theIsReverse,
                            const ModelHighAPI_Integer& theNbCopy = ModelHighAPI_Integer(1));
 
  CONSTRUCTIONAPI_EXPORT
  void setByGeneralEquation(const ModelHighAPI_Double& theA,
                            const ModelHighAPI_Double& theB,
                            const ModelHighAPI_Double& theC,
                            const ModelHighAPI_Double& theD);
 
  CONSTRUCTIONAPI_EXPORT
  void setByThreePoints(const ModelHighAPI_Selection& thePoint1,
                        const ModelHighAPI_Selection& thePoint2,
                        const ModelHighAPI_Selection& thePoint3);
 
  CONSTRUCTIONAPI_EXPORT
  void setByLineAndPoint(const ModelHighAPI_Selection& theLine,
                         const ModelHighAPI_Selection& thePoint,
                         const bool theIsPerpendicular);
 
  CONSTRUCTIONAPI_EXPORT
  void setByTwoParallelPlanes(const ModelHighAPI_Selection& thePlane1,
                              const ModelHighAPI_Selection& thePlane2);
 
  CONSTRUCTIONAPI_EXPORT
  void setByCoincidentToPoint(const ModelHighAPI_Selection& thePlane,
                              const ModelHighAPI_Selection& thePoint);
 
  CONSTRUCTIONAPI_EXPORT
  void setByRotation(const ModelHighAPI_Selection& thePlane,
                     const ModelHighAPI_Selection& theAxis,
                     const ModelHighAPI_Double& theAngle,
                     const ModelHighAPI_Integer& theNbCopy = ModelHighAPI_Integer(1));
 
  CONSTRUCTIONAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<ConstructionAPI_Plane> PlanePtr;
 
CONSTRUCTIONAPI_EXPORT
PlanePtr addPlane(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Selection& theFace,
                  const ModelHighAPI_Double& theDistance,
                  const bool theIsReverse,
                  const ModelHighAPI_Integer& theNbCopy = ModelHighAPI_Integer(1));
 
CONSTRUCTIONAPI_EXPORT
PlanePtr addPlane(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Double& theA,
                  const ModelHighAPI_Double& theB,
                  const ModelHighAPI_Double& theC,
                  const ModelHighAPI_Double& theD);
 
CONSTRUCTIONAPI_EXPORT
PlanePtr addPlane(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Selection& thePoint1,
                  const ModelHighAPI_Selection& thePoint2,
                  const ModelHighAPI_Selection& thePoint3);
 
CONSTRUCTIONAPI_EXPORT
PlanePtr addPlane(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Selection& theLine,
                  const ModelHighAPI_Selection& thePoint,
                  const bool theIsPerpendicular);
 
CONSTRUCTIONAPI_EXPORT
PlanePtr addPlane(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Selection& theObject1,
                  const ModelHighAPI_Selection& theObject2);
 
CONSTRUCTIONAPI_EXPORT
PlanePtr addPlane(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const ModelHighAPI_Selection& thePlane,
                  const ModelHighAPI_Selection& theAxis,
                  const ModelHighAPI_Double& theAngle,
                  const ModelHighAPI_Integer& theNbCopy = ModelHighAPI_Integer(1));
 
#endif /* SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_PLANE_H_ */