src/HYDROPy/CAS/gp_XYZ.sip

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