0032137: Coding Rules - merge redundant .lxx files into header files within Package gp
[occt.git] / src / gp / gp_Cone.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_Cone_HeaderFile
16 #define _gp_Cone_HeaderFile
17
18 #include <gp_Ax1.hxx>
19 #include <gp_Ax3.hxx>
20 #include <gp_Pnt.hxx>
21
22 //! Defines an infinite conical surface.
23 //! A cone is defined by its half-angle (can be negative) at the apex and
24 //! positioned in space with a coordinate system (a gp_Ax3
25 //! object) and a "reference radius" where:
26 //! -   the "main Axis" of the coordinate system is the axis of   revolution of the cone,
27 //! -   the plane defined by the origin, the "X Direction" and
28 //! the "Y Direction" of the coordinate system is the
29 //! reference plane of the cone; the intersection of the
30 //! cone with this reference plane is a circle of radius
31 //! equal to the reference radius,
32 //! if the half-angle is positive, the apex of the cone is on
33 //! the negative side of the "main Axis" of the coordinate
34 //! system. If the half-angle is negative, the apex is on the   positive side.
35 //! This coordinate system is the "local coordinate system" of the cone.
36 //! Note: when a gp_Cone cone is converted into a
37 //! Geom_ConicalSurface cone, some implicit properties of
38 //! its local coordinate system are used explicitly:
39 //! -   its origin, "X Direction", "Y Direction" and "main
40 //! Direction" are used directly to define the parametric
41 //! directions on the cone and the origin of the parameters,
42 //! -   its implicit orientation (right-handed or left-handed)
43 //! gives the orientation (direct or indirect) of the
44 //! Geom_ConicalSurface cone.
45 //! See Also
46 //! gce_MakeCone which provides functions for more
47 //! complex cone constructions
48 //! Geom_ConicalSurface which provides additional
49 //! functions for constructing cones and works, in particular,
50 //! with the parametric equations of cones gp_Ax3
51 class gp_Cone 
52 {
53 public:
54
55   DEFINE_STANDARD_ALLOC
56
57   //! Creates an indefinite Cone.
58   gp_Cone()
59   : radius (RealLast()),
60     semiAngle (M_PI * 0.25)
61   {}
62
63   //! Creates an infinite conical surface. theA3 locates the cone
64   //! in the space and defines the reference plane of the surface.
65   //! Ang is the conical surface semi-angle. Its absolute value is in range
66   //! ]0, PI/2[.
67   //! theRadius is the radius of the circle in the reference plane of
68   //! the cone.
69   //! theRaises ConstructionError
70   //! * if theRadius is lower than 0.0
71   //! * Abs(theAng) < Resolution from gp  or Abs(theAng) >= (PI/2) - Resolution.
72   gp_Cone (const gp_Ax3& theA3, const Standard_Real theAng, const Standard_Real theRadius);
73
74   //! Changes the symmetry axis of the cone.  Raises ConstructionError
75   //! the direction of theA1 is parallel to the "XDirection"
76   //! of the coordinate system of the cone.
77   void SetAxis (const gp_Ax1& theA1) { pos.SetAxis (theA1); }
78
79   //! Changes the location of the cone.
80   void SetLocation (const gp_Pnt& theLoc) { pos.SetLocation (theLoc); }
81
82   //! Changes the local coordinate system of the cone.
83   //! This coordinate system defines the reference plane of the cone.
84   void SetPosition (const gp_Ax3& theA3) { pos = theA3; }
85
86   //! Changes the radius of the cone in the reference plane of
87   //! the cone.
88   //! Raised if theR < 0.0
89   void SetRadius (const Standard_Real theR)
90   {
91     Standard_ConstructionError_Raise_if (theR < 0.0, "gp_Cone::SetRadius() - radius should be positive number");
92     radius = theR;
93   }
94
95   //! Changes the semi-angle of the cone.
96   //! Semi-angle can be negative. Its absolute value
97   //! Abs(theAng) is in range ]0,PI/2[.
98   //! Raises ConstructionError if Abs(theAng) < Resolution from gp or Abs(theAng) >= PI/2 - Resolution
99   void SetSemiAngle (const Standard_Real theAng);
100
101   //! Computes the cone's top. The Apex of the cone is on the
102   //! negative side of the symmetry axis of the cone.
103   gp_Pnt Apex() const
104   {
105     gp_XYZ aCoord = pos.Direction().XYZ();
106     aCoord.Multiply (-radius / Tan (semiAngle));
107     aCoord.Add (pos.Location().XYZ());
108     return gp_Pnt (aCoord);
109   }
110
111   //! Reverses the   U   parametrization of   the  cone
112   //! reversing the YAxis.
113   void UReverse() { pos.YReverse(); }
114
115   //! Reverses the   V   parametrization of   the  cone  reversing the ZAxis.
116   void VReverse()
117   {
118     pos.ZReverse();
119     semiAngle = -semiAngle;
120   }
121
122   //! Returns true if the local coordinate system of this cone is right-handed.
123   Standard_Boolean Direct() const { return pos.Direct(); }
124
125   //! returns the symmetry axis of the cone.
126   const gp_Ax1& Axis() const { return pos.Axis(); }
127
128   //! Computes the coefficients of the implicit equation of the quadric
129   //! in the absolute cartesian coordinates system :
130   //! theA1.X**2 + theA2.Y**2 + theA3.Z**2 + 2.(theB1.X.Y + theB2.X.Z + theB3.Y.Z) +
131   //! 2.(theC1.X + theC2.Y + theC3.Z) + theD = 0.0
132   Standard_EXPORT void Coefficients (Standard_Real& theA1, Standard_Real& theA2, Standard_Real& theA3,
133                                      Standard_Real& theB1, Standard_Real& theB2, Standard_Real& theB3,
134                                      Standard_Real& theC1, Standard_Real& theC2, Standard_Real& theC3, Standard_Real& theD) const;
135
136   //! returns the "Location" point of the cone.
137   const gp_Pnt& Location() const { return pos.Location(); }
138
139   //! Returns the local coordinates system of the cone.
140   const gp_Ax3& Position() const { return pos; }
141
142   //! Returns the radius of the cone in the reference plane.
143   Standard_Real RefRadius() const { return radius; }
144
145   //! Returns the half-angle at the apex of this cone.
146   //! Attention! Semi-angle can be negative.
147   Standard_Real SemiAngle() const { return semiAngle; }
148
149   //! Returns the XAxis of the reference plane.
150   gp_Ax1 XAxis() const  { return gp_Ax1 (pos.Location(), pos.XDirection()); }
151
152   //! Returns the YAxis of the reference plane.
153   gp_Ax1 YAxis() const  { return gp_Ax1 (pos.Location(), pos.YDirection()); }
154
155   Standard_EXPORT void Mirror (const gp_Pnt& theP);
156
157   //! Performs the symmetrical transformation of a cone
158   //! with respect to the point theP which is the center of the
159   //! symmetry.
160   Standard_NODISCARD Standard_EXPORT gp_Cone Mirrored (const gp_Pnt& theP) const;
161
162   Standard_EXPORT void Mirror (const gp_Ax1& theA1);
163
164   //! Performs the symmetrical transformation of a cone with
165   //! respect to an axis placement which is the axis of the
166   //! symmetry.
167   Standard_NODISCARD Standard_EXPORT gp_Cone Mirrored (const gp_Ax1& theA1) const;
168
169   Standard_EXPORT void Mirror (const gp_Ax2& theA2);
170
171   //! Performs the symmetrical transformation of a cone with respect
172   //! to a plane. The axis placement theA2 locates the plane of the
173   //! of the symmetry : (Location, XDirection, YDirection).
174   Standard_NODISCARD Standard_EXPORT gp_Cone Mirrored (const gp_Ax2& theA2) const;
175
176   void Rotate (const gp_Ax1& theA1, const Standard_Real theAng)  { pos.Rotate (theA1, theAng); }
177
178   //! Rotates a cone. theA1 is the axis of the rotation.
179   //! Ang is the angular value of the rotation in radians.
180   Standard_NODISCARD gp_Cone Rotated (const gp_Ax1& theA1, const Standard_Real theAng) const
181   {
182     gp_Cone aCone = *this;
183     aCone.pos.Rotate (theA1, theAng);
184     return aCone;
185   }
186
187   void Scale (const gp_Pnt& theP, const Standard_Real theS);
188
189   //! Scales a cone. theS is the scaling value.
190   //! The absolute value of theS is used to scale the cone
191   Standard_NODISCARD gp_Cone Scaled (const gp_Pnt& theP, const Standard_Real theS) const;
192
193   void Transform (const gp_Trsf& theT);
194
195   //! Transforms a cone with the transformation theT from class Trsf.
196   Standard_NODISCARD gp_Cone Transformed (const gp_Trsf& theT) const;
197
198   void Translate (const gp_Vec& theV) { pos.Translate (theV); }
199
200   //! Translates a cone in the direction of the vector theV.
201   //! The magnitude of the translation is the vector's magnitude.
202   Standard_NODISCARD gp_Cone Translated (const gp_Vec& theV) const
203   {
204     gp_Cone aCone = *this;
205     aCone.pos.Translate (theV);
206     return aCone;
207   }
208
209   void Translate (const gp_Pnt& theP1, const gp_Pnt& theP2)  { pos.Translate (theP1, theP2); }
210
211   //! Translates a cone from the point P1 to the point P2.
212   Standard_NODISCARD gp_Cone Translated (const gp_Pnt& theP1, const gp_Pnt& theP2) const
213   {
214     gp_Cone aCone = *this;
215     aCone.pos.Translate (theP1, theP2);
216     return aCone;
217   }
218
219 private:
220
221   gp_Ax3 pos;
222   Standard_Real radius;
223   Standard_Real semiAngle;
224
225 };
226
227 // =======================================================================
228 // function : gp_Cone
229 // purpose  :
230 // =======================================================================
231 inline gp_Cone::gp_Cone (const gp_Ax3& theA3,
232                          const Standard_Real theAng,
233                          const Standard_Real theRadius)
234 : pos (theA3),
235   radius (theRadius),
236   semiAngle (theAng)
237 {
238   Standard_Real aVal = theAng;
239   if (aVal < 0)
240   {
241     aVal = -aVal;
242   }
243   Standard_ConstructionError_Raise_if (theRadius < 0. || aVal <= gp::Resolution() || M_PI * 0.5 - aVal <= gp::Resolution(),
244                                        "gp_Cone() - invalid construction parameters");
245 }
246
247 // =======================================================================
248 // function : SetSemiAngle
249 // purpose  :
250 // =======================================================================
251 inline void gp_Cone::SetSemiAngle (const Standard_Real theAng)
252 {
253   Standard_Real aVal = theAng;
254   if (aVal < 0)
255   {
256     aVal = -aVal;
257   }
258   Standard_ConstructionError_Raise_if (aVal <= gp::Resolution() || M_PI * 0.5 - aVal <= gp::Resolution(),
259                                        "gp_Cone::SetSemiAngle() - invalid angle range");
260   semiAngle = theAng;
261 }
262
263 // =======================================================================
264 // function : Scale
265 // purpose  :
266 // =======================================================================
267 inline void gp_Cone::Scale (const gp_Pnt& theP,
268                             const Standard_Real theS)
269 {
270   pos.Scale (theP, theS);
271   radius *= theS;
272   if (radius < 0)
273   {
274     radius = -radius;
275   }
276 }
277
278 // =======================================================================
279 // function : Scaled
280 // purpose  :
281 // =======================================================================
282 inline gp_Cone gp_Cone::Scaled (const gp_Pnt& theP,
283                                 const Standard_Real theS) const
284 {
285   gp_Cone aC = *this;
286   aC.pos.Scale (theP, theS);
287   aC.radius *= theS;
288   if (aC.radius < 0)
289   {
290     aC.radius = -aC.radius;
291   }
292   return aC;
293 }
294
295 // =======================================================================
296 // function : Transform
297 // purpose  :
298 // =======================================================================
299 inline void gp_Cone::Transform (const gp_Trsf& theT)
300 {
301   pos.Transform (theT);
302   radius *= theT.ScaleFactor();
303   if (radius < 0)
304   {
305     radius = -radius;
306   }
307 }
308
309 // =======================================================================
310 // function : Transformed
311 // purpose  :
312 // =======================================================================
313 inline gp_Cone gp_Cone::Transformed (const gp_Trsf& theT) const
314 {
315   gp_Cone aC = *this;
316   aC.pos.Transform (theT);
317   aC.radius *= theT.ScaleFactor();
318   if (aC.radius < 0)
319   {
320     aC.radius = -aC.radius;
321   }
322   return aC;
323 }
324
325 #endif // _gp_Cone_HeaderFile