Salome HOME
Fixed naming; Fixed UnitTestBox.py
[modules/shaper.git] / src / ConstructionAPI / ConstructionAPI_Point.h
index 3e67ce80ee76ba397b534ee1424480c2692eead0..ab9f83837c72f6469c0604e1c293f06ffe547754 100644 (file)
@@ -20,22 +20,22 @@ class ModelHighAPI_Double;
 
 /// \class ConstructionAPI_Point
 /// \ingroup CPPHighAPI
-/// \brief Interface for Point feature
+/// \brief Interface for Point feature.
 class ConstructionAPI_Point: public ModelHighAPI_Interface
 {
 public:
-  /// Constructor without values
+  /// Constructor without values.
   CONSTRUCTIONAPI_EXPORT
   explicit ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
-  /// Constructor with values
+  /// 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
+  /// Constructor with values.
   CONSTRUCTIONAPI_EXPORT
   ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                         const ModelHighAPI_Selection& theEdge,
@@ -43,36 +43,49 @@ public:
                         const bool theDistancePercent = false,
                         const bool theReverse = false);
 
-  /// Destructor
+  /// 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();
 
-  INTERFACE_8(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 */
+  INTERFACE_10(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 */
   )
 
-  /// Set point values
+  /// Set point values.
   CONSTRUCTIONAPI_EXPORT
   void setByXYZ(const ModelHighAPI_Double & theX,
                 const ModelHighAPI_Double & theY,
                 const ModelHighAPI_Double & theZ);
 
-  /// Set edge and distance on it for point
+  /// 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& thePlane);
 };
 
-/// Pointer on Point object
+/// Pointer on Point object.
 typedef std::shared_ptr<ConstructionAPI_Point> PointPtr;
 
 /// \ingroup CPPHighAPI
@@ -92,4 +105,11 @@ PointPtr addPoint(const std::shared_ptr<ModelAPI_Document> & thePart,
                   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_ */