Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRep / BRep_PointRepresentation.cdl
CommitLineData
7fd59977 1-- File: BRep_PointRepresentation.cdl
2-- Created: Tue Aug 10 14:01:46 1993
3-- Author: Remi LEQUETTE
4-- <rle@phylox>
5---Copyright: Matra Datavision 1993
6
7
8
9
10deferred class PointRepresentation from BRep inherits TShared from MMgt
11
12 ---Purpose: Root class for the points representations.
13 -- Contains a location and a parameter.
14
15uses
16 Curve from Geom2d,
17 Curve from Geom,
18 Surface from Geom,
19 Location from TopLoc
20
21raises
22 DomainError from Standard
23
24is
25
26 Initialize(P : Real;
27 L : Location from TopLoc);
28
29 -------------------------------------------------
30 -- What kind of representation
31 -------------------------------------------------
32
33 IsPointOnCurve(me) returns Boolean
34 ---Purpose: A point on a 3d curve.
35 is virtual;
36
37 IsPointOnCurveOnSurface(me) returns Boolean
38 ---Purpose: A point on a 2d curve on a surface.
39 is virtual;
40
41 IsPointOnSurface(me) returns Boolean
42 ---Purpose: A point on a surface.
43 is virtual;
44
45 IsPointOnCurve(me; C : Curve from Geom;
46 L : Location from TopLoc) returns Boolean
47 ---Purpose: A point on the curve <C>.
48 is virtual;
49
50 IsPointOnCurveOnSurface(me; PC : Curve from Geom2d;
51 S : Surface from Geom;
52 L : Location from TopLoc) returns Boolean
53 ---Purpose: A point on the 2d curve <PC> on the surface <S>.
54 is virtual;
55
56 IsPointOnSurface(me; S : Surface from Geom;
57 L : Location from TopLoc) returns Boolean
58 ---Purpose: A point on the surface <S>.
59 is virtual;
60
61 -------------------------------------------------
62 -- Location
63 -------------------------------------------------
64
65 Location(me) returns Location from TopLoc
66 ---C++: return const &
67 ---C++: inline
68 is static;
69
70 Location(me : mutable; L : Location from TopLoc)
71 ---C++: inline
72 is static;
73
74 -------------------------------------------------
75 -- Parameters
76 -------------------------------------------------
77
78 Parameter(me) returns Real
79 ---C++: inline
80 is static;
81
82 Parameter(me : mutable; P : Real)
83 ---C++: inline
84 is static;
85
86 Parameter2(me) returns Real
87 raises
88 DomainError from Standard -- if !IsPointOnSurface
89 is virtual;
90
91 Parameter2(me : mutable; P : Real)
92 raises
93 DomainError from Standard -- if !IsPointOnSurface
94 is virtual;
95
96 -------------------------------------------------
97 -- 3d curve
98 -------------------------------------------------
99
100 Curve(me) returns any Curve from Geom
101 ---C++: return const &
102 raises
103 DomainError from Standard -- if !IsPointOnCurve
104 is virtual;
105
106 Curve(me : mutable; C : Curve from Geom)
107 raises
108 DomainError from Standard -- if !IsPointOnCurve
109 is virtual;
110
111
112 -------------------------------------------------
113 -- curve on surface
114 -------------------------------------------------
115
116 PCurve(me) returns any Curve from Geom2d
117 ---C++: return const &
118 raises
119 DomainError from Standard -- if !IsPointOnCurveOnSurface
120 is virtual;
121
122 PCurve(me : mutable; C : Curve from Geom2d)
123 raises
124 DomainError from Standard -- if !IsPointOnCurveOnSurface
125 is virtual;
126
127 -------------------------------------------------
128 -- surface
129 -------------------------------------------------
130
131 Surface(me) returns any Surface from Geom
132 ---C++: return const &
133 raises
134 DomainError from Standard -- if IsPointOnCurve()
135 is virtual;
136
137 Surface(me : mutable; S : Surface from Geom)
138 raises
139 DomainError from Standard -- if IsPointOnCurve()
140 is virtual;
141
142fields
143
144 myLocation : Location from TopLoc;
145 myParameter : Real;
146
147end PointRepresentation;