0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / DsgPrs / DsgPrs_RadiusPresentation.hxx
1 // Created on: 1995-03-01
2 // Created by: Arnaud BOUZY
3 // Copyright (c) 1995-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 _DsgPrs_RadiusPresentation_HeaderFile
18 #define _DsgPrs_RadiusPresentation_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Prs3d_Drawer.hxx>
25 #include <DsgPrs_ArrowSide.hxx>
26 #include <Prs3d_Presentation.hxx>
27
28 class TCollection_ExtendedString;
29 class gp_Pnt;
30 class gp_Circ;
31
32
33 //! A framework to define display of radii.
34 class DsgPrs_RadiusPresentation 
35 {
36 public:
37
38   DEFINE_STANDARD_ALLOC
39
40   
41   //! Adds the point AttachmentPoint, the circle aCircle,
42   //! the text aText, and the parameters firstparam and
43   //! lastparam to the presentation object aPresentation.
44   //! The display attributes of these elements is defined by
45   //! the attribute manager aDrawer.
46   //! If the Boolean drawFromCenter is false, the
47   //! arrowhead will point towards the center of aCircle.
48   //! If the Boolean reverseArrow is true, the arrowhead
49   //! will point away from the attachment point.
50   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint, const gp_Circ& aCircle, const Standard_Real firstparam, const Standard_Real lastparam, const Standard_Boolean drawFromCenter = Standard_True, const Standard_Boolean reverseArrow = Standard_False);
51   
52   //! Adds the point AttachmentPoint, the circle aCircle,
53   //! the text aText, and the parameters firstparam and
54   //! lastparam to the presentation object aPresentation.
55   //! The display attributes of these elements is defined by
56   //! the attribute manager aDrawer.
57   //! The value of the enumeration Arrowside determines
58   //! the type of arrow displayed: whether there will be
59   //! arrowheads at both ends or only one, for example.
60   //! If the Boolean drawFromCenter is false, the
61   //! arrowhead will point towards the center of aCircle.
62   //! If the Boolean reverseArrow is true, the arrowhead
63   //! will point away from the attachment point.
64   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint, const gp_Circ& aCircle, const Standard_Real firstparam, const Standard_Real lastparam, const DsgPrs_ArrowSide ArrowSide, const Standard_Boolean drawFromCenter = Standard_True, const Standard_Boolean reverseArrow = Standard_False);
65   
66   //! Adds the circle aCircle, the text aText, the points
67   //! AttachmentPoint, Center and EndOfArrow to the
68   //! presentation object aPresentation.
69   //! The display attributes of these elements is defined by
70   //! the attribute manager aDrawer.
71   //! The value of the enumeration Arrowside determines
72   //! the type of arrow displayed: whether there will be
73   //! arrowheads at both ends or only one, for example.
74   //! If the Boolean drawFromCenter is false, the
75   //! arrowhead will point towards the center of aCircle.
76   //! If the Boolean reverseArrow is true, the arrowhead
77   //! will point away from the attachment point.
78   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint, const gp_Pnt& Center, const gp_Pnt& EndOfArrow, const DsgPrs_ArrowSide ArrowSide, const Standard_Boolean drawFromCenter = Standard_True, const Standard_Boolean reverseArrow = Standard_False);
79
80
81
82
83 protected:
84
85
86
87
88
89 private:
90
91
92
93
94
95 };
96
97
98
99
100
101
102
103 #endif // _DsgPrs_RadiusPresentation_HeaderFile