0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IGESDimen / IGESDimen_AngularDimension.hxx
1 // Created on: 1993-01-13
2 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
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 _IGESDimen_AngularDimension_HeaderFile
18 #define _IGESDimen_AngularDimension_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <gp_XY.hxx>
24 #include <Standard_Real.hxx>
25 #include <IGESData_IGESEntity.hxx>
26 #include <Standard_Boolean.hxx>
27 class IGESDimen_GeneralNote;
28 class IGESDimen_WitnessLine;
29 class IGESDimen_LeaderArrow;
30 class gp_XY;
31 class gp_Pnt2d;
32
33
34 class IGESDimen_AngularDimension;
35 DEFINE_STANDARD_HANDLE(IGESDimen_AngularDimension, IGESData_IGESEntity)
36
37 //! defines AngularDimension, Type <202> Form <0>
38 //! in package IGESDimen
39 //! Used to dimension angles
40 class IGESDimen_AngularDimension : public IGESData_IGESEntity
41 {
42
43 public:
44
45   
46   Standard_EXPORT IGESDimen_AngularDimension();
47   
48   //! This method is used to set the fields of the class
49   //! AngularDimension
50   //! - aNote         : General Note Entity
51   //! - aLine         : First Witness Line Entity or Null
52   //! Handle
53   //! - anotherLine   : Second Witness Line Entity or Null
54   //! Handle
55   //! - aVertex       : Coordinates of vertex point
56   //! - aRadius       : Radius of leader arcs
57   //! - aLeader       : First Leader Entity
58   //! - anotherLeader : Second Leader Entity
59   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Handle(IGESDimen_WitnessLine)& aLine, const Handle(IGESDimen_WitnessLine)& anotherLine, const gp_XY& aVertex, const Standard_Real aRadius, const Handle(IGESDimen_LeaderArrow)& aLeader, const Handle(IGESDimen_LeaderArrow)& anotherLeader);
60   
61   //! returns the General Note Entity of the Dimension.
62   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
63   
64   //! returns False if theFirstWitnessLine is Null Handle.
65   Standard_EXPORT Standard_Boolean HasFirstWitnessLine() const;
66   
67   //! returns the First Witness Line Entity or Null Handle.
68   Standard_EXPORT Handle(IGESDimen_WitnessLine) FirstWitnessLine() const;
69   
70   //! returns False if theSecondWitnessLine is Null Handle.
71   Standard_EXPORT Standard_Boolean HasSecondWitnessLine() const;
72   
73   //! returns the Second Witness Line Entity or Null Handle.
74   Standard_EXPORT Handle(IGESDimen_WitnessLine) SecondWitnessLine() const;
75   
76   //! returns the coordinates of the Vertex point as Pnt2d from gp.
77   Standard_EXPORT gp_Pnt2d Vertex() const;
78   
79   //! returns the coordinates of the Vertex point as Pnt2d from gp
80   //! after Transformation. (Z = 0.0 for Transformation)
81   Standard_EXPORT gp_Pnt2d TransformedVertex() const;
82   
83   //! returns the Radius of the Leader arcs.
84   Standard_EXPORT Standard_Real Radius() const;
85   
86   //! returns the First Leader Entity.
87   Standard_EXPORT Handle(IGESDimen_LeaderArrow) FirstLeader() const;
88   
89   //! returns the Second Leader Entity.
90   Standard_EXPORT Handle(IGESDimen_LeaderArrow) SecondLeader() const;
91
92
93
94
95   DEFINE_STANDARD_RTTIEXT(IGESDimen_AngularDimension,IGESData_IGESEntity)
96
97 protected:
98
99
100
101
102 private:
103
104
105   Handle(IGESDimen_GeneralNote) theNote;
106   Handle(IGESDimen_WitnessLine) theFirstWitnessLine;
107   Handle(IGESDimen_WitnessLine) theSecondWitnessLine;
108   gp_XY theVertex;
109   Standard_Real theRadius;
110   Handle(IGESDimen_LeaderArrow) theFirstLeader;
111   Handle(IGESDimen_LeaderArrow) theSecondLeader;
112
113
114 };
115
116
117
118
119
120
121
122 #endif // _IGESDimen_AngularDimension_HeaderFile