Salome HOME
Issue #1834: Fix length of lines
[modules/shaper.git] / src / ConstructionAPI / ConstructionAPI_Point.h
index d2af332986b9a2c43d25bee8ccd1fd9e702a7aef..aa454fcfba1e6c6b1d64bcd14c8eb8f2d27e941d 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-2016 CEA/DEN, EDF R&D
+
 // Name   : ConstructionAPI_Point.h
 // Purpose: 
 //
 #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 without values
+  /// Constructor without values.
   CONSTRUCTIONAPI_EXPORT
-  explicit ConstructionAPI_Point(const std::shared_ptr<ModelAPI_Feature> & theFeature);
-  /// Constructor with values
+  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);
-  /// Destructor
+  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();
 
   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 */
-  )
+              z, ConstructionPlugin_Point::Z(), ModelAPI_AttributeDouble, /** Z attribute */)
+
 
-  /// Set point values
+  /// Set point values.
   CONSTRUCTIONAPI_EXPORT
-  void setPoint(const ModelHighAPI_Double & theX,
+  void setByXYZ(const ModelHighAPI_Double & theX,
                 const ModelHighAPI_Double & theY,
                 const ModelHighAPI_Double & theZ);
+
+  /*/// 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);
+
+  /// Set lines for intersections.
+  CONSTRUCTIONAPI_EXPORT
+  void setByLinesIntersection(const ModelHighAPI_Selection& theEdge1,
+                              const ModelHighAPI_Selection& theEdge2);
+
+  /// 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
- */
+/// \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_ */