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

-- Created on: 1992-05-07
-- 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 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 ImpImpIntersection from IntPatch
	     
	---Purpose: Implementation of the intersection between two
	--          quadric patches : Plane, Cone, Cylinder or Sphere.


uses HSurface from Adaptor3d,
     TopolTool from Adaptor3d,
     Point from IntPatch,
     SequenceOfPoint from IntPatch,
     TheSOnBounds from IntPatch,
     SequenceOfLine from IntPatch,
     Line           from IntPatch


raises NotDone           from StdFail,
       OutOfRange        from Standard,
       DomainError       from Standard,
       ConstructionError from Standard

is


    Create
    
    	returns ImpImpIntersection from IntPatch;


    Create (S1: HSurface from Adaptor3d; D1: TopolTool from Adaptor3d;
            S2: HSurface from Adaptor3d; D2: TopolTool from Adaptor3d;
            TolArc,TolTang: Real from Standard)
	    
	returns ImpImpIntersection from IntPatch
	
	raises ConstructionError from Standard;


    Perform (me: in out;
             S1: HSurface from Adaptor3d; D1: TopolTool from Adaptor3d;
             S2: HSurface from Adaptor3d; D2: TopolTool from Adaptor3d;
             TolArc,TolTang: Real from Standard)

	raises ConstructionError from Standard    

	is static;


    IsDone(me)
    
    	---Purpose: Returns True if the calculus was succesfull.

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


    IsEmpty(me)
    
    	---Purpose: Returns true if the is no intersection.

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

    	raises NotDone from StdFail

    	is static;


    TangentFaces(me)
    
	---Purpose: Returns True if the two patches are considered as
	--          entierly tangent, i-e every restriction arc of one
	--          patch is inside the geometric base of the otehr patch.

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


    OppositeFaces(me)
    
	---Purpose: Returns True when the TangentFaces returns True and the
	--          normal vectors evaluated at a point on the first and the
	--          second surface are opposite. 
	--          The exception DomainError is raised if TangentFaces
	--          returns False.

    	returns Boolean from Standard
	---C++: inline
	
	raises NotDone     from StdFail,
               DomainError from Standard
	
	is static;


    NbPnts(me)
    
    	---Purpose: Returns the number of "single" points.

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

    	raises NotDone from StdFail
	
    	is static;


    Point(me; Index: Integer from Standard)
    
    	---Purpose: Returns the point of range Index.
    	--          An exception is raised if Index<=0 or Index>NbPnt.

    	returns Point from IntPatch
	---C++: return const&
	---C++: inline

    	raises NotDone    from StdFail,
               OutOfRange from Standard

    	is static;


    NbLines(me)
    
    	---Purpose: Returns the number of intersection lines.

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

    	raises NotDone from StdFail

    	is static;


    Line(me; Index: Integer from Standard)
    
    	---Purpose: Returns the line of range Index.
    	--          An exception is raised if Index<=0 or Index>NbLine.

    	returns Line from IntPatch
	---C++: inline
	---C++: return const&

    	raises NotDone    from StdFail,
               OutOfRange from Standard
	
    	is static;


fields

    done   : Boolean         from Standard;
    empt   : Boolean         from Standard;
    tgte   : Boolean         from Standard;
    oppo   : Boolean         from Standard;
    spnt   : SequenceOfPoint from IntPatch;
    slin   : SequenceOfLine  from IntPatch;
    solrst : TheSOnBounds    from IntPatch;

end ImpImpIntersection;
Commit	Line	Data
b311480e	1	-- Created on: 1992-05-07
	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	--
973c2be1	8	-- This library is free software; you can redistribute it and / or modify it
	9	-- under the terms of the GNU Lesser General Public 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.
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 ImpImpIntersection from IntPatch
	18
	19	---Purpose: Implementation of the intersection between two
	20	-- quadric patches : Plane, Cone, Cylinder or Sphere.
	21
	22
	23	uses HSurface from Adaptor3d,
	24	TopolTool from Adaptor3d,
	25	Point from IntPatch,
	26	SequenceOfPoint from IntPatch,
	27	TheSOnBounds from IntPatch,
	28	SequenceOfLine from IntPatch,
	29	Line from IntPatch
	30
	31
	32	raises NotDone from StdFail,
	33	OutOfRange from Standard,
	34	DomainError from Standard,
	35	ConstructionError from Standard
	36
	37	is
	38
	39
	40	Create
	41
	42	returns ImpImpIntersection from IntPatch;
	43
	44
	45	Create (S1: HSurface from Adaptor3d; D1: TopolTool from Adaptor3d;
	46	S2: HSurface from Adaptor3d; D2: TopolTool from Adaptor3d;
	47	TolArc,TolTang: Real from Standard)
	48
	49	returns ImpImpIntersection from IntPatch
	50
	51	raises ConstructionError from Standard;
	52
	53
	54	Perform (me: in out;
	55	S1: HSurface from Adaptor3d; D1: TopolTool from Adaptor3d;
	56	S2: HSurface from Adaptor3d; D2: TopolTool from Adaptor3d;
	57	TolArc,TolTang: Real from Standard)
	58
	59	raises ConstructionError from Standard
	60
	61	is static;
	62
	63
	64	IsDone(me)
	65
	66	---Purpose: Returns True if the calculus was succesfull.
	67
	68	returns Boolean from Standard
	69	---C++: inline
	70
	71	is static;
	72
	73
	74	IsEmpty(me)
	75
	76	---Purpose: Returns true if the is no intersection.
	77
	78	returns Boolean from Standard
	79	---C++: inline
80
81	raises NotDone from StdFail
82
83	is static;
84
85
86	TangentFaces(me)
87
88	---Purpose: Returns True if the two patches are considered as
89	-- entierly tangent, i-e every restriction arc of one
90	-- patch is inside the geometric base of the otehr patch.
91
92	returns Boolean from Standard
93	---C++: inline
94
95	raises NotDone from StdFail
96
97	is static;
98
99
100	OppositeFaces(me)
101
102	---Purpose: Returns True when the TangentFaces returns True and the
103	-- normal vectors evaluated at a point on the first and the
104	-- second surface are opposite.
105	-- The exception DomainError is raised if TangentFaces
106	-- returns False.
107
108	returns Boolean from Standard
109	---C++: inline
110
111	raises NotDone from StdFail,
112	DomainError from Standard
113
114	is static;
115
116
117	NbPnts(me)
118
119	---Purpose: Returns the number of "single" points.
120
121	returns Integer from Standard
122	---C++: inline
123
124	raises NotDone from StdFail
125
126	is static;
127
128
129	Point(me; Index: Integer from Standard)
130
131	---Purpose: Returns the point of range Index.
132	-- An exception is raised if Index<=0 or Index>NbPnt.
133
134	returns Point from IntPatch
135	---C++: return const&
136	---C++: inline
137
138	raises NotDone from StdFail,
139	OutOfRange from Standard
140
141	is static;
142
143
144	NbLines(me)
145
146	---Purpose: Returns the number of intersection lines.
147
148	returns Integer from Standard
149	---C++: inline
150
151	raises NotDone from StdFail
152
153	is static;
154
155
156	Line(me; Index: Integer from Standard)
157
158	---Purpose: Returns the line of range Index.
159	-- An exception is raised if Index<=0 or Index>NbLine.
160
161	returns Line from IntPatch
162	---C++: inline
163	---C++: return const&
164
165	raises NotDone from StdFail,
166	OutOfRange from Standard
167
168	is static;
169
170
171	fields
172
173	done : Boolean from Standard;
174	empt : Boolean from Standard;
175	tgte : Boolean from Standard;
176	oppo : Boolean from Standard;
7fd59977	177	spnt : SequenceOfPoint from IntPatch;
	178	slin : SequenceOfLine from IntPatch;
	179	solrst : TheSOnBounds from IntPatch;
	180
	181	end ImpImpIntersection;