0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / BRep / BRep_PointRepresentation.hxx
1 // Created on: 1993-08-10
2 // Created by: Remi LEQUETTE
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 _BRep_PointRepresentation_HeaderFile
18 #define _BRep_PointRepresentation_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TopLoc_Location.hxx>
24 #include <Standard_Real.hxx>
25 #include <Standard_Transient.hxx>
26 #include <Standard_Boolean.hxx>
27 class Standard_DomainError;
28 class TopLoc_Location;
29 class Geom_Curve;
30 class Geom2d_Curve;
31 class Geom_Surface;
32
33
34 class BRep_PointRepresentation;
35 DEFINE_STANDARD_HANDLE(BRep_PointRepresentation, Standard_Transient)
36
37 //! Root  class     for   the points  representations.
38 //! Contains a location and a parameter.
39 class BRep_PointRepresentation : public Standard_Transient
40 {
41
42 public:
43
44   
45   //! A point on a 3d curve.
46   Standard_EXPORT virtual Standard_Boolean IsPointOnCurve() const;
47   
48   //! A point on a 2d curve on a surface.
49   Standard_EXPORT virtual Standard_Boolean IsPointOnCurveOnSurface() const;
50   
51   //! A point on a surface.
52   Standard_EXPORT virtual Standard_Boolean IsPointOnSurface() const;
53   
54   //! A point on the curve <C>.
55   Standard_EXPORT virtual Standard_Boolean IsPointOnCurve (const Handle(Geom_Curve)& C, const TopLoc_Location& L) const;
56   
57   //! A point on the 2d curve <PC> on the surface <S>.
58   Standard_EXPORT virtual Standard_Boolean IsPointOnCurveOnSurface (const Handle(Geom2d_Curve)& PC, const Handle(Geom_Surface)& S, const TopLoc_Location& L) const;
59   
60   //! A point on the surface <S>.
61   Standard_EXPORT virtual Standard_Boolean IsPointOnSurface (const Handle(Geom_Surface)& S, const TopLoc_Location& L) const;
62   
63     const TopLoc_Location& Location() const;
64   
65     void Location (const TopLoc_Location& L);
66   
67     Standard_Real Parameter() const;
68   
69     void Parameter (const Standard_Real P);
70   
71   Standard_EXPORT virtual Standard_Real Parameter2() const;
72   
73   Standard_EXPORT virtual void Parameter2 (const Standard_Real P);
74   
75   Standard_EXPORT virtual const Handle(Geom_Curve)& Curve() const;
76   
77   Standard_EXPORT virtual void Curve (const Handle(Geom_Curve)& C);
78   
79   Standard_EXPORT virtual const Handle(Geom2d_Curve)& PCurve() const;
80   
81   Standard_EXPORT virtual void PCurve (const Handle(Geom2d_Curve)& C);
82   
83   Standard_EXPORT virtual const Handle(Geom_Surface)& Surface() const;
84   
85   Standard_EXPORT virtual void Surface (const Handle(Geom_Surface)& S);
86
87   //! Dumps the content of me into the stream
88   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
89
90
91
92
93   DEFINE_STANDARD_RTTIEXT(BRep_PointRepresentation,Standard_Transient)
94
95 protected:
96
97   
98   Standard_EXPORT BRep_PointRepresentation(const Standard_Real P, const TopLoc_Location& L);
99
100
101
102 private:
103
104
105   TopLoc_Location myLocation;
106   Standard_Real myParameter;
107
108
109 };
110
111
112 #include <BRep_PointRepresentation.lxx>
113
114
115
116
117
118 #endif // _BRep_PointRepresentation_HeaderFile