Salome HOME
Merge branch 'master' into occ/bsplines
[modules/shaper.git] / src / GeomAPI / GeomAPI_Ax3.h
index 613513a46d7db7fdcf19b7e366d1e4cf2af38c35..68115e4281ca584ceed2cc60f3c89becd5521f54 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAPI_Ax3.hxx
-// Created:     16 February 2015
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2019  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 GEOMAPI_AX3_H_
 #define GEOMAPI_AX3_H_
@@ -20,64 +33,67 @@ class GeomAPI_Ax3 : public GeomAPI_Interface
 {
 public:
   /// Default constructor
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   GeomAPI_Ax3();
 
-  /// Ñonstructor
+  /// Constructor
   /// \param theOrigin point of origin
   /// \param theDirX direction of X axis
   /// \param theNorm direction of normal vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   GeomAPI_Ax3(std::shared_ptr<GeomAPI_Pnt> theOrigin,
               std::shared_ptr<GeomAPI_Dir> theDirX,
               std::shared_ptr<GeomAPI_Dir> theNorm);
 
   /// Sets origin point
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin);
 
   /// Returns the plane origin point
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Pnt> origin() const;
 
   /// Sets X direction vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setDirX(const std::shared_ptr<GeomAPI_Dir>& theDirX);
 
   /// Returns X direction vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Dir> dirX() const;
 
   /// Sets Y direction vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setDirY(const std::shared_ptr<GeomAPI_Dir>& theDirY);
 
   /// Returns Y direction vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Dir> dirY() const;
 
   /// Sets Z direction vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setNormal(const std::shared_ptr<GeomAPI_Dir>& theNorm);
 
   /// Returns Z direction vector
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Dir> normal() const;
 
   /// Converts 2d coordinates from the plane to 3d space point
   /// \param theX X coordinate
   /// \param theY Y coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Pnt> to3D(double theX, double theY) const;
 
   /// Converts 3d  to 2d coordinates of the plane
   /// \param theX X coordinate
   /// \param theY Y coordinate
   /// \param theZ Z coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Pnt2d> to2D(double theX, double theY, double theZ) const;
 
 };
 
 
+//! Pointer on the object
+typedef std::shared_ptr<GeomAPI_Ax3> GeomAx3Ptr;
+
 #endif
\ No newline at end of file