0032137: Coding Rules - merge redundant .lxx files into header files within Package gp
[occt.git] / src / gp / gp_Dir2d.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_Dir2d_HeaderFile
16 #define _gp_Dir2d_HeaderFile
17
18 #include <gp_XY.hxx>
19 #include <Standard_ConstructionError.hxx>
20 #include <Standard_DomainError.hxx>
21 #include <Standard_OutOfRange.hxx>
22
23 class gp_Vec2d;
24 class gp_XY;
25 class gp_Ax2d;
26 class gp_Trsf2d;
27
28 //! Describes a unit vector in the plane (2D space). This unit
29 //! vector is also called "Direction".
30 //! See Also
31 //! gce_MakeDir2d which provides functions for more
32 //! complex unit vector constructions
33 //! Geom2d_Direction which provides additional functions
34 //! for constructing unit vectors and works, in particular, with
35 //! the parametric equations of unit vectors
36 class gp_Dir2d 
37 {
38 public:
39
40   DEFINE_STANDARD_ALLOC
41
42   //! Creates a direction corresponding to X axis.
43   gp_Dir2d()
44   : coord (1., 0.)
45   {}
46
47   //! Normalizes the vector theV and creates a Direction. Raises ConstructionError if theV.Magnitude() <= Resolution from gp.
48   gp_Dir2d (const gp_Vec2d& theV);
49
50   //! Creates a Direction from a doublet of coordinates. Raises ConstructionError if theCoord.Modulus() <= Resolution from gp.
51   gp_Dir2d (const gp_XY& theCoord);
52
53   //! Creates a Direction with its 2 cartesian coordinates. Raises ConstructionError if Sqrt(theXv*theXv + theYv*theYv) <= Resolution from gp.
54   gp_Dir2d (const Standard_Real theXv, const Standard_Real theYv);
55
56   //! For this unit vector, assigns:
57   //! the value theXi to:
58   //! -   the X coordinate if theIndex is 1, or
59   //! -   the Y coordinate if theIndex is 2, and then normalizes it.
60   //! Warning
61   //! Remember that all the coordinates of a unit vector are
62   //! implicitly modified when any single one is changed directly.
63   //! Exceptions
64   //! Standard_OutOfRange if theIndex is not 1 or 2.
65   //! Standard_ConstructionError if either of the following
66   //! is less than or equal to gp::Resolution():
67   //! -   Sqrt(theXv*theXv + theYv*theYv), or
68   //! -   the modulus of the number pair formed by the new
69   //! value theXi and the other coordinate of this vector that
70   //! was not directly modified.
71   //! Raises OutOfRange if theIndex != {1, 2}.
72   void SetCoord (const Standard_Integer theIndex, const Standard_Real theXi);
73
74   //! For this unit vector, assigns:
75   //! -   the values theXv and theYv to its two coordinates,
76   //! Warning
77   //! Remember that all the coordinates of a unit vector are
78   //! implicitly modified when any single one is changed directly.
79   //! Exceptions
80   //! Standard_OutOfRange if theIndex is not 1 or 2.
81   //! Standard_ConstructionError if either of the following
82   //! is less than or equal to gp::Resolution():
83   //! -   Sqrt(theXv*theXv + theYv*theYv), or
84   //! -   the modulus of the number pair formed by the new
85   //! value Xi and the other coordinate of this vector that
86   //! was not directly modified.
87   //! Raises OutOfRange if theIndex != {1, 2}.
88   void SetCoord (const Standard_Real theXv, const Standard_Real theYv);
89
90   //! Assigns the given value to the X coordinate of this unit   vector,
91   //! and then normalizes it.
92   //! Warning
93   //! Remember that all the coordinates of a unit vector are
94   //! implicitly modified when any single one is changed directly.
95   //! Exceptions
96   //! Standard_ConstructionError if either of the following
97   //! is less than or equal to gp::Resolution():
98   //! -   the modulus of Coord, or
99   //! -   the modulus of the number pair formed from the new
100   //! X or Y coordinate and the other coordinate of this
101   //! vector that was not directly modified.
102   void SetX (const Standard_Real theX);
103
104   //! Assigns  the given value to the Y coordinate of this unit   vector,
105   //! and then normalizes it.
106   //! Warning
107   //! Remember that all the coordinates of a unit vector are
108   //! implicitly modified when any single one is changed directly.
109   //! Exceptions
110   //! Standard_ConstructionError if either of the following
111   //! is less than or equal to gp::Resolution():
112   //! -   the modulus of Coord, or
113   //! -   the modulus of the number pair formed from the new
114   //! X or Y coordinate and the other coordinate of this
115   //! vector that was not directly modified.
116   void SetY (const Standard_Real theY);
117
118   //! Assigns:
119   //! -   the two coordinates of theCoord to this unit vector,
120   //! and then normalizes it.
121   //! Warning
122   //! Remember that all the coordinates of a unit vector are
123   //! implicitly modified when any single one is changed directly.
124   //! Exceptions
125   //! Standard_ConstructionError if either of the following
126   //! is less than or equal to gp::Resolution():
127   //! -   the modulus of theCoord, or
128   //! -   the modulus of the number pair formed from the new
129   //! X or Y coordinate and the other coordinate of this
130   //! vector that was not directly modified.
131   void SetXY (const gp_XY& theCoord);
132
133   //! For this unit vector returns the coordinate of range theIndex :
134   //! theIndex = 1 => X is returned
135   //! theIndex = 2 => Y is returned
136   //! Raises OutOfRange if theIndex != {1, 2}.
137   Standard_Real Coord (const Standard_Integer theIndex) const  { return coord.Coord (theIndex); }
138
139   //! For this unit vector returns its two coordinates theXv and theYv.
140   //! Raises OutOfRange if theIndex != {1, 2}.
141   void Coord (Standard_Real& theXv, Standard_Real& theYv) const  { coord.Coord (theXv, theYv); }
142
143   //! For this unit vector, returns its X coordinate.
144   Standard_Real X() const { return coord.X(); }
145
146   //! For this unit vector, returns its Y coordinate.
147   Standard_Real Y() const { return coord.Y(); }
148
149   //! For this unit vector, returns its two coordinates as a number pair.
150   //! Comparison between Directions
151   //! The precision value is an input data.
152   const gp_XY& XY() const { return coord; }
153
154   //! Returns True if the two vectors have the same direction
155   //! i.e. the angle between this unit vector and the
156   //! unit vector theOther is less than or equal to theAngularTolerance.
157   Standard_Boolean IsEqual (const gp_Dir2d& theOther, const Standard_Real theAngularTolerance) const;
158
159   //! Returns True if the angle between this unit vector and the
160   //! unit vector theOther is equal to Pi/2 or -Pi/2 (normal)
161   //! i.e. Abs(Abs(<me>.Angle(theOther)) - PI/2.) <= theAngularTolerance
162   Standard_Boolean IsNormal (const gp_Dir2d& theOther, const Standard_Real theAngularTolerance) const;
163
164   //! Returns True if the angle between this unit vector and the
165   //! unit vector theOther is equal to Pi or -Pi (opposite).
166   //! i.e.  PI - Abs(<me>.Angle(theOther)) <= theAngularTolerance
167   Standard_Boolean IsOpposite (const gp_Dir2d& theOther, const Standard_Real theAngularTolerance) const;
168
169   //! returns true if the angle between this unit vector and unit
170   //! vector theOther is equal to 0, Pi or -Pi.
171   //! i.e.  Abs(Angle(<me>, theOther)) <= theAngularTolerance or
172   //! PI - Abs(Angle(<me>, theOther)) <= theAngularTolerance
173   Standard_Boolean IsParallel (const gp_Dir2d& theOther, const Standard_Real theAngularTolerance) const;
174
175   //! Computes the angular value in radians between <me> and
176   //! <theOther>. Returns the angle in the range [-PI, PI].
177   Standard_EXPORT Standard_Real Angle (const gp_Dir2d& theOther) const;
178
179   //! Computes the cross product between two directions.
180   Standard_NODISCARD Standard_Real Crossed (const gp_Dir2d& theRight) const { return coord.Crossed (theRight.coord); }
181
182   Standard_NODISCARD Standard_Real operator ^ (const gp_Dir2d& theRight) const { return Crossed (theRight); }
183
184   //! Computes the scalar product
185   Standard_Real Dot (const gp_Dir2d& theOther) const { return coord.Dot (theOther.coord); }
186
187   Standard_Real operator * (const gp_Dir2d& theOther) const { return Dot (theOther); }
188
189   void Reverse() { coord.Reverse(); }
190
191   //! Reverses the orientation of a direction
192   Standard_NODISCARD gp_Dir2d Reversed() const
193   {
194     gp_Dir2d aV = *this;
195     aV.coord.Reverse();
196     return aV;
197   }
198
199   Standard_NODISCARD gp_Dir2d operator -() const { return Reversed(); }
200
201   Standard_EXPORT void Mirror (const gp_Dir2d& theV);
202
203   //! Performs the symmetrical transformation of a direction
204   //! with respect to the direction theV which is the center of
205   //! the  symmetry.
206   Standard_NODISCARD Standard_EXPORT gp_Dir2d Mirrored (const gp_Dir2d& theV) const;
207
208   Standard_EXPORT void Mirror (const gp_Ax2d& theA);
209
210   //! Performs the symmetrical transformation of a direction
211   //! with respect to an axis placement which is the axis
212   //! of the symmetry.
213   Standard_NODISCARD Standard_EXPORT gp_Dir2d Mirrored (const gp_Ax2d& theA) const;
214
215   void Rotate (const Standard_Real Ang);
216
217   //! Rotates a direction.  theAng is the angular value of
218   //! the rotation in radians.
219   Standard_NODISCARD gp_Dir2d Rotated (const Standard_Real theAng) const
220   {
221     gp_Dir2d aV = *this;
222     aV.Rotate (theAng);
223     return aV;
224   }
225
226   Standard_EXPORT void Transform (const gp_Trsf2d& theT);
227
228   //! Transforms a direction with the "Trsf" theT.
229   //! Warnings :
230   //! If the scale factor of the "Trsf" theT is negative then the
231   //! direction <me> is reversed.
232   Standard_NODISCARD gp_Dir2d Transformed (const gp_Trsf2d& theT) const
233   {
234     gp_Dir2d aV = *this;
235     aV.Transform (theT);
236     return aV;
237   }
238
239   //! Dumps the content of me into the stream
240   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
241
242 private:
243
244   gp_XY coord;
245
246 };
247
248 #include <gp_Ax2d.hxx>
249 #include <gp_Trsf2d.hxx>
250
251 // =======================================================================
252 // function : gp_Dir2d
253 // purpose  :
254 // =======================================================================
255 inline gp_Dir2d::gp_Dir2d (const gp_Vec2d& theV)
256 {
257   const gp_XY& aXY = theV.XY();
258   Standard_Real aX = aXY.X();
259   Standard_Real anY = aXY.Y();
260   Standard_Real aD = sqrt (aX * aX + anY * anY);
261   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d() - input vector has zero norm");
262   coord.SetX (aX / aD);
263   coord.SetY (anY / aD);
264 }
265
266 // =======================================================================
267 // function : gp_Dir2d
268 // purpose  :
269 // =======================================================================
270 inline gp_Dir2d::gp_Dir2d (const gp_XY& theXY)
271 {
272   Standard_Real aX = theXY.X();
273   Standard_Real anY = theXY.Y();
274   Standard_Real aD = sqrt (aX * aX + anY * anY);
275   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d() - input vector has zero norm");
276   coord.SetX (aX / aD);
277   coord.SetY (anY / aD);
278 }
279
280 // =======================================================================
281 // function : gp_Dir2d
282 // purpose  :
283 // =======================================================================
284 inline gp_Dir2d::gp_Dir2d (const Standard_Real theXv,
285                            const Standard_Real theYv)
286 {
287   Standard_Real aD = sqrt (theXv * theXv + theYv * theYv);
288   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d() - input vector has zero norm");
289   coord.SetX (theXv / aD);
290   coord.SetY (theYv / aD);
291 }
292
293 // =======================================================================
294 // function : SetCoord
295 // purpose  :
296 // =======================================================================
297 inline void gp_Dir2d::SetCoord (const Standard_Integer theIndex,
298                                 const Standard_Real theXi)
299 {
300   Standard_Real aX = coord.X();
301   Standard_Real anY = coord.Y();
302   Standard_OutOfRange_Raise_if (theIndex < 1 || theIndex > 2, "gp_Dir2d::SetCoord() - index is out of range [1, 2]");
303   if (theIndex == 1)
304   {
305     aX = theXi;
306   }
307   else
308   {
309     anY = theXi;
310   }
311   Standard_Real aD = sqrt (aX * aX + anY * anY);
312   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d::SetCoord() - result vector has zero norm");
313   coord.SetX (aX / aD);
314   coord.SetY (anY / aD);
315 }
316
317 // =======================================================================
318 // function : SetCoord
319 // purpose  :
320 // =======================================================================
321 inline void gp_Dir2d::SetCoord (const Standard_Real theXv,
322                                 const Standard_Real theYv)
323 {
324   Standard_Real aD = sqrt (theXv * theXv + theYv * theYv);
325   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d::SetCoord() - result vector has zero norm");
326   coord.SetX (theXv / aD);
327   coord.SetY (theYv / aD);
328 }
329
330 // =======================================================================
331 // function : SetX
332 // purpose  :
333 // =======================================================================
334 inline void gp_Dir2d::SetX (const Standard_Real theX)
335 {
336   Standard_Real anY = coord.Y();
337   Standard_Real aD = sqrt (theX * theX + anY * anY);
338   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d::SetX() - result vector has zero norm");
339   coord.SetX (theX / aD);
340   coord.SetY (anY / aD);
341 }
342
343 // =======================================================================
344 // function : SetY
345 // purpose  :
346 // =======================================================================
347 inline void gp_Dir2d::SetY (const Standard_Real theY)
348 {
349   Standard_Real aX = coord.X();
350   Standard_Real aD = sqrt (aX * aX + theY * theY);
351   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d::SetY() - result vector has zero norm");
352   coord.SetX (aX / aD);
353   coord.SetY (theY / aD);
354 }
355
356 // =======================================================================
357 // function : SetXY
358 // purpose  :
359 // =======================================================================
360 inline void gp_Dir2d::SetXY (const gp_XY& theXY)
361 {
362   Standard_Real aX = theXY.X();
363   Standard_Real anY = theXY.Y();
364   Standard_Real aD = sqrt (aX * aX + anY * anY);
365   Standard_ConstructionError_Raise_if (aD <= gp::Resolution(), "gp_Dir2d::SetZ() - result vector has zero norm");
366   coord.SetX (aX / aD);
367   coord.SetY (anY / aD);
368 }
369
370 // =======================================================================
371 // function : IsEqual
372 // purpose  :
373 // =======================================================================
374 inline Standard_Boolean gp_Dir2d::IsEqual (const gp_Dir2d& theOther,
375                                            const Standard_Real theAngularTolerance) const
376 {
377   Standard_Real anAng = Angle (theOther);
378   if (anAng < 0)
379   {
380     anAng = -anAng;
381   }
382   return anAng <= theAngularTolerance;
383 }
384
385 // =======================================================================
386 // function : IsNormal
387 // purpose  :
388 // =======================================================================
389 inline Standard_Boolean gp_Dir2d::IsNormal (const gp_Dir2d& theOther,
390                                             const Standard_Real theAngularTolerance) const
391 {
392   Standard_Real anAng = Angle (theOther);
393   if (anAng < 0)
394   {
395     anAng = -anAng;
396   }
397   anAng = M_PI / 2.0 - anAng;
398   if (anAng < 0)
399   {
400     anAng = -anAng;
401   }
402   return anAng <= theAngularTolerance;
403 }
404
405 // =======================================================================
406 // function : IsOpposite
407 // purpose  :
408 // =======================================================================
409 inline Standard_Boolean gp_Dir2d::IsOpposite (const gp_Dir2d& theOther,
410                                               const Standard_Real theAngularTolerance) const
411
412   Standard_Real anAng = Angle (theOther);
413   if (anAng < 0)
414   {
415     anAng = -anAng;
416   }
417   return M_PI - anAng <= theAngularTolerance;
418 }
419
420 // =======================================================================
421 // function : IsParallel
422 // purpose  :
423 // =======================================================================
424 inline Standard_Boolean gp_Dir2d::IsParallel (const gp_Dir2d& theOther,
425                                               const Standard_Real theAngularTolerance) const
426 {
427   Standard_Real anAng = Angle (theOther);
428   if (anAng < 0)
429   {
430     anAng = -anAng;
431   }
432   return anAng <= theAngularTolerance || M_PI - anAng <= theAngularTolerance;
433 }
434
435 // =======================================================================
436 // function : Rotate
437 // purpose  :
438 // =======================================================================
439 inline void gp_Dir2d::Rotate (const Standard_Real theAng)
440 {
441   gp_Trsf2d aT;
442   aT.SetRotation (gp_Pnt2d (0.0, 0.0), theAng);
443   coord.Multiply (aT.HVectorialPart());
444 }
445
446 #endif // _gp_Dir2d_HeaderFile