src/HYDROPy/CAS/gp_XYZ.sip

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 %ExportedHeaderCode
  20 #include <gp_XYZ.hxx>
  21 %End
  22
  23 class gp_XYZ
  24 {
  25 %TypeHeaderCode
  26 #include <gp_XYZ.hxx>
  27 %End
  28
  29 public:
  30
  31   //! Creates an XYZ object with zero co-ordinates (0,0,0) <br>
  32   gp_XYZ();
  33
  34   //! creates an XYZ with given coordinates <br>
  35   gp_XYZ(const double X,const double Y,const double Z);
  36
  37   //! For this XYZ object, assigns <br>
  38   //!   the values X, Y and Z to its three coordinates <br>
  39   void SetCoord(const double X,const double Y,const double Z) ;
  40
  41   //!  modifies the coordinate of range Index <br>
  42   //!  Index = 1 => X is modified <br>
  43   //!  Index = 2 => Y is modified <br>
  44   //!  Index = 3 => Z is modified <br>
  45   //!  Raises OutOfRange if Index != {1, 2, 3}. <br>
  46   void SetCoord(const int Index,const double Xi) ;
  47   //! Assigns the given value to the X coordinate <br>
  48   void SetX(const double X) ;
  49   //! Assigns the given value to the Y coordinate <br>
  50   void SetY(const double Y) ;
  51   //! Assigns the given value to the Z coordinate <br>
  52   void SetZ(const double Z) ;
  53
  54   //!  returns the coordinate of range Index : <br>
  55   //!  Index = 1 => X is returned <br>
  56   //!  Index = 2 => Y is returned <br>
  57   //!  Index = 3 => Z is returned <br>
  58   //! <br>
  59   //! Raises OutOfRange if Index != {1, 2, 3}. <br>
  60   double Coord(const int Index) const;
  61
  62   void Coord(double& X,double& Y,double& Z) const;
  63   //! Returns the X coordinate <br>
  64   double X() const;
  65   //! Returns the Y coordinate <br>
  66   double Y() const;
  67   //! Returns the Z coordinate <br>
  68   double Z() const;
  69
  70 };
  71