0032137: Coding Rules - merge redundant .lxx files into header files within Package gp
[occt.git] / src / gp / gp.hxx
1 // Created on: 1993-04-13
2 // Created by: JCV
3 // Copyright (c) 1993-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 _gp_HeaderFile
18 #define _gp_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23 #include <Standard_Real.hxx>
24
25 class gp_Pnt;
26 class gp_Dir;
27 class gp_Ax1;
28 class gp_Ax2;
29 class gp_Pnt2d;
30 class gp_Dir2d;
31 class gp_Ax2d;
32
33 //! The geometric processor package, called gp, provides an
34 //! implementation of entities used  :
35 //! . for algebraic calculation such as "XYZ" coordinates, "Mat"
36 //! matrix
37 //! . for basis analytic geometry such as Transformations, point,
38 //! vector, line, plane, axis placement, conics, and elementary
39 //! surfaces.
40 //! These entities are defined in 2d and 3d space.
41 //! All the classes of this package are non-persistent.
42 class gp 
43 {
44 public:
45
46   DEFINE_STANDARD_ALLOC
47
48   //! Method of package gp
49   //!
50   //! In geometric computations, defines the tolerance criterion
51   //! used to determine when two numbers can be considered equal.
52   //! Many class functions use this tolerance criterion, for
53   //! example, to avoid division by zero in geometric
54   //! computations. In the documentation, tolerance criterion is
55   //! always referred to as gp::Resolution().
56   static Standard_Real Resolution() { return RealSmall(); }
57
58   //! Identifies a Cartesian point with coordinates X = Y = Z = 0.0.0
59   Standard_EXPORT static const gp_Pnt& Origin();
60
61   //! Returns a unit vector with the combination (1,0,0)
62   Standard_EXPORT static const gp_Dir& DX();
63
64   //! Returns a unit vector with the combination (0,1,0)
65   Standard_EXPORT static const gp_Dir& DY();
66
67   //! Returns a unit vector with the combination (0,0,1)
68   Standard_EXPORT static const gp_Dir& DZ();
69
70   //! Identifies an axis where its origin is Origin
71   //! and its unit vector coordinates  X = 1.0,  Y = Z = 0.0
72   Standard_EXPORT static const gp_Ax1& OX();
73
74   //! Identifies an axis where its origin is Origin
75   //! and its unit vector coordinates Y = 1.0,  X = Z = 0.0
76   Standard_EXPORT static const gp_Ax1& OY();
77
78   //! Identifies an axis where its origin is Origin
79   //! and its unit vector coordinates Z = 1.0,  Y = X = 0.0
80   Standard_EXPORT static const gp_Ax1& OZ();
81
82   //! Identifies a coordinate system where its origin is Origin,
83   //! and its "main Direction" and "X Direction" coordinates
84   //! Z = 1.0, X = Y =0.0 and X direction coordinates X = 1.0, Y = Z = 0.0
85   Standard_EXPORT static const gp_Ax2& XOY();
86
87   //! Identifies a coordinate system where its origin is Origin,
88   //! and its "main Direction" and "X Direction" coordinates
89   //! Y = 1.0, X = Z =0.0 and X direction coordinates Z = 1.0, X = Y = 0.0
90   Standard_EXPORT static const gp_Ax2& ZOX();
91
92   //! Identifies a coordinate system where its origin is Origin,
93   //! and its "main Direction" and "X Direction" coordinates
94   //! X = 1.0, Z = Y =0.0 and X direction coordinates Y = 1.0, X = Z = 0.0
95   //! In 2D space
96   Standard_EXPORT static const gp_Ax2& YOZ();
97
98   //! Identifies a Cartesian point with coordinates X = Y = 0.0
99   Standard_EXPORT static const gp_Pnt2d& Origin2d();
100
101   //! Returns a unit vector with the combinations (1,0)
102   Standard_EXPORT static const gp_Dir2d& DX2d();
103
104   //! Returns a unit vector with the combinations (0,1)
105   Standard_EXPORT static const gp_Dir2d& DY2d();
106
107   //! Identifies an axis where its origin is Origin2d
108   //! and its unit vector coordinates are: X = 1.0,  Y = 0.0
109   Standard_EXPORT static const gp_Ax2d& OX2d();
110
111   //! Identifies an axis where its origin is Origin2d
112   //! and its unit vector coordinates are Y = 1.0,  X = 0.0
113   Standard_EXPORT static const gp_Ax2d& OY2d();
114
115 };
116
117 #endif // _gp_HeaderFile