0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / Geom2d / Geom2d_CartesianPoint.hxx
1 // Created on: 1993-03-24
2 // Created by: Philippe DAUTRY
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 _Geom2d_CartesianPoint_HeaderFile
18 #define _Geom2d_CartesianPoint_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <gp_Pnt2d.hxx>
24 #include <Geom2d_Point.hxx>
25 #include <Standard_Real.hxx>
26 class gp_Pnt2d;
27 class gp_Trsf2d;
28 class Geom2d_Geometry;
29
30
31 class Geom2d_CartesianPoint;
32 DEFINE_STANDARD_HANDLE(Geom2d_CartesianPoint, Geom2d_Point)
33
34 //! Describes a point in 2D space. A
35 //! Geom2d_CartesianPoint is defined by a gp_Pnt2d
36 //! point, with its two Cartesian coordinates X and Y.
37 class Geom2d_CartesianPoint : public Geom2d_Point
38 {
39
40 public:
41
42   
43   //! Returns a persistent copy of P.
44   Standard_EXPORT Geom2d_CartesianPoint(const gp_Pnt2d& P);
45   
46   Standard_EXPORT Geom2d_CartesianPoint(const Standard_Real X, const Standard_Real Y);
47   
48   //! Set <me> to X, Y coordinates.
49   Standard_EXPORT void SetCoord (const Standard_Real X, const Standard_Real Y);
50   
51   //! Set <me> to P.X(), P.Y() coordinates.
52   Standard_EXPORT void SetPnt2d (const gp_Pnt2d& P);
53   
54   //! Changes the X coordinate of me.
55   Standard_EXPORT void SetX (const Standard_Real X);
56   
57   //! Changes the Y coordinate of me.
58   Standard_EXPORT void SetY (const Standard_Real Y);
59   
60   //! Returns the coordinates of <me>.
61   Standard_EXPORT void Coord (Standard_Real& X, Standard_Real& Y) const Standard_OVERRIDE;
62   
63
64   //! Returns a non persistent cartesian point with
65   //! the same coordinates as <me>.
66   //! -C++: return const&
67   Standard_EXPORT gp_Pnt2d Pnt2d() const Standard_OVERRIDE;
68   
69   //! Returns the X coordinate of <me>.
70   Standard_EXPORT Standard_Real X() const Standard_OVERRIDE;
71   
72   //! Returns the Y coordinate of <me>.
73   Standard_EXPORT Standard_Real Y() const Standard_OVERRIDE;
74   
75   Standard_EXPORT void Transform (const gp_Trsf2d& T) Standard_OVERRIDE;
76   
77   Standard_EXPORT Handle(Geom2d_Geometry) Copy() const Standard_OVERRIDE;
78
79   //! Dumps the content of me into the stream
80   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
81
82
83
84
85   DEFINE_STANDARD_RTTIEXT(Geom2d_CartesianPoint,Geom2d_Point)
86
87 protected:
88
89
90
91
92 private:
93
94
95   gp_Pnt2d gpPnt2d;
96
97
98 };
99
100
101
102
103
104
105
106 #endif // _Geom2d_CartesianPoint_HeaderFile