0023024: Update headers of OCCT files
[occt.git] / src / GeomFill / GeomFill_SnglrFunc.cdl
1 -- Created on: 1998-02-26
2 -- Created by: Roman BORISOV
3 -- Copyright (c) 1998-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 private class SnglrFunc from GeomFill inherits  Curve  from  Adaptor3d
24
25         ---Purpose: to  represent  function  C'(t)^C''(t)
26
27 uses
28     HCurve from Adaptor3d, 
29     Shape  from GeomAbs, 
30     CurveType  from GeomAbs,
31     Array1OfReal from TColStd, 
32     Pnt from gp, 
33     Vec from gp
34     
35 raises
36     OutOfRange from Standard, 
37     DomainError from Standard
38
39 is
40     Create(HC: HCurve from Adaptor3d) 
41       returns SnglrFunc;  
42        
43     SetRatio(me:in  out;  Ratio  :  Real) 
44       is  static;
45    
46     FirstParameter(me) returns Real
47       is redefined static;
48
49     LastParameter(me) returns Real
50       is redefined static; 
51      
52     NbIntervals(me: in out; S : Shape from GeomAbs) returns Integer
53         ---Purpose: Returns  the number  of  intervals for  continuity
54         --          <S>. May be one if Continuity(me) >= <S>
55     is redefined static;
56     
57     Intervals(me: in out; T : in out Array1OfReal from TColStd; 
58                   S : Shape from GeomAbs)
59         ---Purpose: Stores in <T> the  parameters bounding the intervals
60         --          of continuity <S>.
61         --          
62         --          The array must provide  enough room to  accomodate
63         --          for the parameters. i.e. T.Length() > NbIntervals()
64     raises
65         OutOfRange from Standard 
66     is redefined static;  
67
68     Value(me; U : Real) returns Pnt from gp
69          --- Purpose : Computes the point of parameter U on the curve.
70     is redefined static;
71  
72     IsPeriodic(me) returns Boolean
73     is redefined static;
74     
75     Period(me) returns Real
76     raises
77         DomainError from Standard -- if the curve is not periodic
78     is redefined static;
79     
80     D0 (me; U : Real; P : out Pnt from gp)
81          --- Purpose : Computes the point of parameter U on the curve.
82     is redefined static;
83     
84     D1 (me; U : Real; P : out Pnt from gp ; V : out Vec from gp)
85          --- Purpose : Computes the point of parameter U on the curve with its
86          --  first derivative.
87      raises 
88         DomainError from Standard
89         --- Purpose : Raised if the continuity of the current interval
90         --  is not C1.
91     is redefined static;
92     
93     D2 (me; U : Real; P : out Pnt from gp; V1, V2 : out Vec from gp)
94         --- Purpose :
95         --  Returns the point P of parameter U, the first and second
96         --  derivatives V1 and V2.
97      raises 
98         DomainError from Standard
99         --- Purpose : Raised if the continuity of the current interval
100         --  is not C2.
101      is redefined static;
102  
103     Resolution(me; R3d : Real) returns Real
104          ---Purpose :  Returns the parametric  resolution corresponding
105          --         to the real space resolution <R3d>.
106     is redefined static;   
107
108     GetType(me) returns CurveType from GeomAbs
109         ---Purpose: Returns  the  type of the   curve  in the  current
110         --          interval :   Line,   Circle,   Ellipse, Hyperbola,
111         --          Parabola, BezierCurve, BSplineCurve, OtherCurve.
112     is redefined static;
113
114 fields 
115
116   myHCurve: HCurve  from  Adaptor3d;  
117   ratio   :  Real;
118   
119 end SnglrFunc;