summaryrefslogtreecommitdiff
path: root/inc/GeomAPI_ExtremaSurfaceSurface.hxx
blob: cd316515410bea9a5f9f50774720525a9c4a5863 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _GeomAPI_ExtremaSurfaceSurface_HeaderFile
#define _GeomAPI_ExtremaSurfaceSurface_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Extrema_ExtSS_HeaderFile
#include <Extrema_ExtSS.hxx>
#endif
#ifndef _Handle_Geom_Surface_HeaderFile
#include <Handle_Geom_Surface.hxx>
#endif
#ifndef _Quantity_Parameter_HeaderFile
#include <Quantity_Parameter.hxx>
#endif
#ifndef _Quantity_Length_HeaderFile
#include <Quantity_Length.hxx>
#endif
class Standard_OutOfRange;
class StdFail_NotDone;
class Geom_Surface;
class gp_Pnt;
class Extrema_ExtSS;


//! Describes functions for computing all the extrema <br>
//! between two surfaces. <br>
//! An ExtremaSurfaceSurface algorithm minimizes or <br>
//! maximizes the distance between a point on the first <br>
//! surface and a point on the second surface. Results <br>
//! are start and end points of perpendiculars common to the two surfaces. <br>
//! Solutions consist of pairs of points, and an extremum <br>
//! is considered to be a segment joining the two points of a solution. <br>
//! An ExtremaSurfaceSurface object provides a framework for: <br>
//! -   defining the construction of the extrema, <br>
//! -   implementing the construction algorithm, and <br>
//! -   consulting the results. <br>
//! Warning <br>
//! In some cases, the nearest points between the two <br>
//! surfaces do not correspond to one of the computed <br>
//! extrema. Instead, they may be given by: <br>
//! -   a point of a bounding curve of one surface and one of the following: <br>
//!   -   its orthogonal projection on the other surface, <br>
//!   -   a point of a bounding curve of the other surface; or <br>
//! -   any point on intersection curves between the two surfaces. <br>
class GeomAPI_ExtremaSurfaceSurface  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Constructs an empty algorithm for computing <br>
//! extrema between two surfaces. Use an Init function <br>
//! to define the surfaces on which it is going to work. <br>
  Standard_EXPORT   GeomAPI_ExtremaSurfaceSurface();
  //! Computes  the  extrema  distances  between  the <br>
//!          surfaces <S1>  and <S2> <br>
  Standard_EXPORT   GeomAPI_ExtremaSurfaceSurface(const Handle(Geom_Surface)& S1,const Handle(Geom_Surface)& S2);
  //! Computes  the  extrema  distances  between <br>
//!   the portion of the surface S1 limited by the <br>
//!  two values of parameter (U1min,U1max) in <br>
//!    the u parametric direction, and by the two <br>
//!    values of parameter (V1min,V1max) in the v <br>
//!    parametric direction, and <br>
//!   -   the portion of the surface S2 limited by the <br>
//!    two values of parameter (U2min,U2max) in <br>
//!    the u parametric direction, and by the two <br>
//!    values of parameter (V2min,V2max) in the v <br>
//!    parametric direction. <br>
  Standard_EXPORT   GeomAPI_ExtremaSurfaceSurface(const Handle(Geom_Surface)& S1,const Handle(Geom_Surface)& S2,const Quantity_Parameter U1min,const Quantity_Parameter U1max,const Quantity_Parameter V1min,const Quantity_Parameter V1max,const Quantity_Parameter U2min,const Quantity_Parameter U2max,const Quantity_Parameter V2min,const Quantity_Parameter V2max);
  //! Initializes this algorithm with the given arguments <br>
//!        and computes  the  extrema  distances  between  the <br>
//!          surfaces <S1>  and <S2> <br>
  Standard_EXPORT     void Init(const Handle(Geom_Surface)& S1,const Handle(Geom_Surface)& S2) ;
  //! Initializes this algorithm with the given arguments <br>
//!        and computes  the  extrema  distances  between - <br>
//! the portion of the surface S1 limited by the two <br>
//!    values of parameter (U1min,U1max) in the u <br>
//!    parametric direction, and by the two values of <br>
//!    parameter (V1min,V1max) in the v parametric direction, and <br>
//!   -   the portion of the surface S2 limited by the two <br>
//!    values of parameter (U2min,U2max) in the u <br>
//!    parametric direction, and by the two values of <br>
//!    parameter (V2min,V2max) in the v parametric direction. <br>
  Standard_EXPORT     void Init(const Handle(Geom_Surface)& S1,const Handle(Geom_Surface)& S2,const Quantity_Parameter U1min,const Quantity_Parameter U1max,const Quantity_Parameter V1min,const Quantity_Parameter V1max,const Quantity_Parameter U2min,const Quantity_Parameter U2max,const Quantity_Parameter V2min,const Quantity_Parameter V2max) ;
  //! Returns the number of extrema computed by this algorithm. <br>
//! Note: if this algorithm fails, NbExtrema returns 0. <br>
  Standard_EXPORT     Standard_Integer NbExtrema() const;
Standard_EXPORT operator Standard_Integer() const;
  //! Returns the points P1 on the first surface and P2 on <br>
//! the second surface, which are the ends of the <br>
//! extremum of index Index computed by this algorithm. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ <br>
//! 1,NbExtrema ], where NbExtrema is the <br>
//! number of extrema computed by this algorithm. <br>
  Standard_EXPORT     void Points(const Standard_Integer Index,gp_Pnt& P1,gp_Pnt& P2) const;
  //! Returns the parameters (U1,V1) of the point on the <br>
//! first surface, and (U2,V2) of the point on the second <br>
//! surface, which are the ends of the extremum of index <br>
//! Index computed by this algorithm. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ <br>
//! 1,NbExtrema ], where NbExtrema is the <br>
//! number of extrema computed by this algorithm. <br>
  Standard_EXPORT     void Parameters(const Standard_Integer Index,Quantity_Parameter& U1,Quantity_Parameter& V1,Quantity_Parameter& U2,Quantity_Parameter& V2) const;
  //! Computes the distance between the end points of the <br>
//! extremum of index Index computed by this algorithm. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ <br>
//! 1,NbExtrema ], where NbExtrema is the <br>
//! number of extrema computed by this algorithm. <br>
  Standard_EXPORT     Quantity_Length Distance(const Standard_Integer Index) const;
  //! Returns the points P1 on the first surface and P2 on <br>
//! the second surface, which are the ends of the <br>
//! shortest extremum computed by this algorithm. <br>
//! Exceptions StdFail_NotDone if this algorithm fails. <br>
  Standard_EXPORT     void NearestPoints(gp_Pnt& P1,gp_Pnt& P2) const;
  //! Returns the parameters (U1,V1) of the point on the <br>
//! first surface and (U2,V2) of the point on the second <br>
//! surface, which are the ends of the shortest extremum <br>
//! computed by this algorithm. <br>
//! Exceptions - StdFail_NotDone if this algorithm fails. <br>
  Standard_EXPORT     void LowerDistanceParameters(Quantity_Parameter& U1,Quantity_Parameter& V1,Quantity_Parameter& U2,Quantity_Parameter& V2) const;
  //! Computes the distance between the end points of the <br>
//! shortest extremum computed by this algorithm. <br>
//! Exceptions StdFail_NotDone if this algorithm fails. <br>
  Standard_EXPORT     Quantity_Length LowerDistance() const;
Standard_EXPORT operator Standard_Real() const;
  //! return the algorithmic object from Extrema <br>
       const Extrema_ExtSS& Extrema() const;





protected:





private:



Standard_Boolean myIsDone;
Standard_Integer myIndex;
Extrema_ExtSS myExtSS;


};


#include <GeomAPI_ExtremaSurfaceSurface.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif