src/Geom/Geom_CartesianPoint.hxx

   1 // Created on: 1993-03-10
   2 // Created by: JCV
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Geom_CartesianPoint_HeaderFile
  18 #define _Geom_CartesianPoint_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <gp_Pnt.hxx>
  24 #include <Geom_Point.hxx>
  25 #include <Standard_Real.hxx>
  26 class gp_Pnt;
  27 class gp_Trsf;
  28 class Geom_Geometry;
  29
  30
  31 class Geom_CartesianPoint;
  32 DEFINE_STANDARD_HANDLE(Geom_CartesianPoint, Geom_Point)
  33
  34 //! Describes a point in 3D space. A
  35 //! Geom_CartesianPoint is defined by a gp_Pnt point,
  36 //! with its three Cartesian coordinates X, Y and Z.
  37 class Geom_CartesianPoint : public Geom_Point
  38 {
  39
  40 public:
  41
  42
  43   //! Returns a transient copy of P.
  44   Standard_EXPORT Geom_CartesianPoint(const gp_Pnt& P);
  45
  46   //! Constructs a point defined by its three Cartesian coordinates X, Y and Z.
  47   Standard_EXPORT Geom_CartesianPoint(const Standard_Real X, const Standard_Real Y, const Standard_Real Z);
  48
  49   //! Assigns the coordinates X, Y and Z to this point.
  50   Standard_EXPORT void SetCoord (const Standard_Real X, const Standard_Real Y, const Standard_Real Z);
  51
  52   //! Set <me> to P.X(), P.Y(), P.Z() coordinates.
  53   Standard_EXPORT void SetPnt (const gp_Pnt& P);
  54
  55   //! Changes the X coordinate of me.
  56   Standard_EXPORT void SetX (const Standard_Real X);
  57
  58   //! Changes the Y coordinate of me.
  59   Standard_EXPORT void SetY (const Standard_Real Y);
  60
  61   //! Changes the Z coordinate of me.
  62   Standard_EXPORT void SetZ (const Standard_Real Z);
  63
  64   //! Returns the coordinates of <me>.
  65   Standard_EXPORT void Coord (Standard_Real& X, Standard_Real& Y, Standard_Real& Z) const Standard_OVERRIDE;
  66
  67
  68   //! Returns a non transient cartesian point with
  69   //! the same coordinates as <me>.
  70   Standard_EXPORT gp_Pnt Pnt() const Standard_OVERRIDE;
  71
  72   //! Returns the X coordinate of <me>.
  73   Standard_EXPORT Standard_Real X() const Standard_OVERRIDE;
  74
  75   //! Returns the Y coordinate of <me>.
  76   Standard_EXPORT Standard_Real Y() const Standard_OVERRIDE;
  77
  78   //! Returns the Z coordinate of <me>.
  79   Standard_EXPORT Standard_Real Z() const Standard_OVERRIDE;
  80
  81   //! Applies the transformation T to this point.
  82   Standard_EXPORT void Transform (const gp_Trsf& T) Standard_OVERRIDE;
  83
  84   //! Creates a new object which is a copy of this point.
  85   Standard_EXPORT Handle(Geom_Geometry) Copy() const Standard_OVERRIDE;
  86
  87
  88
  89
  90   DEFINE_STANDARD_RTTIEXT(Geom_CartesianPoint,Geom_Point)
  91
  92 protected:
  93
  94
  95
  96
  97 private:
  98
  99
 100   gp_Pnt gpPnt;
 101
 102
 103 };
 104
 105
 106
 107
 108
 109
 110
 111 #endif // _Geom_CartesianPoint_HeaderFile