Salome HOME
Dump Python in the High Level Parameterized Geometry API (issue #1648)
[modules/shaper.git] / src / ConstructionAPI / ConstructionAPI_Point.h
index 56d3a57169cbed9a88eeeba9935c8cd561496f39..6c2b295bb69c0490bd1f178a6f85261773c5d7f0 100644 (file)
 #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
- * \ingroup CPPHighAPI
- * \brief Interface for Point feature
- */
-class ConstructionAPI_Point : public ModelHighAPI_Interface
+
+/// \class ConstructionAPI_Point
+/// \ingroup CPPHighAPI
+/// \brief Interface for Point feature.
+class ConstructionAPI_Point: public ModelHighAPI_Interface
 {
 public:
-  /// Constructor
-  explicit ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature> & theFeature);
-  /// Constructor with values
-  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature> & theFeature,
-                        const ModelHighAPI_Double & theX,
-                        const ModelHighAPI_Double & theY,
-                        const ModelHighAPI_Double & theZ);
-  /// Destructor
+  /// Constructor without values.
+  CONSTRUCTIONAPI_EXPORT
+  explicit ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature);
+
+  /// Constructor with values.
+  CONSTRUCTIONAPI_EXPORT
+  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                        const ModelHighAPI_Double& theX,
+                        const ModelHighAPI_Double& theY,
+                        const ModelHighAPI_Double& theZ);
+
+  /*/// Constructor with values.
+  CONSTRUCTIONAPI_EXPORT
+  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                        const ModelHighAPI_Selection& theEdge,
+                        const ModelHighAPI_Double& theDistanceValue,
+                        const bool theDistancePercent = false,
+                        const bool theReverse = false);
+
+  /// Constructor with values.
+  CONSTRUCTIONAPI_EXPORT
+  ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                        const ModelHighAPI_Selection& theObject1,
+                        const ModelHighAPI_Selection& theObject2);*/
+
+  /// Destructor.
+  CONSTRUCTIONAPI_EXPORT
   virtual ~ConstructionAPI_Point();
 
-  /// Set point values
-  void setPoint(const ModelHighAPI_Double & theX,
+  INTERFACE_3(ConstructionPlugin_Point::ID(),
+              x, ConstructionPlugin_Point::X(), ModelAPI_AttributeDouble, /** X attribute */,
+              y, ConstructionPlugin_Point::Y(), ModelAPI_AttributeDouble, /** Y attribute */,
+              z, ConstructionPlugin_Point::Z(), ModelAPI_AttributeDouble, /** Z attribute */)
+
+  //INTERFACE_14(ConstructionPlugin_Point::ID(),
+  //             creationMethod, ConstructionPlugin_Point::CREATION_METHOD(), ModelAPI_AttributeString, /** Creation method */,
+  //             x, ConstructionPlugin_Point::X(), ModelAPI_AttributeDouble, /** X attribute */,
+  //             y, ConstructionPlugin_Point::Y(), ModelAPI_AttributeDouble, /** Y attribute */,
+  //             z, ConstructionPlugin_Point::Z(), ModelAPI_AttributeDouble, /** Z attribute */,
+  //             edge, ConstructionPlugin_Point::EDGE(), ModelAPI_AttributeSelection, /** Edge attribute */,
+  //             distanceValue, ConstructionPlugin_Point::DISTANCE_VALUE(), ModelAPI_AttributeDouble, /** Distance value attribute */,
+  //             distancePercent, ConstructionPlugin_Point::DISTANCE_PERCENT(), ModelAPI_AttributeBoolean, /** Distance percent attribute */,
+  //             reverse, ConstructionPlugin_Point::REVERSE(), ModelAPI_AttributeBoolean, /** Reverse attribute */,
+  //             point, ConstructionPlugin_Point::POINT(), ModelAPI_AttributeSelection, /** Point attribute */,
+  //             plane, ConstructionPlugin_Point::PLANE(), ModelAPI_AttributeSelection, /** Plane attribute */,
+  //             firstLine, ConstructionPlugin_Point::FIRST_LINE(), ModelAPI_AttributeSelection, /** First line attribute */,
+  //             secondLine, ConstructionPlugin_Point::SECOND_LINE(), ModelAPI_AttributeSelection, /** Second line attribute */,
+  //             intersectionLine, ConstructionPlugin_Point::INTERSECTION_LINE(), ModelAPI_AttributeSelection, /** Intersection line attribute */,
+  //             intersectionPlane, ConstructionPlugin_Point::INTERSECTION_PLANE(), ModelAPI_AttributeSelection, /** Intersection plane attribute */
+  //)
+
+  /// Set point values.
+  CONSTRUCTIONAPI_EXPORT
+  void setByXYZ(const ModelHighAPI_Double & theX,
                 const ModelHighAPI_Double & theY,
                 const ModelHighAPI_Double & theZ);
 
-  /// X coordinate for the point
-  std::shared_ptr<ModelAPI_AttributeDouble> x() const;
-  /// Y coordinate for the point
-  std::shared_ptr<ModelAPI_AttributeDouble> y() const;
-  /// Z coordinate for the point
-  std::shared_ptr<ModelAPI_AttributeDouble> z() const;
+  /*/// Set edge and distance on it for point.
+  CONSTRUCTIONAPI_EXPORT
+  void setByDistanceOnEdge(const ModelHighAPI_Selection& theEdge,
+                           const ModelHighAPI_Double& theDistanceValue,
+                           const bool theDistancePercent = false,
+                           const bool theReverse = false);
+
+  /// Set point and plane for projection.
+  CONSTRUCTIONAPI_EXPORT
+  void setByProjection(const ModelHighAPI_Selection& theVertex,
+                       const ModelHighAPI_Selection& theFace);
 
-protected:
-  std::shared_ptr<ModelAPI_AttributeDouble> myX, myY, myZ;
+  /// Set lines for intersections.
+  CONSTRUCTIONAPI_EXPORT
+  void setByLinesIntersection(const ModelHighAPI_Selection& theEdge1,
+                              const ModelHighAPI_Selection& theEdge2);
 
-  bool initialize();
+  /// Set line and plane for intersections.
+  CONSTRUCTIONAPI_EXPORT
+  void setByLineAndPlaneIntersection(const ModelHighAPI_Selection& theEdge,
+                                     const ModelHighAPI_Selection& theFace);*/
+
+  /// Dump wrapped feature
+  CONSTRUCTIONAPI_EXPORT
+  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 };
 
-//! Pointer on point object
+/// Pointer on Point object.
 typedef std::shared_ptr<ConstructionAPI_Point> PointPtr;
 
-/**\ingroup CPPHighAPI
- * \brief Create Point feature
- */
-PointPtr addPoint(std::shared_ptr<ModelAPI_Document> thePart,
+/// \ingroup CPPHighAPI
+/// \brief Create Point feature
+CONSTRUCTIONAPI_EXPORT
+PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                   const ModelHighAPI_Double & theX,
                   const ModelHighAPI_Double & theY,
                   const ModelHighAPI_Double & theZ);
 
-//--------------------------------------------------------------------------------------
-//--------------------------------------------------------------------------------------
+/*/// \ingroup CPPHighAPI
+/// \brief Create Point feature
+CONSTRUCTIONAPI_EXPORT
+PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
+                  const ModelHighAPI_Selection& theEdge,
+                  const ModelHighAPI_Double& theDistanceValue,
+                  const bool theDistancePercent = false,
+                  const bool theReverse = false);
+
+/// \ingroup CPPHighAPI
+/// \brief Create Point feature
+CONSTRUCTIONAPI_EXPORT
+PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
+                  const ModelHighAPI_Selection& theObject1,
+                  const ModelHighAPI_Selection& theObject2);*/
+
 #endif /* SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_POINT_H_ */