0032137: Coding Rules - merge redundant .lxx files into header files within Package gp
[occt.git] / src / gp / gp_Elips.hxx
1 // Copyright (c) 1991-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _gp_Elips_HeaderFile
16 #define _gp_Elips_HeaderFile
17
18 #include <gp.hxx>
19 #include <gp_Ax1.hxx>
20 #include <gp_Ax2.hxx>
21 #include <gp_Pnt.hxx>
22 #include <Standard_ConstructionError.hxx>
23
24 //! Describes an ellipse in 3D space.
25 //! An ellipse is defined by its major and minor radii and
26 //! positioned in space with a coordinate system (a gp_Ax2 object) as follows:
27 //! -   the origin of the coordinate system is the center of the ellipse,
28 //! -   its "X Direction" defines the major axis of the ellipse, and
29 //! - its "Y Direction" defines the minor axis of the ellipse.
30 //! Together, the origin, "X Direction" and "Y Direction" of
31 //! this coordinate system define the plane of the ellipse.
32 //! This coordinate system is the "local coordinate system"
33 //! of the ellipse. In this coordinate system, the equation of
34 //! the ellipse is:
35 //! @code
36 //! X*X / (MajorRadius**2) + Y*Y / (MinorRadius**2) = 1.0
37 //! @endcode
38 //! The "main Direction" of the local coordinate system gives
39 //! the normal vector to the plane of the ellipse. This vector
40 //! gives an implicit orientation to the ellipse (definition of the
41 //! trigonometric sense). We refer to the "main Axis" of the
42 //! local coordinate system as the "Axis" of the ellipse.
43 //! See Also
44 //! gce_MakeElips which provides functions for more
45 //! complex ellipse constructions
46 //! Geom_Ellipse which provides additional functions for
47 //! constructing ellipses and works, in particular, with the
48 //! parametric equations of ellipses
49 class gp_Elips 
50 {
51 public:
52
53   DEFINE_STANDARD_ALLOC
54
55   //! Creates an indefinite ellipse.
56   gp_Elips()
57   : majorRadius (RealLast()),
58     minorRadius (RealSmall())
59   {}
60
61   //! The major radius of the ellipse is on the "XAxis" and the
62   //! minor radius is on the "YAxis" of the ellipse. The "XAxis"
63   //! is defined with the "XDirection" of theA2 and the "YAxis" is
64   //! defined with the "YDirection" of theA2.
65   //! Warnings :
66   //! It is not forbidden to create an ellipse with theMajorRadius =
67   //! theMinorRadius.
68   //! Raises ConstructionError if theMajorRadius < theMinorRadius or theMinorRadius < 0.
69   gp_Elips (const gp_Ax2& theA2, const Standard_Real theMajorRadius, const Standard_Real theMinorRadius)
70   : pos (theA2),
71     majorRadius (theMajorRadius),
72     minorRadius (theMinorRadius)
73   {
74     Standard_ConstructionError_Raise_if (theMinorRadius < 0.0 || theMajorRadius < theMinorRadius,
75       "gp_Elips() - invalid construction parameters");
76   }
77
78   //! Changes the axis normal to the plane of the ellipse.
79   //! It modifies the definition of this plane.
80   //! The "XAxis" and the "YAxis" are recomputed.
81   //! The local coordinate system is redefined so that:
82   //! -   its origin and "main Direction" become those of the
83   //! axis theA1 (the "X Direction" and "Y Direction" are then
84   //! recomputed in the same way as for any gp_Ax2), or
85   //! Raises ConstructionError if the direction of theA1
86   //! is parallel to the direction of the "XAxis" of the ellipse.
87   void SetAxis (const gp_Ax1& theA1) { pos.SetAxis (theA1); }
88
89   //! Modifies this ellipse, by redefining its local coordinate
90   //! so that its origin becomes theP.
91   void SetLocation (const gp_Pnt& theP) { pos.SetLocation (theP); }
92
93   //! The major radius of the ellipse is on the "XAxis" (major axis)
94   //! of the ellipse.
95   //! Raises ConstructionError if theMajorRadius < MinorRadius.
96   void SetMajorRadius (const Standard_Real theMajorRadius)
97   {
98     Standard_ConstructionError_Raise_if (theMajorRadius < minorRadius,
99        "gp_Elips::SetMajorRadius() - major radius should be greater or equal to minor radius");
100     majorRadius = theMajorRadius;
101   }
102
103   //! The minor radius of the ellipse is on the "YAxis" (minor axis)
104   //! of the ellipse.
105   //! Raises ConstructionError if theMinorRadius > MajorRadius or MinorRadius < 0.
106   void SetMinorRadius (const Standard_Real theMinorRadius)
107   {
108     Standard_ConstructionError_Raise_if (theMinorRadius < 0.0 || majorRadius < theMinorRadius,
109       "gp_Elips::SetMinorRadius() - minor radius should be a positive number lesser or equal to major radius");
110     minorRadius = theMinorRadius;
111   }
112
113   //! Modifies this ellipse, by redefining its local coordinate
114   //! so that it becomes theA2.
115   void SetPosition (const gp_Ax2& theA2) { pos = theA2; }
116
117   //! Computes the area of the Ellipse.
118   Standard_Real Area() const { return M_PI * majorRadius * minorRadius; }
119
120   //! Computes the axis normal to the plane of the ellipse.
121   const gp_Ax1& Axis() const { return pos.Axis(); }
122
123   //! Computes the first or second directrix of this ellipse.
124   //! These are the lines, in the plane of the ellipse, normal to
125   //! the major axis, at a distance equal to
126   //! MajorRadius/e from the center of the ellipse, where
127   //! e is the eccentricity of the ellipse.
128   //! The first directrix (Directrix1) is on the positive side of
129   //! the major axis. The second directrix (Directrix2) is on
130   //! the negative side.
131   //! The directrix is returned as an axis (gp_Ax1 object), the
132   //! origin of which is situated on the "X Axis" of the local
133   //! coordinate system of this ellipse.
134   //! Exceptions
135   //! Standard_ConstructionError if the eccentricity is null
136   //! (the ellipse has degenerated into a circle).
137   gp_Ax1 Directrix1() const;
138
139   //! This line is obtained by the symmetrical transformation
140   //! of "Directrix1" with respect to the "YAxis" of the ellipse.
141   //! Exceptions
142   //! Standard_ConstructionError if the eccentricity is null
143   //! (the ellipse has degenerated into a circle).
144   gp_Ax1 Directrix2() const;
145
146   //! Returns the eccentricity of the ellipse  between 0.0 and 1.0
147   //! If f is the distance between the center of the ellipse and
148   //! the Focus1 then the eccentricity e = f / MajorRadius.
149   //! Raises ConstructionError if MajorRadius = 0.0
150   Standard_Real Eccentricity() const;
151
152   //! Computes the focal distance. It is the distance between the
153   //! two focus focus1 and focus2 of the ellipse.
154   Standard_Real Focal() const
155   {
156     return 2.0 * sqrt (majorRadius * majorRadius - minorRadius * minorRadius);
157   }
158
159   //! Returns the first focus of the ellipse. This focus is on the
160   //! positive side of the "XAxis" of the ellipse.
161   gp_Pnt Focus1() const;
162
163   //! Returns the second focus of the ellipse. This focus is on the
164   //! negative side of the "XAxis" of the ellipse.
165   gp_Pnt Focus2() const;
166
167   //! Returns the center of the ellipse. It is the "Location"
168   //! point of the coordinate system of the ellipse.
169   const gp_Pnt& Location() const { return pos.Location(); }
170
171   //! Returns the major radius of the ellipse.
172   Standard_Real MajorRadius() const { return majorRadius; }
173
174   //! Returns the minor radius of the ellipse.
175   Standard_Real MinorRadius() const { return minorRadius; }
176
177   //! Returns p = (1 - e * e) * MajorRadius where e is the eccentricity
178   //! of the ellipse.
179   //! Returns 0 if MajorRadius = 0
180   Standard_Real Parameter() const;
181
182   //! Returns the coordinate system of the ellipse.
183   const gp_Ax2& Position() const { return pos; }
184
185   //! Returns the "XAxis" of the ellipse whose origin
186   //! is the center of this ellipse. It is the major axis of the
187   //! ellipse.
188   gp_Ax1 XAxis() const { return gp_Ax1 (pos.Location(), pos.XDirection()); }
189
190   //! Returns the "YAxis" of the ellipse whose unit vector is the "X Direction" or the "Y Direction"
191   //! of the local coordinate system of this ellipse.
192   //! This is the minor axis of the ellipse.
193   gp_Ax1 YAxis() const { return gp_Ax1 (pos.Location(), pos.YDirection()); }
194
195   Standard_EXPORT void Mirror (const gp_Pnt& theP);
196
197   //! Performs the symmetrical transformation of an ellipse with
198   //! respect to the point theP which is the center of the symmetry.
199   Standard_NODISCARD Standard_EXPORT gp_Elips Mirrored (const gp_Pnt& theP) const;
200
201   Standard_EXPORT void Mirror (const gp_Ax1& theA1);
202
203   //! Performs the symmetrical transformation of an ellipse with
204   //! respect to an axis placement which is the axis of the symmetry.
205   Standard_NODISCARD Standard_EXPORT gp_Elips Mirrored (const gp_Ax1& theA1) const;
206
207   Standard_EXPORT void Mirror (const gp_Ax2& theA2);
208
209   //! Performs the symmetrical transformation of an ellipse with
210   //! respect to a plane. The axis placement theA2 locates the plane
211   //! of the symmetry (Location, XDirection, YDirection).
212   Standard_NODISCARD Standard_EXPORT gp_Elips Mirrored (const gp_Ax2& theA2) const;
213
214   void Rotate (const gp_Ax1& theA1, const Standard_Real theAng) { pos.Rotate (theA1, theAng); }
215
216   //! Rotates an ellipse. theA1 is the axis of the rotation.
217   //! theAng is the angular value of the rotation in radians.
218   Standard_NODISCARD gp_Elips Rotated (const gp_Ax1& theA1, const Standard_Real theAng) const
219   {
220     gp_Elips anE = *this;
221     anE.pos.Rotate (theA1, theAng);
222     return anE;
223   }
224
225   void Scale (const gp_Pnt& theP, const Standard_Real theS);
226
227   //! Scales an ellipse. theS is the scaling value.
228   Standard_NODISCARD gp_Elips Scaled (const gp_Pnt& theP, const Standard_Real theS) const;
229
230   void Transform (const gp_Trsf& theT);
231
232   //! Transforms an ellipse with the transformation theT from class Trsf.
233   Standard_NODISCARD gp_Elips Transformed (const gp_Trsf& theT) const;
234
235   void Translate (const gp_Vec& theV) { pos.Translate (theV); }
236
237   //! Translates an ellipse in the direction of the vector theV.
238   //! The magnitude of the translation is the vector's magnitude.
239   Standard_NODISCARD gp_Elips Translated (const gp_Vec& theV) const
240   {
241     gp_Elips anE = *this;
242     anE.pos.Translate (theV);
243     return anE;
244   }
245
246   void Translate (const gp_Pnt& theP1, const gp_Pnt& theP2) { pos.Translate (theP1, theP2); }
247
248   //! Translates an ellipse from the point theP1 to the point theP2.
249   Standard_NODISCARD gp_Elips Translated (const gp_Pnt& theP1, const gp_Pnt& theP2) const
250   {
251     gp_Elips anE = *this;
252     anE.pos.Translate (theP1, theP2);
253     return anE;
254   }
255
256 private:
257
258   gp_Ax2 pos;
259   Standard_Real majorRadius;
260   Standard_Real minorRadius;
261
262 };
263
264 // =======================================================================
265 // function : Directrix1
266 // purpose  :
267 // =======================================================================
268 inline gp_Ax1 gp_Elips::Directrix1() const
269 {
270   Standard_Real anE = Eccentricity();
271   Standard_ConstructionError_Raise_if (anE <= gp::Resolution(), "gp_Elips::Directrix1() - zero eccentricity");
272   gp_XYZ anOrig = pos.XDirection().XYZ();
273   anOrig.Multiply (majorRadius / anE);
274   anOrig.Add (pos.Location().XYZ());
275   return gp_Ax1 (gp_Pnt (anOrig), pos.YDirection());
276 }
277
278 // =======================================================================
279 // function : Directrix2
280 // purpose  :
281 // =======================================================================
282 inline gp_Ax1 gp_Elips::Directrix2() const
283 {
284   Standard_Real anE = Eccentricity();
285   Standard_ConstructionError_Raise_if (anE <= gp::Resolution(), "gp_Elips::Directrix2() - zero eccentricity");
286   gp_XYZ anOrig = pos.XDirection().XYZ();
287   anOrig.Multiply (-majorRadius / anE);
288   anOrig.Add (pos.Location().XYZ());
289   return gp_Ax1 (gp_Pnt (anOrig), pos.YDirection());
290 }
291
292 // =======================================================================
293 // function : Eccentricity
294 // purpose  :
295 // =======================================================================
296 inline Standard_Real gp_Elips::Eccentricity() const
297 {
298   if (majorRadius == 0.0)
299   {
300     return 0.0;
301   }
302   else
303   {
304     return sqrt (majorRadius * majorRadius - minorRadius * minorRadius) / majorRadius;
305   }
306 }
307
308 // =======================================================================
309 // function : Focus1
310 // purpose  :
311 // =======================================================================
312 inline gp_Pnt gp_Elips::Focus1() const
313 {
314   Standard_Real aC = sqrt (majorRadius * majorRadius - minorRadius * minorRadius);
315   const gp_Pnt& aPP = pos.Location();
316   const gp_Dir& aDD = pos.XDirection();
317   return gp_Pnt (aPP.X() + aC * aDD.X(),
318                  aPP.Y() + aC * aDD.Y(),
319                  aPP.Z() + aC * aDD.Z());
320 }
321
322 // =======================================================================
323 // function : Focus2
324 // purpose  :
325 // =======================================================================
326 inline gp_Pnt gp_Elips::Focus2() const
327 {
328   Standard_Real aC = sqrt (majorRadius * majorRadius - minorRadius * minorRadius);
329   const gp_Pnt& aPP = pos.Location();
330   const gp_Dir& aDD = pos.XDirection();
331   return gp_Pnt (aPP.X() - aC * aDD.X(),
332                  aPP.Y() - aC * aDD.Y(),
333                  aPP.Z() - aC * aDD.Z());
334 }
335
336 // =======================================================================
337 // function : Parameter
338 // purpose  :
339 // =======================================================================
340 inline Standard_Real gp_Elips::Parameter() const
341 {
342   if (majorRadius == 0.0)
343   {
344     return 0.0;
345   }
346   else
347   {
348     return (minorRadius * minorRadius) / majorRadius;
349   }
350 }
351
352 // =======================================================================
353 // function : Scale
354 // purpose  :
355 // =======================================================================
356 inline void gp_Elips::Scale (const gp_Pnt& theP,
357                              const Standard_Real theS)
358   //  Modified by skv - Fri Apr  8 10:28:10 2005 OCC8559 Begin
359   // { pos.Scale(P, S); }
360 {
361   majorRadius *= theS;
362   if (majorRadius < 0)
363   {
364     majorRadius = -majorRadius;
365   }
366   minorRadius *= theS;
367   if (minorRadius < 0)
368   {
369     minorRadius = -minorRadius;
370   }
371   pos.Scale (theP, theS);
372 }
373 //  Modified by skv - Fri Apr  8 10:28:10 2005 OCC8559 End
374
375 // =======================================================================
376 // function : Scaled
377 // purpose  :
378 // =======================================================================
379 inline gp_Elips gp_Elips::Scaled (const gp_Pnt& theP,
380                                   const Standard_Real theS) const
381 {
382   gp_Elips anE = *this;
383   anE.majorRadius *= theS;
384   if (anE.majorRadius < 0)
385   {
386     anE.majorRadius = -anE.majorRadius;
387   }
388   anE.minorRadius *= theS;
389   if (anE.minorRadius < 0)
390   {
391     anE.minorRadius = -anE.minorRadius;
392   }
393   anE.pos.Scale (theP, theS);
394   return anE;
395 }
396
397 // =======================================================================
398 // function : Transform
399 // purpose  :
400 // =======================================================================
401 inline void gp_Elips::Transform (const gp_Trsf& theT)
402 {
403   majorRadius *= theT.ScaleFactor();
404   if (majorRadius < 0)
405   {
406     majorRadius = -majorRadius;
407   }
408   minorRadius *= theT.ScaleFactor();
409   if (minorRadius < 0)
410   {
411     minorRadius = -minorRadius;
412   }
413   pos.Transform (theT);
414 }
415
416 // =======================================================================
417 // function : Transformed
418 // purpose  :
419 // =======================================================================
420 inline gp_Elips gp_Elips::Transformed (const gp_Trsf& theT) const
421 {
422   gp_Elips anE = *this;
423   anE.majorRadius *= theT.ScaleFactor();
424   if (anE.majorRadius < 0)
425   {
426     anE.majorRadius = -anE.majorRadius;
427   }
428   anE.minorRadius *= theT.ScaleFactor();
429   if (anE.minorRadius < 0)
430   {
431     anE.minorRadius = -anE.minorRadius;
432   }
433   anE.pos.Transform (theT);
434   return anE;
435 }
436
437 #endif // _gp_Elips_HeaderFile