[occt.git] / src / IntPatch / IntPatch_Point.cdl

-- Created on: 1992-05-06
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.

class Point from IntPatch

	---Purpose: Definition of an intersection point between two surfaces.
	--          Such a point is contains geometrical informations (see
	--          the Value method) and logical informations.

uses
     HVertex    from Adaptor3d,
     HCurve2d   from Adaptor2d,
     PntOn2S    from IntSurf,
     Transition from IntSurf,
     Pnt        from gp
     
raises DomainError from Standard

is


    Create

	---Purpose: Empty constructor.
	---C++: inline
    	returns Point from IntPatch;


    SetValue(me: in out; Pt: Pnt from gp; Tol: Real from Standard;
                         Tangent: Boolean from Standard)

	---Purpose: Sets the values of a point which is on no domain,
	--          when both surfaces are implicit ones.
	--          If Tangent is True, the point is a point of tangency
	--          between the surfaces.

    	is static;


    SetValue(me: in out; Pt: Pnt from gp)
	---C++: inline
    	is static;
	

    SetTolerance(me: in out; Tol: Real from Standard)
	---C++: inline
    	is static;


    SetParameters(me: in out; U1,V1,U2,V2: Real from Standard)
	     
   	---Purpose: Sets the values of the parameters of the point
   	--          on each surface.
	---C++: inline
    	is static;


    SetParameter(me: in out; Para: Real from Standard)
    
	---Purpose: Set the value of the parameter on the intersection line.
	---C++: inline
    	is static;


    SetVertex(me: in out; OnFirst: Boolean from Standard; V: HVertex from Adaptor3d)

	---Purpose: Sets the values of a point which is a vertex on
	--          the initial facet of restriction of one
	--          of the surface.
	--          If OnFirst is True, the point is on the domain of the
	--          first patch, otherwise the point is on the domain of the
	--          second surface.

    	is static;


    SetArc(me: in out; OnFirst: Boolean from Standard;
                       A: HCurve2d from Adaptor2d; Param: Real from Standard;
                       TLine, TArc: Transition from IntSurf)

	---Purpose: Sets the values of a point which is on one of the domain,
	--          when both surfaces are implicit ones.
	--          If OnFirst is True, the point is on the domain of the
	--          first patch, otherwise the point is on the domain of the
	--          second surface.

    	is static;


    SetMultiple(me: in out; IsMult: Boolean from Standard)
    
	---Purpose: Sets (or unsets) the point as a point on several
	--          intersection line.
	---C++: inline
    	is static;


    Value(me)
    
    	---Purpose: Returns the intersection point (geometric information).

    	returns Pnt from gp
	---C++: return const&
	---C++: inline

    	is static;


    ParameterOnLine(me)
    
	---Purpose: This method returns the parameter of the point
	--          on the intersection line.
	--          If the points does not belong to an intersection line,
	--          the value returned does not have any sens.
    
    	returns Real from Standard
	---C++: inline
	
	is static;


    Tolerance(me)
    
	---Purpose: This method returns the fuzziness on the point.
    
    	returns Real from Standard
	---C++: inline
	
	is static;


    IsTangencyPoint(me)

	---Purpose: Returns True if the Point is a tangency point between
	--          the surfaces.
	--          If the Point is on one of the domain (IsOnDomS1 returns
	--          True or IsOnDomS2 returns True), an exception is raised.
    
    	returns Boolean from Standard
	---C++: inline
	
	raises DomainError from Standard
	
	is static;


    ParametersOnS1(me; U1,V1: out Real from Standard)
    
	---Purpose: Returns the parameters on the first surface of the point.

    	raises DomainError from Standard
	---C++: inline

    	is static;


    ParametersOnS2(me; U2,V2: out Real from Standard)
    
	---Purpose: Returns the parameters on the second surface of the point.

    	raises DomainError from Standard
	---C++: inline

    	is static;


    IsMultiple(me)
    
	---Purpose: Returns True if the point belongs to several intersection
	--          lines.

    	returns Boolean from Standard
	---C++: inline
	
	is static;


    IsOnDomS1(me)
    
    	---Purpose: Returns TRUE if the point is on a boundary of the domain
    	--          of the first patch.

    	returns Boolean from Standard
	---C++: inline

        is static;


    IsVertexOnS1(me)

	---Purpose: Returns TRUE if the point is a vertex on the initial
	--          restriction facet of the first surface.

    	returns Boolean from Standard
	---C++: inline
	
	is static;


    VertexOnS1(me)
    
    	---Purpose: Returns the information about the point when it is
    	--          on the domain of the first patch, i-e when the function
    	--          IsVertexOnS1 returns True.
    	--          Otherwise, an exception is raised.
    
    	returns HVertex from Adaptor3d
	---C++: return const&
	---C++: inline
	
    	raises DomainError from Standard

    	is static;


    ArcOnS1(me)
    
	---Purpose: Returns the arc of restriction containing the
	--          vertex.
	--          The exception DomainError is raised if 
	--          IsOnDomS1 returns False.

    	returns HCurve2d from Adaptor2d
	---C++: return const&
	---C++: inline
	
	raises DomainError from Standard
	
	is static;


    TransitionLineArc1(me)
    
	---Purpose: Returns the transition of the point on the
	--          intersection line with the arc on S1.
	--          The exception DomainError is raised if IsOnDomS1
	--          returns False.

    	returns Transition from IntSurf
	---C++: return const&
	---C++: inline
	
	raises DomainError from Standard
	
	is static;


    TransitionOnS1(me)
    
	---Purpose: Returns the transition between the intersection line
	--          returned by the method Line and the arc on S1 returned
	--          by ArcOnS1().
	--          The exception DomainError is raised if 
	--          IsOnDomS1 returns False.

    	returns Transition from IntSurf
	---C++: return const&
	---C++: inline
	
	raises DomainError from Standard
	       
	is static;


    ParameterOnArc1(me)
    
	---Purpose: Returns the parameter of the point on the
	--          arc returned by the method ArcOnS2.
	--          The exception DomainError is raised if 
	--          IsOnDomS1 returns False.

    	returns Real from Standard
	---C++: inline
	
	raises DomainError from Standard
	       
	is static;


    IsOnDomS2(me)
     
    	---Purpose: Returns TRUE if the point is on a boundary of the domain
    	--          of the second patch.

    	returns Boolean from Standard
	---C++: inline

    	is static;


    IsVertexOnS2(me)

	---Purpose: Returns TRUE if the point is a vertex on the initial
	--          restriction facet of the first surface.

    	returns Boolean from Standard
	---C++: inline
	
	is static;


    VertexOnS2(me)
    
    	---Purpose: Returns the information about the point when it is
    	--          on the domain of the second patch, i-e when the function
    	--          IsVertexOnS2 returns True.
    	--          Otherwise, an exception is raised.

    	returns HVertex from Adaptor3d
	---C++: return const&
	---C++: inline

    	raises DomainError from Standard
	
    	is static;


    ArcOnS2(me)
    
	---Purpose: Returns the arc of restriction containing the
	--          vertex.
	--          The exception DomainError is raised if 
	--          IsOnDomS2 returns False.

    	returns HCurve2d from Adaptor2d
	---C++: return const&
	---C++: inline
	
	raises DomainError from Standard
	
	is static;


    TransitionLineArc2(me)
    
	---Purpose: Returns the transition of the point on the
	--          intersection line with the arc on S2.
	--          The exception DomainError is raised if IsOnDomS2
	--          returns False.

    	returns Transition from IntSurf
    	---C++: return const&
	---C++: inline
	
	raises DomainError from Standard
	
	is static;


    TransitionOnS2(me)
    
	---Purpose: Returns the transition between the intersection line
	--          returned by the method Line and the arc on S2 returned
	--          by ArcOnS2.
	--          The exception DomainError is raised if 
	--          IsOnDomS2 returns False.

    	returns Transition from IntSurf
	---C++: return const&
	---C++: inline

	raises DomainError from Standard
	       
	is static;


    ParameterOnArc2(me)
    
	---Purpose: Returns the parameter of the point on the
	--          arc returned by the method ArcOnS2.
	--          The exception DomainError is raised if 
	--          IsOnDomS2 returns False.

    	returns Real from Standard
	---C++: inline
	
	raises DomainError from Standard
	       
	is static;


    PntOn2S(me)
    
    	---Purpose: Returns the PntOn2S 
    	--          (geometric Point and the parameters)
    	--          
        ---C++: inline
        ---C++: return const &

    	returns PntOn2S from IntSurf
        is static;
    
    Parameters(me; U1,V1,U2,V2: out Real from Standard)
	---Purpose: Returns the parameters on the first and on the 
	--          second surface of the point.
    	raises DomainError from Standard
	---C++: inline

    	is static;


    ReverseTransition(me: in out)
    	is static;

    Dump(me) 
    
    	is static;

fields

    pt        : PntOn2S    from IntSurf;
    para      : Real       from Standard;
    tol       : Real       from Standard;
    tgt       : Boolean    from Standard;
    mult      : Boolean    from Standard;

    onS1      : Boolean    from Standard;
    vtxonS1   : Boolean    from Standard;
    vS1       : HVertex    from Adaptor3d;
    arcS1     : HCurve2d   from Adaptor2d;
    traline1  : Transition from IntSurf;
    tra1      : Transition from IntSurf;
    prm1      : Real       from Standard;

    onS2      : Boolean    from Standard;
    vtxonS2   : Boolean    from Standard;
    vS2       : HVertex    from Adaptor3d;
    arcS2     : HCurve2d   from Adaptor2d;
    traline2  : Transition from IntSurf;
    tra2      : Transition from IntSurf;
    prm2      : Real       from Standard;

end Point;
Commit	Line	Data
b311480e	1	-- Created on: 1992-05-06
	2	-- Created by: Jacques GOUSSARD
	3	-- Copyright (c) 1992-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
d5f74e42	8	-- This library is free software; you can redistribute it and/or modify it under
d5f74e42	9	-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1	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.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
7fd59977	16
	17	class Point from IntPatch
	18
	19	---Purpose: Definition of an intersection point between two surfaces.
	20	-- Such a point is contains geometrical informations (see
	21	-- the Value method) and logical informations.
	22
	23	uses
	24	HVertex from Adaptor3d,
	25	HCurve2d from Adaptor2d,
	26	PntOn2S from IntSurf,
7fd59977	27	Transition from IntSurf,
	28	Pnt from gp
	29
	30	raises DomainError from Standard
	31
	32	is
	33
	34
	35	Create
	36
	37	---Purpose: Empty constructor.
	38	---C++: inline
	39	returns Point from IntPatch;
	40
	41
	42	SetValue(me: in out; Pt: Pnt from gp; Tol: Real from Standard;
	43	Tangent: Boolean from Standard)
	44
	45	---Purpose: Sets the values of a point which is on no domain,
	46	-- when both surfaces are implicit ones.
	47	-- If Tangent is True, the point is a point of tangency
	48	-- between the surfaces.
	49
	50	is static;
	51
	52
	53	SetValue(me: in out; Pt: Pnt from gp)
	54	---C++: inline
	55	is static;
	56
	57
	58	SetTolerance(me: in out; Tol: Real from Standard)
	59	---C++: inline
	60	is static;
	61
	62
	63	SetParameters(me: in out; U1,V1,U2,V2: Real from Standard)
	64
	65	---Purpose: Sets the values of the parameters of the point
	66	-- on each surface.
	67	---C++: inline
	68	is static;
	69
	70
	71	SetParameter(me: in out; Para: Real from Standard)
	72
	73	---Purpose: Set the value of the parameter on the intersection line.
	74	---C++: inline
	75	is static;
	76
	77
	78	SetVertex(me: in out; OnFirst: Boolean from Standard; V: HVertex from Adaptor3d)
	79
	80	---Purpose: Sets the values of a point which is a vertex on
	81	-- the initial facet of restriction of one
	82	-- of the surface.
	83	-- If OnFirst is True, the point is on the domain of the
	84	-- first patch, otherwise the point is on the domain of the
	85	-- second surface.
	86
	87	is static;
	88
	89
	90	SetArc(me: in out; OnFirst: Boolean from Standard;
91	A: HCurve2d from Adaptor2d; Param: Real from Standard;
92	TLine, TArc: Transition from IntSurf)
93
94	---Purpose: Sets the values of a point which is on one of the domain,
95	-- when both surfaces are implicit ones.
96	-- If OnFirst is True, the point is on the domain of the
97	-- first patch, otherwise the point is on the domain of the
98	-- second surface.
99
100	is static;
101
102
103	SetMultiple(me: in out; IsMult: Boolean from Standard)
104
105	---Purpose: Sets (or unsets) the point as a point on several
106	-- intersection line.
107	---C++: inline
108	is static;
109
110
111	Value(me)
112
113	---Purpose: Returns the intersection point (geometric information).
114
115	returns Pnt from gp
116	---C++: return const&
117	---C++: inline
118
119	is static;
120
121
122	ParameterOnLine(me)
123
124	---Purpose: This method returns the parameter of the point
125	-- on the intersection line.
126	-- If the points does not belong to an intersection line,
127	-- the value returned does not have any sens.
128
129	returns Real from Standard
130	---C++: inline
131
132	is static;
133
134
135	Tolerance(me)
136
137	---Purpose: This method returns the fuzziness on the point.
138
139	returns Real from Standard
140	---C++: inline
141
142	is static;
143
144
145	IsTangencyPoint(me)
146
147	---Purpose: Returns True if the Point is a tangency point between
148	-- the surfaces.
149	-- If the Point is on one of the domain (IsOnDomS1 returns
150	-- True or IsOnDomS2 returns True), an exception is raised.
151
152	returns Boolean from Standard
153	---C++: inline
154
155	raises DomainError from Standard
156
157	is static;
158
159
160	ParametersOnS1(me; U1,V1: out Real from Standard)
161
162	---Purpose: Returns the parameters on the first surface of the point.
163
164	raises DomainError from Standard
165	---C++: inline
166
167	is static;
168
169
170	ParametersOnS2(me; U2,V2: out Real from Standard)
171
172	---Purpose: Returns the parameters on the second surface of the point.
173
174	raises DomainError from Standard
175	---C++: inline
176
177	is static;
178
179
180	IsMultiple(me)
181
182	---Purpose: Returns True if the point belongs to several intersection
183	-- lines.
184
185	returns Boolean from Standard
186	---C++: inline
187
188	is static;
189
190
191	IsOnDomS1(me)
192
193	---Purpose: Returns TRUE if the point is on a boundary of the domain
194	-- of the first patch.
195
196	returns Boolean from Standard
197	---C++: inline
198
199	is static;
200
201
202	IsVertexOnS1(me)
203
204	---Purpose: Returns TRUE if the point is a vertex on the initial
205	-- restriction facet of the first surface.
206
207	returns Boolean from Standard
208	---C++: inline
209
210	is static;
211
212
213	VertexOnS1(me)
214
215	---Purpose: Returns the information about the point when it is
216	-- on the domain of the first patch, i-e when the function
217	-- IsVertexOnS1 returns True.
218	-- Otherwise, an exception is raised.
219
220	returns HVertex from Adaptor3d
221	---C++: return const&
222	---C++: inline
223
224	raises DomainError from Standard
225
226	is static;
227
228
229	ArcOnS1(me)
230
231	---Purpose: Returns the arc of restriction containing the
232	-- vertex.
233	-- The exception DomainError is raised if
234	-- IsOnDomS1 returns False.
235
236	returns HCurve2d from Adaptor2d
237	---C++: return const&
238	---C++: inline
239
240	raises DomainError from Standard
241
242	is static;
243
244
245	TransitionLineArc1(me)
246
247	---Purpose: Returns the transition of the point on the
248	-- intersection line with the arc on S1.
249	-- The exception DomainError is raised if IsOnDomS1
250	-- returns False.
251
252	returns Transition from IntSurf
253	---C++: return const&
254	---C++: inline
255
256	raises DomainError from Standard
257
258	is static;
259
260
261	TransitionOnS1(me)
262
263	---Purpose: Returns the transition between the intersection line
264	-- returned by the method Line and the arc on S1 returned
265	-- by ArcOnS1().
266	-- The exception DomainError is raised if
267	-- IsOnDomS1 returns False.
268
269	returns Transition from IntSurf
270	---C++: return const&
271	---C++: inline
272
273	raises DomainError from Standard
274
275	is static;
276
277
278	ParameterOnArc1(me)
279
280	---Purpose: Returns the parameter of the point on the
281	-- arc returned by the method ArcOnS2.
282	-- The exception DomainError is raised if
283	-- IsOnDomS1 returns False.
284
285	returns Real from Standard
286	---C++: inline
287
288	raises DomainError from Standard
289
290	is static;
291
292
293	IsOnDomS2(me)
294
295	---Purpose: Returns TRUE if the point is on a boundary of the domain
296	-- of the second patch.
297
298	returns Boolean from Standard
299	---C++: inline
300
301	is static;
302
303
304	IsVertexOnS2(me)
305
306	---Purpose: Returns TRUE if the point is a vertex on the initial
307	-- restriction facet of the first surface.
308
309	returns Boolean from Standard
310	---C++: inline
311
312	is static;
313
314
315	VertexOnS2(me)
316
317	---Purpose: Returns the information about the point when it is
318	-- on the domain of the second patch, i-e when the function
319	-- IsVertexOnS2 returns True.
320	-- Otherwise, an exception is raised.
321
322	returns HVertex from Adaptor3d
323	---C++: return const&
324	---C++: inline
325
326	raises DomainError from Standard
327
328	is static;
329
330
331	ArcOnS2(me)
332
333	---Purpose: Returns the arc of restriction containing the
334	-- vertex.
335	-- The exception DomainError is raised if
336	-- IsOnDomS2 returns False.
337
338	returns HCurve2d from Adaptor2d
339	---C++: return const&
340	---C++: inline
341
342	raises DomainError from Standard
343
344	is static;
345
346
347	TransitionLineArc2(me)
348
349	---Purpose: Returns the transition of the point on the
350	-- intersection line with the arc on S2.
351	-- The exception DomainError is raised if IsOnDomS2
352	-- returns False.
353
354	returns Transition from IntSurf
355	---C++: return const&
356	---C++: inline
357
358	raises DomainError from Standard
359
360	is static;
361
362
363	TransitionOnS2(me)
364
365	---Purpose: Returns the transition between the intersection line
366	-- returned by the method Line and the arc on S2 returned
367	-- by ArcOnS2.
368	-- The exception DomainError is raised if
369	-- IsOnDomS2 returns False.
370
371	returns Transition from IntSurf
372	---C++: return const&
373	---C++: inline
374
375	raises DomainError from Standard
376
377	is static;
378
379
380	ParameterOnArc2(me)
381
382	---Purpose: Returns the parameter of the point on the
383	-- arc returned by the method ArcOnS2.
384	-- The exception DomainError is raised if
385	-- IsOnDomS2 returns False.
386
387	returns Real from Standard
388	---C++: inline
389
390	raises DomainError from Standard
391
392	is static;
393
394
395	PntOn2S(me)
396
397	---Purpose: Returns the PntOn2S
398	-- (geometric Point and the parameters)
399	--
400	---C++: inline
401	---C++: return const &
402
403	returns PntOn2S from IntSurf
404	is static;
405
406	Parameters(me; U1,V1,U2,V2: out Real from Standard)
407	---Purpose: Returns the parameters on the first and on the
408	-- second surface of the point.
409	raises DomainError from Standard
410	---C++: inline
411
412	is static;
413
414
415	ReverseTransition(me: in out)
416	is static;
417
418	Dump(me)
419
420	is static;
421
422	fields
423
424	pt : PntOn2S from IntSurf;
425	para : Real from Standard;
426	tol : Real from Standard;
427	tgt : Boolean from Standard;
428	mult : Boolean from Standard;
429
430	onS1 : Boolean from Standard;
431	vtxonS1 : Boolean from Standard;
432	vS1 : HVertex from Adaptor3d;
433	arcS1 : HCurve2d from Adaptor2d;
434	traline1 : Transition from IntSurf;
435	tra1 : Transition from IntSurf;
436	prm1 : Real from Standard;
437
438	onS2 : Boolean from Standard;
439	vtxonS2 : Boolean from Standard;
440	vS2 : HVertex from Adaptor3d;
441	arcS2 : HCurve2d from Adaptor2d;
442	traline2 : Transition from IntSurf;
443	tra2 : Transition from IntSurf;
444	prm2 : Real from Standard;
445
446	end Point;