0023024: Update headers of OCCT files
[occt.git] / src / BRepGProp / BRepGProp_EdgeTool.cdl
1 -- Created on: 1993-12-07
2 -- Created by: Modelistation
3 -- Copyright (c) 1993-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
21
22
23 class EdgeTool from BRepGProp
24
25      --- Purpose :   Provides  the required  methods    to instantiate
26      --  CGProps from GProp with a Curve from BRepAdaptor.
27
28 uses Pnt from gp,
29      Vec from gp,
30      Curve from BRepAdaptor,
31      Shape from GeomAbs,
32      Array1OfReal from TColStd
33 raises
34     OutOfRange  from Standard
35
36 is
37
38
39   FirstParameter (myclass; C : Curve from BRepAdaptor)   returns Real;
40         --- Purpose :
41         --  Returns the parametric value of the start point of
42         --  the curve.  The curve is oriented from the start point
43         --  to the end point.
44
45
46   LastParameter (myclass; C : Curve from BRepAdaptor)   returns Real;
47         --- Purpose :
48         --  Returns the parametric value of the end point of
49         --  the curve.  The curve is oriented from the start point
50         --  to the end point.
51
52
53   IntegrationOrder (myclass; C : Curve from BRepAdaptor)    returns Integer;
54         --- Purpose :
55         --  Returns the number of Gauss points required to do
56         --  the integration with a good accuracy using the
57         --  Gauss method.  For a polynomial curve of degree n
58         --  the maxima of accuracy is obtained with an order
59         --  of integration equal to 2*n-1.
60
61
62   Value (myclass; C : Curve from BRepAdaptor; U : Real)  returns Pnt;
63         --- Purpose : Returns the point of parameter U on the loaded curve.
64
65
66   D1 (myclass; C : Curve from BRepAdaptor; U: Real; P: out Pnt; V1: out Vec);
67         --- Purpose : 
68         --  Returns the point of parameter U and the first derivative
69         --  at this point.
70
71   NbIntervals(myclass; C : Curve from BRepAdaptor; S : Shape from GeomAbs)
72         ---Purpose: Returns  the number  of  intervals for  continuity
73         --          <S>. May be one if Continuity(me) >= <S>
74         returns Integer;
75
76   Intervals(myclass; C : Curve from BRepAdaptor;
77                      T : in out Array1OfReal from TColStd; 
78                      S : Shape from GeomAbs)
79         ---Purpose: Stores in <T> the  parameters bounding the intervals
80         --          of continuity <S>.
81         --          
82         --          The array must provide  enough room to  accomodate
83         --          for the parameters. i.e. T.Length() > NbIntervals()
84         raises
85             OutOfRange from Standard;
86
87 end EdgeTool;