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

-- Created on: 1997-07-28
-- Created by: Jerome LEMONIER
-- Copyright (c) 1997-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 SurfRstEvolRad from BRepBlend
inherits SurfRstFunction from Blend

	---Purpose: 

uses Vector          from math,
     Matrix          from math,
     Ax1             from gp,
     Vec             from gp,
     Vec2d           from gp,
     Pnt             from gp,
     Pnt2d           from gp,
     Circ            from gp,
     Array1OfPnt     from TColgp,
     Array1OfVec     from TColgp,
     Array1OfPnt2d   from TColgp,
     Array1OfVec2d   from TColgp,
     Array1OfReal    from TColStd,
     Array1OfInteger from TColStd,
     Shape           from GeomAbs,
     Point           from Blend,
     SectionShape    from BlendFunc,
     HSurface        from Adaptor3d,
     HCurve          from Adaptor3d,
     HCurve2d        from Adaptor2d,
     CurveOnSurface  from Adaptor3d,
     ParameterisationType from Convert,
     Function from Law

is

    Create(Surf    : HSurface from Adaptor3d;
    	   SurfRst : HSurface from Adaptor3d;
    	   Rst     : HCurve2d from Adaptor2d; 
    	   CGuide  : HCurve   from Adaptor3d;
    	   Evol    : Function from Law)
    returns SurfRstEvolRad from BRepBlend;

    NbVariables(me)
    ---Purpose: Returns 3.
    returns Integer from Standard;

    NbEquations(me)
    ---Purpose: Returns 3.
    returns Integer from Standard;

    Value(me: in out; X: Vector; F: out Vector)
    ---Purpose: computes the values <F> of the Functions for the 
    --          variable <X>.
    --          Returns True if the computation was done successfully, 
    --          False otherwise.
    returns Boolean from Standard;
    
    Derivatives(me: in out; X: Vector; D: out Matrix)
    ---Purpose: returns the values <D> of the derivatives for the 
    --          variable <X>.
    --          Returns True if the computation was done successfully, 
    --          False otherwise.
    returns Boolean from Standard;
    
    Values(me: in out; X: Vector; F: out Vector; D: out Matrix)
    ---Purpose: returns the values <F> of the functions and the derivatives
    --          <D> for the variable <X>.
    --          Returns True if the computation was done successfully, 
    --          False otherwise.
    returns Boolean from Standard;

    Set(me      : in out; 
        SurfRef : HSurface from Adaptor3d;
    	RstRef  : HCurve2d from Adaptor2d);
    	   
    Set(me: in out; Param: Real from Standard);

    Set(me: in out; First, Last: Real from Standard);
    ---Purpose: Sets the bounds of the parametric interval on 
    --          the guide line.
    --          This determines the derivatives in these values if the
    --          function is not Cn.

    GetTolerance(me; Tolerance: out Vector from math; Tol: Real from Standard);

    GetBounds(me; InfBound,SupBound: out Vector from math);

    IsSolution(me: in out; Sol: Vector from math; Tol: Real from Standard)
    returns Boolean from Standard;

    GetMinimalDistance(me) 
        ---Purpose: Returns   the    minimal  Distance  beetween   two
        --          extremitys of calculed sections.          
    returns  Real  from  Standard 
    is  redefined;

--- TheFollowing methods are called only when 
--  IsSolution returns Standard_True.

    PointOnS(me)
    ---C++: return const&
    returns Pnt from gp;

    PointOnRst(me)
    ---C++: return const&
    returns Pnt from gp;

    Pnt2dOnS(me)
    ---Purpose: Returns U,V coordinates of the point on the surface.
    ---C++: return const&
    returns Pnt2d from gp;

    Pnt2dOnRst(me)
    ---Purpose: Returns  U,V coordinates of the point  on the curve on
    --          surface.
    ---C++: return const&
    returns Pnt2d from gp;

    ParameterOnRst(me)
    ---Purpose: Returns parameter of the point on the curve.
    returns Real from Standard;

    IsTangencyPoint(me)
    returns Boolean from Standard;

    TangentOnS(me)
    ---C++: return const&
    returns Vec from gp;

    Tangent2dOnS(me)
    ---C++: return const&
    returns Vec2d from gp;

    TangentOnRst(me)
    ---C++: return const&
    returns Vec from gp;

    Tangent2dOnRst(me)
    ---C++: return const&
    returns Vec2d from gp;

    Decroch(me; 
    	    Sol    : Vector from math;
    	    NS,TgS : out Vec from gp)
    ---Warning: Peut  etre  appele sans appel prealable   a issolution
    --          mais les valeurs  calculees risquent  de ne pas  avoir
    --          grand  sens.    
    ---Purpose: Permet  d ' implementer   un   critere  de  decrochage
    --          specifique a la fonction.
    returns Boolean from Standard
    is static;

-- methodes hors template (en plus du create)

    Set(me     : in out; 
    	Choix  : Integer from Standard)
    is static;

    Set(me: in out; TypeSection: SectionShape from BlendFunc)
    ---Purpose: Sets  the  type  of   section generation   for the
    --          approximations. 
    is static;

    Section(me        : in out; 
            Param     : Real from Standard;
            U,V,W     : Real from Standard;
            Pdeb,Pfin : out Real from Standard;
            C         : out Circ from gp)
    is static;

-- Methods for the approximation
-- 
    IsRational(me) returns Boolean
    ---Purpose: Returns  if the section is rationnal
    is static;

    GetSectionSize(me) returns Real
    ---Purpose:  Returns the length of the maximum section
    is static;
    
    GetMinimalWeight(me; Weigths  : out Array1OfReal  from TColStd)
    ---Purpose: Compute the minimal value of weight for each poles
    --          of all sections.
    is static;

    NbIntervals(me; S : Shape from GeomAbs) returns Integer
    ---Purpose: Returns  the number  of  intervals for  continuity
    --          <S>. May be one if Continuity(me) >= <S>
    is static;
    
    Intervals(me; T : in out Array1OfReal from TColStd; 
    	          S : Shape from GeomAbs)
    ---Purpose: Stores in <T> the  parameters bounding the intervals
    --          of continuity <S>.        
    --          The array must provide  enough room to  accomodate
    --          for the parameters. i.e. T.Length() > NbIntervals()
    is static;

    GetShape(me        : in out;
             NbPoles   : out Integer from Standard;
    	     NbKnots   : out Integer from Standard;
             Degree    : out Integer from Standard;
             NbPoles2d : out Integer from Standard)
    is static;

    GetTolerance(me; 
    	    	 BoundTol, SurfTol, AngleTol : Real;
		 Tol3d : out Vector;
		 Tol1D : out Vector )
    ---Purpose: Returns the tolerance to reach in approximation
    --          to respecte
    --          BoundTol error at the Boundary
    --          AngleTol tangent error at the Boundary
    --          SurfTol error inside the surface.
    is static;

    Knots(me: in out; TKnots: out Array1OfReal from TColStd)
    is static;

    Mults(me: in out; TMults: out Array1OfInteger from TColStd)
    is static;

    Section(me       : in out ; 
    	    P        : Point from Blend;
            Poles    : out Array1OfPnt   from TColgp;
	    DPoles   : out Array1OfVec   from TColgp;
  	    Poles2d  : out Array1OfPnt2d from TColgp;
	    DPoles2d : out Array1OfVec2d from TColgp;
	    Weigths  : out Array1OfReal  from TColStd;
	    DWeigths : out Array1OfReal  from TColStd)
    ---Purpose: Used for the first and last section 
    returns Boolean from Standard
    is static;

    Section(me: in out; P: Point from Blend;
			Poles     : out Array1OfPnt   from TColgp;
			DPoles    : out Array1OfVec   from TColgp;
			D2Poles   : out Array1OfVec   from TColgp;
    	                Poles2d   : out Array1OfPnt2d from TColgp;
			DPoles2d  : out Array1OfVec2d from TColgp;
			D2Poles2d : out Array1OfVec2d from TColgp;
			Weigths   : out Array1OfReal  from TColStd;
			DWeigths  : out Array1OfReal  from TColStd;
                        D2Weigths : out Array1OfReal  from TColStd)
    ---Purpose: Used for the first and last section
    --          The method returns Standard_True if the derivatives
    --          are computed, otherwise it returns Standard_False.
    returns Boolean from Standard
    is static;

    Section(me       : in out ; 
    	    P        : Point from Blend;
            Poles    : out Array1OfPnt   from TColgp;
    	    Poles2d  : out Array1OfPnt2d from TColgp;
	    Weigths  : out Array1OfReal  from TColStd)
    is static;

    Resolution(me; 
    	       IC2d : Integer from Standard;
	       Tol  : Real from Standard;
	       TolU, TolV : out Real from Standard);

fields

    surf     : HSurface             from Adaptor3d;
    surfrst  : HSurface             from Adaptor3d;
    rst      : HCurve2d             from Adaptor2d;
    cons     : CurveOnSurface       from Adaptor3d;
    guide    : HCurve               from Adaptor3d; 
    tguide   : HCurve               from Adaptor3d;
    pts      : Pnt                  from gp;
    ptrst    : Pnt                  from gp;
    pt2ds    : Pnt2d                from gp;
    pt2drst  : Pnt2d                from gp;
    prmrst   : Real                 from Standard;
    istangent: Boolean              from Standard;
    tgs      : Vec                  from gp;
    tg2ds    : Vec2d                from gp;
    tgrst    : Vec                  from gp;
    tg2drst  : Vec2d                from gp;

    ray      : Real                 from Standard;
    dray      : Real                 from Standard;
    choix    : Integer              from Standard;
    ptgui    : Pnt                  from gp;
    d1gui    : Vec                  from gp;
    d2gui    : Vec                  from gp;
    nplan    : Vec                  from gp;
    normtg   : Real                 from Standard;
    theD     : Real                 from Standard;
       
    surfref  : HSurface             from Adaptor3d;
    rstref   : HCurve2d             from Adaptor2d;

    maxang   : Real                 from Standard;
    minang   : Real                 from Standard; 
    distmin  : Real                 from Standard; 
    mySShape : SectionShape         from BlendFunc;
    myTConv  : ParameterisationType from Convert;
    tevol    : Function             from Law ;
    fevol    : Function             from Law ;
    sg1      : Real    from Standard;
  
end SurfRstEvolRad;
Commit	Line	Data
b311480e	1	-- Created on: 1997-07-28
	2	-- Created by: Jerome LEMONIER
	3	-- Copyright (c) 1997-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 SurfRstEvolRad from BRepBlend
	18	inherits SurfRstFunction from Blend
	19
	20	---Purpose:
	21
	22	uses Vector from math,
	23	Matrix from math,
	24	Ax1 from gp,
	25	Vec from gp,
	26	Vec2d from gp,
	27	Pnt from gp,
	28	Pnt2d from gp,
	29	Circ from gp,
	30	Array1OfPnt from TColgp,
	31	Array1OfVec from TColgp,
	32	Array1OfPnt2d from TColgp,
	33	Array1OfVec2d from TColgp,
	34	Array1OfReal from TColStd,
	35	Array1OfInteger from TColStd,
	36	Shape from GeomAbs,
	37	Point from Blend,
	38	SectionShape from BlendFunc,
	39	HSurface from Adaptor3d,
	40	HCurve from Adaptor3d,
	41	HCurve2d from Adaptor2d,
	42	CurveOnSurface from Adaptor3d,
	43	ParameterisationType from Convert,
	44	Function from Law
	45
	46	is
	47
	48	Create(Surf : HSurface from Adaptor3d;
	49	SurfRst : HSurface from Adaptor3d;
	50	Rst : HCurve2d from Adaptor2d;
	51	CGuide : HCurve from Adaptor3d;
	52	Evol : Function from Law)
	53	returns SurfRstEvolRad from BRepBlend;
	54
	55	NbVariables(me)
	56	---Purpose: Returns 3.
	57	returns Integer from Standard;
	58
	59	NbEquations(me)
	60	---Purpose: Returns 3.
	61	returns Integer from Standard;
	62
	63	Value(me: in out; X: Vector; F: out Vector)
	64	---Purpose: computes the values <F> of the Functions for the
	65	-- variable <X>.
	66	-- Returns True if the computation was done successfully,
	67	-- False otherwise.
	68	returns Boolean from Standard;
	69
	70	Derivatives(me: in out; X: Vector; D: out Matrix)
	71	---Purpose: returns the values <D> of the derivatives for the
	72	-- variable <X>.
	73	-- Returns True if the computation was done successfully,
	74	-- False otherwise.
	75	returns Boolean from Standard;
	76
	77	Values(me: in out; X: Vector; F: out Vector; D: out Matrix)
	78	---Purpose: returns the values <F> of the functions and the derivatives
	79	-- <D> for the variable <X>.
80	-- Returns True if the computation was done successfully,
81	-- False otherwise.
82	returns Boolean from Standard;
83
84	Set(me : in out;
85	SurfRef : HSurface from Adaptor3d;
86	RstRef : HCurve2d from Adaptor2d);
87
88	Set(me: in out; Param: Real from Standard);
89
90	Set(me: in out; First, Last: Real from Standard);
91	---Purpose: Sets the bounds of the parametric interval on
92	-- the guide line.
93	-- This determines the derivatives in these values if the
94	-- function is not Cn.
95
96	GetTolerance(me; Tolerance: out Vector from math; Tol: Real from Standard);
97
98	GetBounds(me; InfBound,SupBound: out Vector from math);
99
100	IsSolution(me: in out; Sol: Vector from math; Tol: Real from Standard)
101	returns Boolean from Standard;
102
103	GetMinimalDistance(me)
104	---Purpose: Returns the minimal Distance beetween two
105	-- extremitys of calculed sections.
106	returns Real from Standard
107	is redefined;
108
109	--- TheFollowing methods are called only when
110	-- IsSolution returns Standard_True.
111
112	PointOnS(me)
113	---C++: return const&
114	returns Pnt from gp;
115
116	PointOnRst(me)
117	---C++: return const&
118	returns Pnt from gp;
119
120	Pnt2dOnS(me)
121	---Purpose: Returns U,V coordinates of the point on the surface.
122	---C++: return const&
123	returns Pnt2d from gp;
124
125	Pnt2dOnRst(me)
126	---Purpose: Returns U,V coordinates of the point on the curve on
127	-- surface.
128	---C++: return const&
129	returns Pnt2d from gp;
130
131	ParameterOnRst(me)
132	---Purpose: Returns parameter of the point on the curve.
133	returns Real from Standard;
134
135	IsTangencyPoint(me)
136	returns Boolean from Standard;
137
138	TangentOnS(me)
139	---C++: return const&
140	returns Vec from gp;
141
142	Tangent2dOnS(me)
143	---C++: return const&
144	returns Vec2d from gp;
145
146	TangentOnRst(me)
147	---C++: return const&
148	returns Vec from gp;
149
150	Tangent2dOnRst(me)
151	---C++: return const&
152	returns Vec2d from gp;
153
154	Decroch(me;
155	Sol : Vector from math;
156	NS,TgS : out Vec from gp)
157	---Warning: Peut etre appele sans appel prealable a issolution
158	-- mais les valeurs calculees risquent de ne pas avoir
159	-- grand sens.
160	---Purpose: Permet d ' implementer un critere de decrochage
161	-- specifique a la fonction.
162	returns Boolean from Standard
163	is static;
164
165	-- methodes hors template (en plus du create)
166
167	Set(me : in out;
168	Choix : Integer from Standard)
169	is static;
170
171	Set(me: in out; TypeSection: SectionShape from BlendFunc)
172	---Purpose: Sets the type of section generation for the
173	-- approximations.
174	is static;
175
176	Section(me : in out;
177	Param : Real from Standard;
178	U,V,W : Real from Standard;
179	Pdeb,Pfin : out Real from Standard;
180	C : out Circ from gp)
181	is static;
182
183	-- Methods for the approximation
184	--
185	IsRational(me) returns Boolean
186	---Purpose: Returns if the section is rationnal
187	is static;
188
189	GetSectionSize(me) returns Real
190	---Purpose: Returns the length of the maximum section
191	is static;
192
193	GetMinimalWeight(me; Weigths : out Array1OfReal from TColStd)
194	---Purpose: Compute the minimal value of weight for each poles
195	-- of all sections.
196	is static;
197
198	NbIntervals(me; S : Shape from GeomAbs) returns Integer
199	---Purpose: Returns the number of intervals for continuity
200	-- <S>. May be one if Continuity(me) >= <S>
201	is static;
202
203	Intervals(me; T : in out Array1OfReal from TColStd;
204	S : Shape from GeomAbs)
205	---Purpose: Stores in <T> the parameters bounding the intervals
206	-- of continuity <S>.
207	-- The array must provide enough room to accomodate
208	-- for the parameters. i.e. T.Length() > NbIntervals()
209	is static;
210
211	GetShape(me : in out;
212	NbPoles : out Integer from Standard;
213	NbKnots : out Integer from Standard;
214	Degree : out Integer from Standard;
215	NbPoles2d : out Integer from Standard)
216	is static;
217
218	GetTolerance(me;
219	BoundTol, SurfTol, AngleTol : Real;
220	Tol3d : out Vector;
221	Tol1D : out Vector )
222	---Purpose: Returns the tolerance to reach in approximation
223	-- to respecte
224	-- BoundTol error at the Boundary
225	-- AngleTol tangent error at the Boundary
226	-- SurfTol error inside the surface.
227	is static;
228
229	Knots(me: in out; TKnots: out Array1OfReal from TColStd)
230	is static;
231
232	Mults(me: in out; TMults: out Array1OfInteger from TColStd)
233	is static;
234
235	Section(me : in out ;
236	P : Point from Blend;
237	Poles : out Array1OfPnt from TColgp;
238	DPoles : out Array1OfVec from TColgp;
239	Poles2d : out Array1OfPnt2d from TColgp;
240	DPoles2d : out Array1OfVec2d from TColgp;
241	Weigths : out Array1OfReal from TColStd;
242	DWeigths : out Array1OfReal from TColStd)
243	---Purpose: Used for the first and last section
244	returns Boolean from Standard
245	is static;
246
247	Section(me: in out; P: Point from Blend;
248	Poles : out Array1OfPnt from TColgp;
249	DPoles : out Array1OfVec from TColgp;
250	D2Poles : out Array1OfVec from TColgp;
251	Poles2d : out Array1OfPnt2d from TColgp;
252	DPoles2d : out Array1OfVec2d from TColgp;
253	D2Poles2d : out Array1OfVec2d from TColgp;
254	Weigths : out Array1OfReal from TColStd;
255	DWeigths : out Array1OfReal from TColStd;
256	D2Weigths : out Array1OfReal from TColStd)
257	---Purpose: Used for the first and last section
258	-- The method returns Standard_True if the derivatives
259	-- are computed, otherwise it returns Standard_False.
260	returns Boolean from Standard
261	is static;
262
263	Section(me : in out ;
264	P : Point from Blend;
265	Poles : out Array1OfPnt from TColgp;
266	Poles2d : out Array1OfPnt2d from TColgp;
267	Weigths : out Array1OfReal from TColStd)
268	is static;
269
270	Resolution(me;
271	IC2d : Integer from Standard;
272	Tol : Real from Standard;
273	TolU, TolV : out Real from Standard);
274
275	fields
276
277	surf : HSurface from Adaptor3d;
278	surfrst : HSurface from Adaptor3d;
279	rst : HCurve2d from Adaptor2d;
280	cons : CurveOnSurface from Adaptor3d;
281	guide : HCurve from Adaptor3d;
282	tguide : HCurve from Adaptor3d;
283	pts : Pnt from gp;
284	ptrst : Pnt from gp;
285	pt2ds : Pnt2d from gp;
286	pt2drst : Pnt2d from gp;
287	prmrst : Real from Standard;
288	istangent: Boolean from Standard;
289	tgs : Vec from gp;
290	tg2ds : Vec2d from gp;
291	tgrst : Vec from gp;
292	tg2drst : Vec2d from gp;
293
294	ray : Real from Standard;
295	dray : Real from Standard;
296	choix : Integer from Standard;
297	ptgui : Pnt from gp;
298	d1gui : Vec from gp;
299	d2gui : Vec from gp;
300	nplan : Vec from gp;
301	normtg : Real from Standard;
302	theD : Real from Standard;
303
304	surfref : HSurface from Adaptor3d;
305	rstref : HCurve2d from Adaptor2d;
306
307	maxang : Real from Standard;
308	minang : Real from Standard;
309	distmin : Real from Standard;
310	mySShape : SectionShape from BlendFunc;
311	myTConv : ParameterisationType from Convert;
312	tevol : Function from Law ;
313	fevol : Function from Law ;
314	sg1 : Real from Standard;
315
316	end SurfRstEvolRad;