X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2FPrimitivesAPI%2FPrimitivesAPI_Cylinder.h;h=c6bcd1b38871ea783f3805844c6b8c26b03c267d;hb=5a5362530345c00af26fc8226f3066f749dde392;hp=3d473798b610d11ee24b26d74b201901348a19f8;hpb=45ea4b0ea4a0d15133b47d8e2bc55c8a24ed402e;p=modules%2Fshaper.git diff --git a/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h b/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h index 3d473798b..c6bcd1b38 100644 --- a/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h +++ b/src/PrimitivesAPI/PrimitivesAPI_Cylinder.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-201x CEA/DEN, EDF R&D --> - -// File: PrimitivesAPI_Cylinder.h -// Created: 12 Jan 2017 -// Author: Clarisse Genrault +// Copyright (C) 2014-2022 CEA/DEN, EDF R&D +// +// 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 PRIMITIVESAPI_CYLINDER_H_ #define PRIMITIVESAPI_CYLINDER_H_ @@ -17,9 +30,9 @@ class ModelHighAPI_Double; class ModelHighAPI_Selection; -/// \class PrimitivesAPI_Box +/// \class PrimitivesAPI_Cylinder /// \ingroup CPPHighAPI -/// \brief Interface for primitive Box feature. +/// \brief Interface for primitive Cylinder feature. class PrimitivesAPI_Cylinder: public ModelHighAPI_Interface { public: @@ -27,13 +40,6 @@ public: PRIMITIVESAPI_EXPORT explicit PrimitivesAPI_Cylinder(const std::shared_ptr& theFeature); - /// Constructor with values. - /*PRIMITIVESAPI_EXPORT - explicit PrimitivesAPI_Cylinder(const std::shared_ptr& 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& theFeature, @@ -59,15 +65,15 @@ public: creationMethod, PrimitivesPlugin_Cylinder::CREATION_METHOD(), ModelAPI_AttributeString, /** Creation method */, basePoint, PrimitivesPlugin_Cylinder::BASE_POINT_ID(), - ModelAPI_AttributeSelection, /** Dimension in X */, + ModelAPI_AttributeSelection, /** Base point */, axis, PrimitivesPlugin_Cylinder::AXIS_ID(), - ModelAPI_AttributeSelection, /** Dimension in Y */, + ModelAPI_AttributeSelection, /** Axis */, radius, PrimitivesPlugin_Cylinder::RADIUS_ID(), - ModelAPI_AttributeDouble, /** Dimension in Z */, + ModelAPI_AttributeDouble, /** Radius */, height, PrimitivesPlugin_Cylinder::HEIGHT_ID(), - ModelAPI_AttributeDouble, /** First point */, + ModelAPI_AttributeDouble, /** Height */, angle, PrimitivesPlugin_Cylinder::ANGLE_ID(), - ModelAPI_AttributeDouble, /** Second point */) + ModelAPI_AttributeDouble, /** Angle */) /// Set dimensions PRIMITIVESAPI_EXPORT @@ -79,11 +85,11 @@ public: virtual void dump(ModelHighAPI_Dumper& theDumper) const; }; -/// Pointer on primitive Box object +/// Pointer on primitive Cylinder object typedef std::shared_ptr CylinderPtr; /// \ingroup CPPHighAPI -/// \brief Create primitive Box feature. +/// \brief Create primitive Cylinder feature. PRIMITIVESAPI_EXPORT CylinderPtr addCylinder(const std::shared_ptr& thePart, const ModelHighAPI_Selection& theBasePoint, @@ -92,7 +98,7 @@ CylinderPtr addCylinder(const std::shared_ptr& thePart, const ModelHighAPI_Double& theHeight); /// \ingroup CPPHighAPI -/// \brief Create primitive Box feature. +/// \brief Create primitive Cylinder feature. PRIMITIVESAPI_EXPORT CylinderPtr addCylinder(const std::shared_ptr& thePart, const ModelHighAPI_Selection& theBasePoint, @@ -102,14 +108,14 @@ CylinderPtr addCylinder(const std::shared_ptr& thePart, const ModelHighAPI_Double& theAngle); /// \ingroup CPPHighAPI -/// \brief Create primitive Box feature. +/// \brief Create primitive Cylinder feature. PRIMITIVESAPI_EXPORT CylinderPtr addCylinder(const std::shared_ptr& thePart, const ModelHighAPI_Double& theRadius, const ModelHighAPI_Double& theHeight); /// \ingroup CPPHighAPI -/// \brief Create primitive Box feature. +/// \brief Create primitive Cylinder feature. PRIMITIVESAPI_EXPORT CylinderPtr addCylinder(const std::shared_ptr& thePart, const ModelHighAPI_Double& theRadius,