0028838: Configuration - undefine macros coming from X11 headers in place of collision
[occt.git] / src / CSLib / CSLib.hxx
1 // Created on: 1991-09-09
2 // Created by: Michel Chauvat
3 // Copyright (c) 1991-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _CSLib_HeaderFile
18 #define _CSLib_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 #include <CSLib_DerivativeStatus.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <CSLib_NormalStatus.hxx>
28 #include <Standard_Integer.hxx>
29 #include <TColgp_Array2OfVec.hxx>
30 class gp_Vec;
31 class gp_Dir;
32 class CSLib_Class2d;
33 class CSLib_NormalPolyDef;
34
35
36 //! This package implements functions for basis geometric
37 //! computation on curves and surfaces.
38 //! The tolerance criterions used in this package are
39 //! Resolution from package gp and RealEpsilon from class
40 //! Real of package Standard.
41 class CSLib 
42 {
43 public:
44
45   DEFINE_STANDARD_ALLOC
46
47   
48
49   //! The following functions computes the normal to a surface
50   //! inherits FunctionWithDerivative from math
51   //!
52   //! Computes the normal direction of a surface as the cross product
53   //! between D1U and D1V.
54   //! If D1U has null length or D1V has null length or D1U and D1V are
55   //! parallel the normal is undefined.
56   //! To check that D1U and D1V are colinear the sinus of the angle
57   //! between D1U and D1V is computed and compared with SinTol.
58   //! The normal is computed if theStatus == Done else the theStatus gives the
59   //! reason why the computation has failed.
60   Standard_EXPORT static void Normal (const gp_Vec& D1U, const gp_Vec& D1V, const Standard_Real SinTol, CSLib_DerivativeStatus& theStatus, gp_Dir& Normal);
61   
62
63   //! If there is a singularity on the surface  the previous method
64   //! cannot compute the local normal.
65   //! This method computes an approched normal direction of a surface.
66   //! It does a limited development and needs the second derivatives
67   //! on the surface as input data.
68   //! It computes the normal as follow :
69   //! N(u, v) = D1U ^ D1V
70   //! N(u0+du,v0+dv) = N0 + DN/du(u0,v0) * du + DN/dv(u0,v0) * dv + Eps
71   //! with Eps->0 so we can have the equivalence N ~ dN/du + dN/dv.
72   //! DNu = ||DN/du|| and DNv = ||DN/dv||
73   //!
74   //! . if DNu IsNull (DNu <= Resolution from gp) the answer Done = True
75   //! the normal direction is given by DN/dv
76   //! . if DNv IsNull (DNv <= Resolution from gp) the answer Done = True
77   //! the normal direction is given by DN/du
78   //! . if the two directions DN/du and DN/dv are parallel Done = True
79   //! the normal direction is given either by DN/du or DN/dv.
80   //! To check that the two directions are colinear the sinus of the
81   //! angle between these directions is computed and compared with
82   //! SinTol.
83   //! . if DNu/DNv or DNv/DNu is lower or equal than Real Epsilon
84   //! Done = False, the normal is undefined
85   //! . if DNu IsNull and DNv is Null Done = False, there is an
86   //! indetermination and we should do a limited developpement at
87   //! order 2 (it means that we cannot omit Eps).
88   //! . if DNu Is not Null and DNv Is not Null Done = False, there are
89   //! an infinity of normals at the considered point on the surface.
90   Standard_EXPORT static void Normal (const gp_Vec& D1U, const gp_Vec& D1V, const gp_Vec& D2U, const gp_Vec& D2V, const gp_Vec& D2UV, const Standard_Real SinTol, Standard_Boolean& Done, CSLib_NormalStatus& theStatus, gp_Dir& Normal);
91   
92
93   //! Computes the normal direction of a surface as the cross product
94   //! between D1U and D1V.
95   Standard_EXPORT static void Normal (const gp_Vec& D1U, const gp_Vec& D1V, const Standard_Real MagTol, CSLib_NormalStatus& theStatus, gp_Dir& Normal);
96   
97   //! find the first  order k0  of deriviative of NUV
98   //! where: foreach order < k0  all the derivatives of NUV  are
99   //! null all the derivatives of NUV corresponding to the order
100   //! k0 are collinear and have the same sens.
101   //! In this case, normal at U,V is unique.
102   Standard_EXPORT static void Normal (const Standard_Integer MaxOrder, const TColgp_Array2OfVec& DerNUV, const Standard_Real MagTol, const Standard_Real U, const Standard_Real V, const Standard_Real Umin, const Standard_Real Umax, const Standard_Real Vmin, const Standard_Real Vmax, CSLib_NormalStatus& theStatus, gp_Dir& Normal, Standard_Integer& OrderU, Standard_Integer& OrderV);
103   
104   //! -- Computes the derivative  of order Nu in the --
105   //! direction U and Nv in the direction V of the not --
106   //! normalized  normal vector at  the point  P(U,V) The
107   //! array DerSurf contain the derivative (i,j) of the surface
108   //! for i=0,Nu+1 ; j=0,Nv+1
109   Standard_EXPORT static gp_Vec DNNUV (const Standard_Integer Nu, const Standard_Integer Nv, const TColgp_Array2OfVec& DerSurf);
110   
111   //! Computes the derivatives of order Nu in the direction Nu
112   //! and Nv in the direction Nv of the not normalized vector
113   //! N(u,v) = dS1/du * dS2/dv (cases where we use an osculating surface)
114   //! DerSurf1 are the derivatives of S1
115   Standard_EXPORT static gp_Vec DNNUV (const Standard_Integer Nu, const Standard_Integer Nv, const TColgp_Array2OfVec& DerSurf1, const TColgp_Array2OfVec& DerSurf2);
116   
117   //! -- Computes the derivative  of order Nu in the --
118   //! direction   U and  Nv in the  direction  V  of the
119   //! normalized normal vector  at the point P(U,V) array
120   //! DerNUV contain the  derivative  (i+Iduref,j+Idvref)
121   //! of D1U ^ D1V for i=0,Nu  ; j=0,Nv Iduref and Idvref
122   //! correspond to a derivative  of D1U ^ D1V  which can
123   //! be used to compute the normalized normal vector.
124   //! In the regular cases , Iduref=Idvref=0.
125   Standard_EXPORT static gp_Vec DNNormal (const Standard_Integer Nu, const Standard_Integer Nv, const TColgp_Array2OfVec& DerNUV, const Standard_Integer Iduref = 0, const Standard_Integer Idvref = 0);
126
127
128
129
130 protected:
131
132
133
134
135
136 private:
137
138
139
140
141 friend class CSLib_Class2d;
142 friend class CSLib_NormalPolyDef;
143
144 };
145
146
147
148
149
150
151
152 #endif // _CSLib_HeaderFile