[occt.git] / src / BRepBlend / BRepBlend_AppSurface.cdl

-- Created on: 1996-11-25
-- Created by: Philippe MANGIN
-- Copyright (c) 1996-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.


class AppSurface from BRepBlend inherits Approx from AppBlend

	---Purpose:Used to Approximate the blending surfaces.

uses Array2OfReal            from TColStd,
     HArray2OfReal           from TColStd,
     Array1OfReal            from TColStd,
     HArray1OfReal           from TColStd,
     Array1OfInteger         from TColStd,
     HArray1OfInteger        from TColStd,     
     Array1OfPnt2d           from TColgp,
     Array2OfPnt             from TColgp,
     HArray2OfPnt            from TColgp,

     Shape                   from GeomAbs,
     SweepFunction           from Approx, 
     SweepApproximation      from Approx


raises NotDone     from StdFail,
       DomainError,
       OutOfRange

is
    Create(Funct : in  out SweepFunction from Approx;
    	   First,  Last  :  Real;
           Tol3d,  Tol2d, TolAngular : Real;
	   Continuity : Shape = GeomAbs_C0;
	   Degmax     : Integer = 11;
           Segmax     : Integer = 50)
	   ---Purpose: Approximation     of   the   new  Surface  (and
	   --          eventually the  2d    Curves   on the   support
	   --          surfaces).     
	   --          Normaly     the  2d    curve are
	   --          approximated  with an  tolerance   given  by   the
	   --          resolution on   support surfaces,  but  if this
	   --          tolerance is too large Tol2d  is used.
    	returns AppSurface from BRepBlend;
	 
		 
    IsDone(me)
        returns Boolean from Standard
	---C++: inline	
	is static;


    SurfShape(me; UDegree,VDegree  : out Integer from Standard;
                  NbUPoles,NbVPoles: out Integer from Standard;
                  NbUKnots,NbVKnots: out Integer from Standard)
    	raises NotDone from StdFail
    	is static;


    Surface(me; TPoles          : out Array2OfPnt from TColgp;
    	        TWeights        : out Array2OfReal from TColStd;
		TUKnots,TVKnots : out Array1OfReal from TColStd;
		TUMults,TVMults : out Array1OfInteger from TColStd)
    	raises NotDone from StdFail
    	is static;


    UDegree(me)
    
    	returns Integer from Standard
	---C++: inline

    	raises NotDone from StdFail
	is static;


    VDegree(me)
    
    	returns Integer from Standard
	---C++: inline

    	raises NotDone from StdFail
	is static;


    SurfPoles(me)
    
    	returns Array2OfPnt from TColgp
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail
	is static;


    SurfWeights(me)
    
    	returns Array2OfReal from TColStd
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail
	is static;


    SurfUKnots(me)
    
    	returns Array1OfReal from TColStd
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail
	is static;


    SurfVKnots(me)
    
    	returns Array1OfReal from TColStd
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail
	is static;


    SurfUMults(me)
    
    	returns Array1OfInteger from TColStd
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail
	is static;


    SurfVMults(me)
    
    	returns Array1OfInteger from TColStd
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail
	is static;
	
    MaxErrorOnSurf (me) 
    ---Purpose: returns the maximum error in the suface approximation.
    returns Real; 

    NbCurves2d(me)
    
    	returns Integer from Standard
	---C++: inline
	
	raises NotDone from StdFail
	is static;


    Curves2dShape(me; Degree,NbPoles,NbKnots: out Integer from Standard)
    
    	raises NotDone from StdFail,
	       DomainError from Standard

        is static;
	
	
    Curve2d(me; Index: Integer from Standard;
                TPoles   : out Array1OfPnt2d from TColgp;
		TKnots   : out Array1OfReal from TColStd;
		TMults   : out Array1OfInteger from TColStd)
		
    	raises NotDone     from StdFail,
	       OutOfRange  from Standard,
	       DomainError from Standard

    	is static;     


    Curves2dDegree(me)
    
    	returns Integer from Standard
	---C++: inline
	
	raises NotDone from StdFail,
	       DomainError from Standard
	is static;
	
	
    Curve2dPoles(me; Index: Integer from Standard)
    
    	returns Array1OfPnt2d from TColgp
	---C++: inline
	---C++: return const&
	
	raises NotDone     from StdFail,
	       OutOfRange  from Standard,
	       DomainError from Standard
	is static;
	

    Curves2dKnots(me)
    
    	returns Array1OfReal from TColStd
	---C++: inline
	---C++: return const&

	raises NotDone from StdFail,
	       DomainError from Standard
	is static;


    Curves2dMults(me)    
    	returns Array1OfInteger from TColStd
	---C++: inline
	---C++: return const&
	raises NotDone from StdFail,
	       DomainError from Standard
	is static;
	
    
    TolReached(me; Tol3d, Tol2d : out Real from Standard)
	raises NotDone from StdFail 
	is static;
	
    Max2dError (me; Index : Integer) 
    	---Purpose: returns the maximum error in the <Index> 2d curve approximation.
    	returns Real   
    	raises NotDone from StdFail  
    	is  static; 

    TolCurveOnSurf(me; Index  :  Integer  from Standard) 
	returns  Real from Standard  
	raises NotDone from StdFail
        is static; 	
    
    Dump(me; o: in out OStream);
    ---Purpose: diplay information on approximation.

fields
    approx    : SweepApproximation from Approx; 
end AppSurface;
Commit	Line	Data
b311480e	1	-- Created on: 1996-11-25
	2	-- Created by: Philippe MANGIN
	3	-- Copyright (c) 1996-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21
	22
	23	class AppSurface from BRepBlend inherits Approx from AppBlend
	24
	25	---Purpose:Used to Approximate the blending surfaces.
	26
	27	uses Array2OfReal from TColStd,
	28	HArray2OfReal from TColStd,
	29	Array1OfReal from TColStd,
	30	HArray1OfReal from TColStd,
	31	Array1OfInteger from TColStd,
	32	HArray1OfInteger from TColStd,
	33	Array1OfPnt2d from TColgp,
	34	Array2OfPnt from TColgp,
	35	HArray2OfPnt from TColgp,
	36
	37	Shape from GeomAbs,
	38	SweepFunction from Approx,
	39	SweepApproximation from Approx
	40
	41
	42	raises NotDone from StdFail,
	43	DomainError,
	44	OutOfRange
	45
	46	is
	47	Create(Funct : in out SweepFunction from Approx;
	48	First, Last : Real;
	49	Tol3d, Tol2d, TolAngular : Real;
	50	Continuity : Shape = GeomAbs_C0;
	51	Degmax : Integer = 11;
	52	Segmax : Integer = 50)
	53	---Purpose: Approximation of the new Surface (and
	54	-- eventually the 2d Curves on the support
	55	-- surfaces).
	56	-- Normaly the 2d curve are
	57	-- approximated with an tolerance given by the
	58	-- resolution on support surfaces, but if this
	59	-- tolerance is too large Tol2d is used.
	60	returns AppSurface from BRepBlend;
	61
	62
	63	IsDone(me)
	64	returns Boolean from Standard
	65	---C++: inline
	66	is static;
	67
	68
	69	SurfShape(me; UDegree,VDegree : out Integer from Standard;
	70	NbUPoles,NbVPoles: out Integer from Standard;
	71	NbUKnots,NbVKnots: out Integer from Standard)
	72	raises NotDone from StdFail
	73	is static;
	74
	75
	76	Surface(me; TPoles : out Array2OfPnt from TColgp;
	77	TWeights : out Array2OfReal from TColStd;
	78	TUKnots,TVKnots : out Array1OfReal from TColStd;
	79	TUMults,TVMults : out Array1OfInteger from TColStd)
	80	raises NotDone from StdFail
	81	is static;
	82
	83
	84	UDegree(me)
85
86	returns Integer from Standard
87	---C++: inline
88
89	raises NotDone from StdFail
90	is static;
91
92
93	VDegree(me)
94
95	returns Integer from Standard
96	---C++: inline
97
98	raises NotDone from StdFail
99	is static;
100
101
102	SurfPoles(me)
103
104	returns Array2OfPnt from TColgp
105	---C++: inline
106	---C++: return const&
107
108	raises NotDone from StdFail
109	is static;
110
111
112	SurfWeights(me)
113
114	returns Array2OfReal from TColStd
115	---C++: inline
116	---C++: return const&
117
118	raises NotDone from StdFail
119	is static;
120
121
122	SurfUKnots(me)
123
124	returns Array1OfReal from TColStd
125	---C++: inline
126	---C++: return const&
127
128	raises NotDone from StdFail
129	is static;
130
131
132	SurfVKnots(me)
133
134	returns Array1OfReal from TColStd
135	---C++: inline
136	---C++: return const&
137
138	raises NotDone from StdFail
139	is static;
140
141
142	SurfUMults(me)
143
144	returns Array1OfInteger from TColStd
145	---C++: inline
146	---C++: return const&
147
148	raises NotDone from StdFail
149	is static;
150
151
152	SurfVMults(me)
153
154	returns Array1OfInteger from TColStd
155	---C++: inline
156	---C++: return const&
157
158	raises NotDone from StdFail
159	is static;
160
161	MaxErrorOnSurf (me)
162	---Purpose: returns the maximum error in the suface approximation.
163	returns Real;
164
165	NbCurves2d(me)
166
167	returns Integer from Standard
168	---C++: inline
169
170	raises NotDone from StdFail
171	is static;
172
173
174	Curves2dShape(me; Degree,NbPoles,NbKnots: out Integer from Standard)
175
176	raises NotDone from StdFail,
177	DomainError from Standard
178
179	is static;
180
181
182	Curve2d(me; Index: Integer from Standard;
183	TPoles : out Array1OfPnt2d from TColgp;
184	TKnots : out Array1OfReal from TColStd;
185	TMults : out Array1OfInteger from TColStd)
186
187	raises NotDone from StdFail,
188	OutOfRange from Standard,
189	DomainError from Standard
190
191	is static;
192
193
194	Curves2dDegree(me)
195
196	returns Integer from Standard
197	---C++: inline
198
199	raises NotDone from StdFail,
200	DomainError from Standard
201	is static;
202
203
204	Curve2dPoles(me; Index: Integer from Standard)
205
206	returns Array1OfPnt2d from TColgp
207	---C++: inline
208	---C++: return const&
209
210	raises NotDone from StdFail,
211	OutOfRange from Standard,
212	DomainError from Standard
213	is static;
214
215
216	Curves2dKnots(me)
217
218	returns Array1OfReal from TColStd
219	---C++: inline
220	---C++: return const&
221
222	raises NotDone from StdFail,
223	DomainError from Standard
224	is static;
225
226
227	Curves2dMults(me)
228	returns Array1OfInteger from TColStd
229	---C++: inline
230	---C++: return const&
231	raises NotDone from StdFail,
232	DomainError from Standard
233	is static;
234
235
236	TolReached(me; Tol3d, Tol2d : out Real from Standard)
237	raises NotDone from StdFail
238	is static;
239
240	Max2dError (me; Index : Integer)
241	---Purpose: returns the maximum error in the <Index> 2d curve approximation.
242	returns Real
243	raises NotDone from StdFail
244	is static;
245
246	TolCurveOnSurf(me; Index : Integer from Standard)
247	returns Real from Standard
248	raises NotDone from StdFail
249	is static;
250
251	Dump(me; o: in out OStream);
252	---Purpose: diplay information on approximation.
253
254	fields
255	approx : SweepApproximation from Approx;
256	end AppSurface;