include/opencascade/Geom2d_Point.hxx

0001 // Created on: 1993-03-24
0002 // Created by: JCV
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Geom2d_Point_HeaderFile
0018 #define _Geom2d_Point_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Geom2d_Geometry.hxx>
0024 #include <Standard_Real.hxx>
0025 class gp_Pnt2d;
0026
0027 //! The abstract class Point describes the common
0028 //! behavior of geometric points in 2D space.
0029 //! The Geom2d package also provides the concrete
0030 //! class Geom2d_CartesianPoint.
0031 class Geom2d_Point : public Geom2d_Geometry
0032 {
0033
0034 public:
0035   //! returns the Coordinates of <me>.
0036   Standard_EXPORT virtual void Coord(double& X, double& Y) const = 0;
0037
0038   //! returns a non persistent copy of <me>
0039   Standard_EXPORT virtual gp_Pnt2d Pnt2d() const = 0;
0040
0041   //! returns the X coordinate of <me>.
0042   Standard_EXPORT virtual double X() const = 0;
0043
0044   //! returns the Y coordinate of <me>.
0045   Standard_EXPORT virtual double Y() const = 0;
0046
0047   //! computes the distance between <me> and <Other>.
0048   Standard_EXPORT double Distance(const occ::handle<Geom2d_Point>& Other) const;
0049
0050   //! computes the square distance between <me> and <Other>.
0051   Standard_EXPORT double SquareDistance(const occ::handle<Geom2d_Point>& Other) const;
0052
0053   //! Dumps the content of me into the stream
0054   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0055
0056   DEFINE_STANDARD_RTTIEXT(Geom2d_Point, Geom2d_Geometry)
0057 };
0058
0059 #endif // _Geom2d_Point_HeaderFile