summaryrefslogtreecommitdiff
path: root/inc/GeomAPI_ProjectPointOnCurve.hxx
blob: 70a42bdf625546f7ebcf420e0d0c0037cfe2152f (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
// 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_ProjectPointOnCurve_HeaderFile
#define _GeomAPI_ProjectPointOnCurve_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_ExtPC_HeaderFile
#include <Extrema_ExtPC.hxx>
#endif
#ifndef _GeomAdaptor_Curve_HeaderFile
#include <GeomAdaptor_Curve.hxx>
#endif
#ifndef _Handle_Geom_Curve_HeaderFile
#include <Handle_Geom_Curve.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 gp_Pnt;
class Geom_Curve;
class Extrema_ExtPC;



//! This class implements methods for  computing all the orthogonal <br>
//!  projections of a 3D point onto a  3D curve. <br>
class GeomAPI_ProjectPointOnCurve  {
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); 
  }

  //! Creates an empty object. Use an <br>
//! Init function for further initialization. <br>
  Standard_EXPORT   GeomAPI_ProjectPointOnCurve();
  //! Create the projection  of a  point  <P> on a curve <br>
//!          <Curve> <br>
  Standard_EXPORT   GeomAPI_ProjectPointOnCurve(const gp_Pnt& P,const Handle(Geom_Curve)& Curve);
  //! Create  the projection  of a point <P>  on a curve <br>
//!          <Curve> limited by the two points of parameter Umin and Usup. <br>
  Standard_EXPORT   GeomAPI_ProjectPointOnCurve(const gp_Pnt& P,const Handle(Geom_Curve)& Curve,const Quantity_Parameter Umin,const Quantity_Parameter Usup);
  //! Init the projection  of a  point  <P> on a curve <br>
//!          <Curve> <br>
  Standard_EXPORT     void Init(const gp_Pnt& P,const Handle(Geom_Curve)& Curve) ;
  //! Init  the  projection  of a  point <P>  on a curve <br>
//!          <Curve> limited by the two points of parameter Umin and Usup. <br>
  Standard_EXPORT     void Init(const gp_Pnt& P,const Handle(Geom_Curve)& Curve,const Quantity_Parameter Umin,const Quantity_Parameter Usup) ;
  //! Init  the  projection  of a  point <P>  on a curve <br>
//!          <Curve> limited by the two points of parameter Umin and Usup. <br>
  Standard_EXPORT     void Init(const Handle(Geom_Curve)& Curve,const Quantity_Parameter Umin,const Quantity_Parameter Usup) ;
  //! Performs the projection of a point on the current curve. <br>
  Standard_EXPORT     void Perform(const gp_Pnt& P) ;
  //! Returns the number of computed <br>
//! orthogonal projection points. <br>
//! Note: if this algorithm fails, NbPoints returns 0. <br>
  Standard_EXPORT     Standard_Integer NbPoints() const;
Standard_EXPORT operator Standard_Integer() const;
  //! Returns the orthogonal projection <br>
//! on the curve. Index is a number of a computed point. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where <br>
//! NbPoints is the number of solution points. <br>
  Standard_EXPORT     gp_Pnt Point(const Standard_Integer Index) const;
  //! Returns the parameter on the curve <br>
//! of the point, which is the orthogonal projection. Index is a <br>
//! number of a computed point. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where <br>
//! NbPoints is the number of solution points. <br>
  Standard_EXPORT     Quantity_Parameter Parameter(const Standard_Integer Index) const;
  //! Returns the parameter on the curve <br>
//! of the point, which is the orthogonal projection. Index is a <br>
//! number of a computed point. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where <br>
//! NbPoints is the number of solution points.- <br>
  Standard_EXPORT     void Parameter(const Standard_Integer Index,Quantity_Parameter& U) const;
  //! Computes the distance between the <br>
//! point and its orthogonal projection on the curve. Index is a number of a computed point. <br>
//! Exceptions <br>
//! Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where <br>
//! NbPoints is the number of solution points. <br>
  Standard_EXPORT     Quantity_Length Distance(const Standard_Integer Index) const;
  //! Returns the nearest orthogonal <br>
//! projection of the point on the curve. <br>
//! Exceptions: StdFail_NotDone if this algorithm fails. <br>
  Standard_EXPORT     gp_Pnt NearestPoint() const;
Standard_EXPORT operator gp_Pnt() const;
  //! Returns the parameter on the curve <br>
//! of the nearest orthogonal projection of the point. <br>
//! Exceptions: StdFail_NotDone if this algorithm fails. <br>
  Standard_EXPORT     Quantity_Parameter LowerDistanceParameter() const;
  //! Computes the distance between the <br>
//! point and its nearest orthogonal projection on the curve. <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_ExtPC& Extrema() const;





protected:





private:



Standard_Boolean myIsDone;
Standard_Integer myIndex;
Extrema_ExtPC myExtPC;
GeomAdaptor_Curve myC;


};


#include <GeomAPI_ProjectPointOnCurve.lxx>



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


#endif