ConstructionAPI_Point.h

// Copyright (C) 2014-2025  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_POINT_H_
#define SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_POINT_H_
 
#include "ConstructionAPI.h"
 
#include <ConstructionPlugin_Point.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelAPI_AttributeDouble;
class ModelAPI_Document;
class ModelHighAPI_Double;
 
class ConstructionAPI_Point: public ModelHighAPI_Interface
{
public:
  CONSTRUCTIONAPI_EXPORT
  explicit ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Double& theX,
                        const ModelHighAPI_Double& theY,
                        const ModelHighAPI_Double& theZ);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theEdge,
                        const ModelHighAPI_Double& theOffset,
                        const bool theUseRatio = false,
                        const bool theReverse = false);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theObject1,
                        const ModelHighAPI_Selection& theObject2);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theObject1,
                        const ModelHighAPI_Selection& theObject2,
                        const ModelHighAPI_Selection& theObject3);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const ModelHighAPI_Selection& theObject,
                        const bool theIsCircularEdge = false,
                        const bool theIsXYZSelection = false);
 
  CONSTRUCTIONAPI_EXPORT
  virtual ~ConstructionAPI_Point();
 
  INTERFACE_25(ConstructionPlugin_Point::ID(),
    point, ConstructionPlugin_Point::POINT3D(),
    GeomDataAPI_Point, ,
    creationMethod, ConstructionPlugin_Point::CREATION_METHOD(),
    ModelAPI_AttributeString, ,
    intersectionType, ConstructionPlugin_Point::INTERSECTION_TYPE(),
    ModelAPI_AttributeString, ,
    intersectionLine1, ConstructionPlugin_Point::INTERSECTION_LINE_1(),
    ModelAPI_AttributeSelection, ,
    intersectionLine2, ConstructionPlugin_Point::INTERSECTION_LINE_2(),
    ModelAPI_AttributeSelection, ,
    intersectionLine, ConstructionPlugin_Point::INTERSECTION_LINE(),
    ModelAPI_AttributeSelection, ,
    intersectionPlane, ConstructionPlugin_Point::INTERSECTION_PLANE(),
    ModelAPI_AttributeSelection, ,
    intersectionPlane1, ConstructionPlugin_Point::INTERSECTION_PLANE_1(),
    ModelAPI_AttributeSelection, ,
    intersectionPlane2, ConstructionPlugin_Point::INTERSECTION_PLANE_2(),
    ModelAPI_AttributeSelection, ,
    intersectionPlane3, ConstructionPlugin_Point::INTERSECTION_PLANE_3(),
    ModelAPI_AttributeSelection, ,
    useOffset, ConstructionPlugin_Point::USE_OFFSET(),
    ModelAPI_AttributeString, ,
    offset, ConstructionPlugin_Point::OFFSET(),
    ModelAPI_AttributeDouble, ,
    reverseOffset, ConstructionPlugin_Point::REVERSE_OFFSET(),
    ModelAPI_AttributeBoolean, ,
    edge, ConstructionPlugin_Point::EDGE(),
    ModelAPI_AttributeSelection, ,
    offsetType, ConstructionPlugin_Point::OFFSET_TYPE(),
    ModelAPI_AttributeString, ,
    distance, ConstructionPlugin_Point::DISTANCE(),
    ModelAPI_AttributeDouble, ,
    ratio, ConstructionPlugin_Point::RATIO(),
    ModelAPI_AttributeDouble, ,
    reverse, ConstructionPlugin_Point::REVERSE(),
    ModelAPI_AttributeBoolean, ,
    pointToProject, ConstructionPlugin_Point::POINT_TO_PROJECT(),
    ModelAPI_AttributeSelection, ,
    projectionType, ConstructionPlugin_Point::PROJECTION_TYPE(),
    ModelAPI_AttributeString, ,
    faceForPointProjection, ConstructionPlugin_Point::FACE_FOR_POINT_PROJECTION(),
    ModelAPI_AttributeSelection, ,
    edgeForPointProjection, ConstructionPlugin_Point::EDGE_FOR_POINT_PROJECTION(),
    ModelAPI_AttributeSelection, ,
    geometricalPropertyType, ConstructionPlugin_Point::GEOMETRICAL_PROPERTY_TYPE(),
    ModelAPI_AttributeString, ,
    objectForCenterOfGravity, ConstructionPlugin_Point::OBJECT_FOR_CENTER_OF_GRAVITY(),
    ModelAPI_AttributeSelection, ,
    objectForCenterOfCircle, ConstructionPlugin_Point::OBJECT_FOR_CENTER_OF_CIRCLE(),
    ModelAPI_AttributeSelection, )
 
  
  CONSTRUCTIONAPI_EXPORT
  void setByXYZ(const ModelHighAPI_Double & theX,
                const ModelHighAPI_Double & theY,
                const ModelHighAPI_Double & theZ);
 
  CONSTRUCTIONAPI_EXPORT
  void setByOffsetOnEdge(const ModelHighAPI_Selection& theEdge,
                         const ModelHighAPI_Double& theOffset,
                         const bool theUseRatio = false,
                         const bool theReverse = false);
 
  CONSTRUCTIONAPI_EXPORT
  void setByProjectionOnEdge(const ModelHighAPI_Selection& theVertex,
                             const ModelHighAPI_Selection& theEdge);
 
  CONSTRUCTIONAPI_EXPORT
  void setByProjectionOnFace(const ModelHighAPI_Selection& theVertex,
                             const ModelHighAPI_Selection& theFace);
 
  CONSTRUCTIONAPI_EXPORT
  void setByLinesIntersection(const ModelHighAPI_Selection& theEdge1,
                              const ModelHighAPI_Selection& theEdge2);
 
  CONSTRUCTIONAPI_EXPORT
  void setByLineAndPlaneIntersection(const ModelHighAPI_Selection& theEdge,
                                     const ModelHighAPI_Selection& theFace);
 
  CONSTRUCTIONAPI_EXPORT
  void setByPlanesIntersection(const ModelHighAPI_Selection& theFace1,
                               const ModelHighAPI_Selection& theFace2,
                               const ModelHighAPI_Selection& theFace3);
 
  CONSTRUCTIONAPI_EXPORT
  void setByCenterOfGravity(const ModelHighAPI_Selection& theObject);
 
  CONSTRUCTIONAPI_EXPORT
    void setByCenterOfCircle(const ModelHighAPI_Selection& theObject);
 
  CONSTRUCTIONAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<ConstructionAPI_Point> PointPtr;
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                  const ModelHighAPI_Double & theX,
                  const ModelHighAPI_Double & theY,
                  const ModelHighAPI_Double & theZ);
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                  const ModelHighAPI_Selection& theEdge,
                  const ModelHighAPI_Double& theOffset,
                  const bool theUseRatio = false,
                  const bool theReverse = false);
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                  const ModelHighAPI_Selection& theObject1,
                  const ModelHighAPI_Selection& theObject2);
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                  const ModelHighAPI_Selection& theObject1,
                  const ModelHighAPI_Selection& theObject2,
                  const ModelHighAPI_Double& theDistanceValue,
                  const bool theReverse = false);
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                  const ModelHighAPI_Selection& theObject1,
                  const ModelHighAPI_Selection& theObject2,
                  const ModelHighAPI_Selection& theObject3);
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                  const ModelHighAPI_Selection& theObject,
                  const bool theIsCircularEdge = false);
 
CONSTRUCTIONAPI_EXPORT
PointPtr addPointXYZ(const std::shared_ptr<ModelAPI_Document> & thePart,
                     const ModelHighAPI_Selection& theObject);
 
#endif /* SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_POINT_H_ */