0031035: Coding - uninitialized class fields reported by Visual Studio Code Analysis
[occt.git] / src / DrawDim / DrawDim.hxx
1 // Created on: 1996-01-09
2 // Created by: Denis PASCAL
3 // Copyright (c) 1996-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 _DrawDim_HeaderFile
18 #define _DrawDim_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_CString.hxx>
25 #include <Draw_Interpretor.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <Standard_Real.hxx>
28 class TopoDS_Shape;
29 class gp_Pnt;
30 class TopoDS_Edge;
31 class gp_Lin;
32 class gp_Circ;
33 class TopoDS_Face;
34 class gp_Pln;
35 class DrawDim_Dimension;
36 class DrawDim_Angle;
37 class DrawDim_Distance;
38 class DrawDim_Radius;
39 class DrawDim_PlanarDimension;
40 class DrawDim_PlanarAngle;
41 class DrawDim_PlanarDistance;
42 class DrawDim_PlanarRadius;
43 class DrawDim_PlanarDiameter;
44
45
46 //! This package provides Drawable Dimensions.
47 //!
48 //! The classes PlanarDimension and subclasses provide
49 //! services  to  build  drawable dimensions between
50 //! point line and circle in a given 3d plane.
51 //!
52 //! The   classes  Dimension and   subclasses provide
53 //! services  to build  drawable  dimensions between
54 //! plane and cylindrical surfaces.
55 class DrawDim 
56 {
57 public:
58
59   DEFINE_STANDARD_ALLOC
60
61   
62   //! Commands
63   //! ========
64   Standard_EXPORT static void DrawShapeName (const TopoDS_Shape& ashape, const Standard_CString aname);
65   
66   Standard_EXPORT static void AllCommands (Draw_Interpretor& I);
67   
68   //! tools
69   //! =====
70   Standard_EXPORT static void PlanarDimensionCommands (Draw_Interpretor& I);
71   
72   Standard_EXPORT static gp_Pnt Nearest (const TopoDS_Shape& aShape, const gp_Pnt& apoint);
73   
74   //! false if <e> is not a linear edge
75   Standard_EXPORT static Standard_Boolean Lin (const TopoDS_Edge& e, gp_Lin& l, Standard_Boolean& infinite, Standard_Real& first, Standard_Real& last);
76   
77   //! false if <e> is not a circular edge
78   Standard_EXPORT static Standard_Boolean Circ (const TopoDS_Edge& e, gp_Circ& l, Standard_Real& first, Standard_Real& last);
79   
80   //! false if <f> is not a planar face
81   Standard_EXPORT static Standard_Boolean Pln (const TopoDS_Face& f, gp_Pln& p);
82
83
84
85
86 protected:
87
88
89
90
91
92 private:
93
94
95
96
97 friend class DrawDim_Dimension;
98 friend class DrawDim_Angle;
99 friend class DrawDim_Distance;
100 friend class DrawDim_Radius;
101 friend class DrawDim_PlanarDimension;
102 friend class DrawDim_PlanarAngle;
103 friend class DrawDim_PlanarDistance;
104 friend class DrawDim_PlanarRadius;
105 friend class DrawDim_PlanarDiameter;
106
107 };
108
109
110
111
112
113
114
115 #endif // _DrawDim_HeaderFile