36a4724980f043129bdde3669cb8977595af87b4
[occt.git] / src / BRepBlend / BRepBlend_BlendTool.cdl
1 -- Created on: 1993-12-06
2 -- Created by: Jacques GOUSSARD
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 class BlendTool from BRepBlend
23
24         ---Purpose: 
25
26 uses 
27      Pnt2d     from gp,
28      State     from TopAbs,
29      HCurve2d from Adaptor2d,
30      HSurface from Adaptor3d,
31      HVertex from Adaptor3d
32
33 is
34
35     Project(myclass; P: Pnt2d from gp;
36                      S: HSurface from Adaptor3d ;
37                      C: HCurve2d from Adaptor2d ;
38                      Paramproj: out Real from Standard;
39                      Dist: out Real from Standard)
40
41         ---Purpose: Projects the point P on the arc C.
42         --          If the methods returns Standard_True, the projection is
43         --          successful, and Paramproj is the parameter on the arc
44         --          of the projected point, Dist is the distance between
45         --          P and the curve..
46         --          If the method returns Standard_False, Param proj and Dist
47         --          are not significant.
48         --          
49
50         returns Boolean from Standard;
51
52     Inters (myclass; P1,P2: Pnt2d from gp;
53                      S: HSurface from Adaptor3d ;
54                      C: HCurve2d from Adaptor2d ;
55                      Param: out Real from Standard;
56                      Dist: out Real from Standard)
57         returns Boolean from Standard;
58
59     Parameter(myclass; V: HVertex from Adaptor3d; A: HCurve2d from Adaptor2d )
60     
61         ---Purpose: Returns the parameter of the vertex V on the edge A.
62     
63         ---C++: inline
64         returns Real from Standard;
65
66
67     Tolerance(myclass; V: HVertex from Adaptor3d; A: HCurve2d from Adaptor2d )
68
69         ---Purpose: Returns the parametric tolerance on the arc A
70         --          used to consider that the vertex and another point meet,
71         --          i-e if Abs(Parameter(Vertex)-Parameter(OtherPnt))<=
72         --          Tolerance, the points are "merged".
73
74         ---C++: inline
75         returns Real from Standard;
76
77
78 -- Methodes pour Rayon constant, en plus des 2 precedentes
79
80
81     SingularOnUMin(myclass; S:HSurface from Adaptor3d )
82         returns Boolean from Standard;
83         ---C++: inline
84
85     SingularOnUMax(myclass; S:HSurface from Adaptor3d ) 
86         returns Boolean from Standard;
87         ---C++: inline
88
89     SingularOnVMin(myclass; S:HSurface from Adaptor3d )
90         returns Boolean from Standard;
91         ---C++: inline
92
93     SingularOnVMax(myclass; S:HSurface from Adaptor3d )
94         returns Boolean from Standard;
95         ---C++: inline
96
97     NbSamplesU(myclass; S: HSurface from Adaptor3d ;
98                         u1,u2: Real from Standard)
99         returns Integer from Standard;
100
101     NbSamplesV(myclass; S: HSurface from Adaptor3d ;
102                         v1,v2: Real from Standard)
103         returns Integer from Standard;
104
105
106     Bounds(myclass; C: HCurve2d from Adaptor2d ; 
107                     Ufirst,Ulast: out Real from Standard);
108
109         ---Purpose: Returns the parametric limits on the arc C.
110         --          These limits must be finite : they are either
111         --          the real limits of the arc, for a finite arc,
112         --          or a bounding box for an infinite arc.
113
114
115     CurveOnSurf(myclass; C: HCurve2d from Adaptor2d ; S: HSurface from Adaptor3d )
116         ---C++: inline
117         returns HCurve2d from Adaptor2d ;
118
119
120 end BlendTool;