Extension of Parameters interface: to set/get double values of results

[modules/shaper.git] / src / PrimitivesAPI / PrimitivesAPI_Cylinder.h

diff --git a/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h b/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h
index 3e16d41c8b812ae3fc0ff8b4905ce119ed9020b0..3d473798b610d11ee24b26d74b201901348a19f8 100644 (file)
--- a/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h
+++ b/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h
@@ -1,8 +1,8 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+// Copyright (C) 2014-201x CEA/DEN, EDF R&D -->
 
 // File:        PrimitivesAPI_Cylinder.h
 // Created:     12 Jan 2017
-// Author:      Clarisse Genrault (CEA)
+// Author:      Clarisse Genrault
 
 #ifndef PRIMITIVESAPI_CYLINDER_H_
 #define PRIMITIVESAPI_CYLINDER_H_
@@ -17,9 +17,9 @@
 class ModelHighAPI_Double;
 class ModelHighAPI_Selection;
 
-/// \class PrimitivesAPI_Cylinder
+/// \class PrimitivesAPI_Box
 /// \ingroup CPPHighAPI
-/// \brief Interface for primitive Cylinder feature.
+/// \brief Interface for primitive Box feature.
 class PrimitivesAPI_Cylinder: public ModelHighAPI_Interface
 {
 public:
@@ -27,6 +27,13 @@ public:
   PRIMITIVESAPI_EXPORT
   explicit PrimitivesAPI_Cylinder(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
+  /// Constructor with values.
+  /*PRIMITIVESAPI_EXPORT
+  explicit PrimitivesAPI_Cylinder(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                             const ModelHighAPI_Double& theDx,
+                             const ModelHighAPI_Double& theDy,
+                             const ModelHighAPI_Double& theDz);*/
+
   /// Constructor with values.
   PRIMITIVESAPI_EXPORT
   explicit PrimitivesAPI_Cylinder(const std::shared_ptr<ModelAPI_Feature>& theFeature,
@@ -34,6 +41,8 @@ public:
                                   const ModelHighAPI_Selection& theAxis,
                                   const ModelHighAPI_Double& theRadius,
                                   const ModelHighAPI_Double& theHeight);
+
+  /// Constructor with values.
   PRIMITIVESAPI_EXPORT
   explicit PrimitivesAPI_Cylinder(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                                   const ModelHighAPI_Selection& theBasePoint,
@@ -42,44 +51,29 @@ public:
                                   const ModelHighAPI_Double& theHeight,
                                   const ModelHighAPI_Double& theAngle);
 
-  /// Constructor with values.
-  /*PRIMITIVESAPI_EXPORT
-  explicit PrimitivesAPI_Cylinder(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                  const ModelHighAPI_Selection& theFirstPoint,
-                                  const ModelHighAPI_Selection& theSecondPoint);*/
-
   /// Destructor.
   PRIMITIVESAPI_EXPORT
   virtual ~PrimitivesAPI_Cylinder();
 
   INTERFACE_6(PrimitivesPlugin_Cylinder::ID(),
-              creationMethod, PrimitivesPlugin_Cylinder::CREATION_METHOD(),
-              ModelAPI_AttributeString, /** Creation method */,
-              basePoint, PrimitivesPlugin_Cylinder::BASE_POINT_ID(),
-              ModelAPI_AttributeSelection, /** Base point */,
-              axis, PrimitivesPlugin_Cylinder::AXIS_ID(),
-              ModelAPI_AttributeSelection, /** Axis */,
-              radius, PrimitivesPlugin_Cylinder::RADIUS_ID(),
-              ModelAPI_AttributeDouble, /** Radius */,
-              height, PrimitivesPlugin_Cylinder::HEIGHT_ID(),
-              ModelAPI_AttributeDouble, /** Height */,
-              angle, PrimitivesPlugin_Cylinder::ANGLE_ID(),
-              ModelAPI_AttributeDouble, /** Angle */)
-  
-  /// Set base point and axis
-  PRIMITIVESAPI_EXPORT
-  void setObjects(const ModelHighAPI_Selection& theBasePoint,
-                  const ModelHighAPI_Selection& theAxis);
-
-  /// Set radius and height
+             creationMethod, PrimitivesPlugin_Cylinder::CREATION_METHOD(),
+             ModelAPI_AttributeString, /** Creation method */,
+             basePoint, PrimitivesPlugin_Cylinder::BASE_POINT_ID(),
+             ModelAPI_AttributeSelection, /** Dimension in X */,
+             axis, PrimitivesPlugin_Cylinder::AXIS_ID(),
+             ModelAPI_AttributeSelection, /** Dimension in Y */,
+             radius, PrimitivesPlugin_Cylinder::RADIUS_ID(),
+             ModelAPI_AttributeDouble, /** Dimension in Z */,
+             height, PrimitivesPlugin_Cylinder::HEIGHT_ID(),
+             ModelAPI_AttributeDouble, /** First point */,
+             angle, PrimitivesPlugin_Cylinder::ANGLE_ID(),
+             ModelAPI_AttributeDouble, /** Second point */)
+
+  /// Set dimensions
   PRIMITIVESAPI_EXPORT
   void setSizes(const ModelHighAPI_Double& theRadius,
                 const ModelHighAPI_Double& theHeight);
 
-  /// Set angle
-  PRIMITIVESAPI_EXPORT
-  void setAngle(const ModelHighAPI_Double& theAngle);
-
   /// Dump wrapped feature
   PRIMITIVESAPI_EXPORT
   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
@@ -89,36 +83,37 @@ public:
 typedef std::shared_ptr<PrimitivesAPI_Cylinder> CylinderPtr;
 
 /// \ingroup CPPHighAPI
-/// \brief Create primitive Cylinder feature.
+/// \brief Create primitive Box feature.
 PRIMITIVESAPI_EXPORT
 CylinderPtr addCylinder(const std::shared_ptr<ModelAPI_Document>& thePart,
                         const ModelHighAPI_Selection& theBasePoint,
                         const ModelHighAPI_Selection& theAxis,
                         const ModelHighAPI_Double& theRadius,
-                        const ModelHighAPI_Double& theHeight,
-                        const ModelHighAPI_Double& theAngle);
+                        const ModelHighAPI_Double& theHeight);
 
 /// \ingroup CPPHighAPI
-/// \brief Create primitive Cylinder feature.
+/// \brief Create primitive Box feature.
 PRIMITIVESAPI_EXPORT
 CylinderPtr addCylinder(const std::shared_ptr<ModelAPI_Document>& thePart,
                         const ModelHighAPI_Selection& theBasePoint,
                         const ModelHighAPI_Selection& theAxis,
                         const ModelHighAPI_Double& theRadius,
-                        const ModelHighAPI_Double& theHeight);
+                        const ModelHighAPI_Double& theHeight,
+                        const ModelHighAPI_Double& theAngle);
+
 /// \ingroup CPPHighAPI
-/// \brief Create primitive Cylinder feature.
+/// \brief Create primitive Box feature.
 PRIMITIVESAPI_EXPORT
 CylinderPtr addCylinder(const std::shared_ptr<ModelAPI_Document>& thePart,
                         const ModelHighAPI_Double& theRadius,
-                        const ModelHighAPI_Double& theHeight,
-                        const ModelHighAPI_Double& theAngle);
+                        const ModelHighAPI_Double& theHeight);
 
 /// \ingroup CPPHighAPI
-/// \brief Create primitive Cylinder feature.
+/// \brief Create primitive Box feature.
 PRIMITIVESAPI_EXPORT
 CylinderPtr addCylinder(const std::shared_ptr<ModelAPI_Document>& thePart,
                         const ModelHighAPI_Double& theRadius,
-                        const ModelHighAPI_Double& theHeight);
+                        const ModelHighAPI_Double& theHeight,
+                        const ModelHighAPI_Double& theAngle);
 
 #endif // PRIMITIVESAPI_CYLINDER_H_
\ No newline at end of file